Click or drag to resize

BaseSequenceManager Class

Base class for the sequence management.
Inheritance Hierarchy

Namespace:  LynceeTec.API.Sequence
Assembly:  LynceeTec.API.Sequence (in LynceeTec.API.Sequence.dll) Version: 9.2.6612.0 , built 2022-07-14 10:47:23 UTC
Syntax
public abstract class BaseSequenceManager : ConfigurationEventsManager

The BaseSequenceManager type exposes the following members.

Properties
  NameDescription
Public propertyConfigManager
Gets the current ConfigManager in use.
Public propertyConfiguration
Gets the current configuration used for hologram reconstruction.
Public propertyCurrentState
Gets the current state of the sequence manager.
Public propertyNumberOfRecords
Gets the current total number of records.
Public propertyReconstructionWindowHalfSize
Defines how many reconstructions must be processed around the selected index. If GetReconstruction(ReconstructionResults, Int32) is called for index i, outputs in range [i - ReconstructionWindowHalfSize, i + ReconstructionWindowHalfSize] are reconstructed to optimize the process and anticipate the call to future indices.
Public propertyTemporalAveragingFramesNumber
Gets or sets the number of frames to average during reconstruction process.
Public propertyUseReconstruction
Gets or sets a value indicating whether the reconstruction is enabled.
Public propertyUseReferenceHologramSaving
Gets or sets the option saving the reference hologram(s) in the first hologram metadata of the acquired sequence.
Top
Methods
  NameDescription
Public methodAccessHologram
Accesses the hologram object directly in the current buffer.
Public methodCancelSaving
Cancels the saving of a sequence.
Public methodCastSequence
Casts an existing sequence into the current buffer.
Public methodComputeAndApplyFittingToConfiguration
Compute fitting on specified phase result using configuration parameters.
Public methodDeregisterConfigurationMemberModification
Deregister a function registered to the specified member.
(Inherited from ConfigurationEventsManager.)
Public methodDeregisterConfigurationModification
Deregister a registered function.
(Inherited from ConfigurationEventsManager.)
Public methodDispose (Inherited from ConfigurationEventsManager.)
Public methodExtractSequence
Extract the current sequence buffer and resets the data.
Public methodGetHologramCopy
Gets a copy of the defined hologram in the current buffer.
Public methodGetReconstruction
Gets the reconstruction results of a record in the current buffer.
Public methodIsInState
Determines if the state machine is in the supplied state.
Public methodRegisterConfigurationMemberModification
Register a function that will be executed when the specified member is modified.
(Inherited from ConfigurationEventsManager.)
Public methodRegisterConfigurationModification
Register a function that will be executed when any configuration member is modified.
(Inherited from ConfigurationEventsManager.)
Public methodReset
Resets recorded buffer.
Public methodSaveBigTiffSequence
Saves the sequence into a BigTiff (.btf) format.
Public methodSaveKoalaSequence
Saves the sequence in a Koala compatible format.
Top
Events
  NameDescription
Public eventStateMachineStateChanged
Occurs when the state machine state changes
Top
Remarks

Some calls to the class elements can only be performed when CurrentState has some defined values. The following scheme describes the allowed actions.

Thread Safety
Instance members of this type are safe for multi-threaded operations.
See Also