Click or drag to resize

ContinuousSequenceRecorder Class

Class managing sequence recording of undefined size.
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 class ContinuousSequenceRecorder : LiveAcquirer

The ContinuousSequenceRecorder type exposes the following members.

Constructors
  NameDescription
Public methodContinuousSequenceRecorder(ICameraController, IConfigManager, UInt32)
Initializes a new instance of the ContinuousSequenceRecorder class
Public methodContinuousSequenceRecorder(ICameraItem, IConfigManager, UInt32)
Initializes a new instance of the ContinuousSequenceRecorder class
Top
Properties
  NameDescription
Public propertyAcquisitionFps
Gets or sets the acquisition frame rate.
(Inherited from LiveAcquirer.)
Public propertyConfigManager
Gets the current ConfigManager in use.
(Inherited from BaseSequenceManager.)
Public propertyConfiguration
Gets the current configuration used for hologram reconstruction.
(Inherited from BaseSequenceManager.)
Public propertyCurrentState
Gets the current state of the sequence manager.
(Inherited from BaseSequenceManager.)
Public propertyEffectiveAcquisitionFps
Gets the effective acquisition frame rate.
(Inherited from LiveAcquirer.)
Public propertyEffectiveReconstructionFps
Gets the effective reconstruction frame rate.
(Inherited from LiveAcquirer.)
Public propertyNumberOfRecords
Gets the current total number of records.
(Inherited from BaseSequenceManager.)
Public propertyReconstructionFps
Gets or sets the reconstruction frame rate.
(Inherited from LiveAcquirer.)
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.
(Inherited from BaseSequenceManager.)
Public propertyTemporalAveragingFramesNumber
Gets or sets the number of frames to average during reconstruction process.
(Inherited from BaseSequenceManager.)
Public propertyUseReconstruction
Gets or sets a value indicating whether the reconstruction is enabled.
(Inherited from LiveAcquirer.)
Public propertyUseReferenceHologramSaving
Gets or sets the option saving the reference hologram(s) in the first hologram metadata of the acquired sequence.
(Inherited from BaseSequenceManager.)
Top
Methods
  NameDescription
Public methodAccessHologram
Accesses the hologram object directly in the current buffer.
(Inherited from BaseSequenceManager.)
Public methodCancelSaving
Cancels the saving of a sequence.
(Inherited from BaseSequenceManager.)
Public methodCastSequence
Casts an existing sequence into the current buffer.
(Inherited from BaseSequenceManager.)
Public methodComputeAndApplyFittingToConfiguration
Compute fitting on the phase result of the next acquisition using configuration parameters.
(Inherited from LiveAcquirer.)
Public methodComputeAndApplyFittingToConfiguration(Int32, Boolean)
Compute fitting on specified phase result using configuration parameters.
(Inherited from BaseSequenceManager.)
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.
(Inherited from BaseSequenceManager.)
Public methodGetHologramCopy
Gets a copy of the defined hologram in the current buffer.
(Inherited from BaseSequenceManager.)
Public methodGetNextAcquisition
Get the last acquisition.
(Inherited from LiveAcquirer.)
Public methodGetNextReconstruction
Get the reconstruction results of the next acquired data.
(Inherited from LiveAcquirer.)
Public methodGetReconstruction
Gets the reconstruction results of a record in the current buffer.
(Inherited from BaseSequenceManager.)
Public methodIsInState
Determines if the state machine is in the supplied state.
(Inherited from BaseSequenceManager.)
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.
(Inherited from BaseSequenceManager.)
Public methodSaveBigTiffSequence
Saves the sequence into a BigTiff (.btf) format.
(Inherited from BaseSequenceManager.)
Public methodSaveKoalaSequence
Saves the sequence in a Koala compatible format.
(Inherited from BaseSequenceManager.)
Public methodStartAcquiring
Starts the live acquisition.
(Inherited from LiveAcquirer.)
Public methodStartRecording
Starts recording the continuous acquisition.
Public methodStopAcquiring
Stops the live acquisition.
(Inherited from LiveAcquirer.)
Public methodStopRecording
Stops recording the acquisition.
Top
Events
  NameDescription
Public eventLastReconstructionComputed
Sends results for each new reconstruction. If UseReconstruction is disabled, the hologram only is send at acquisition frame rate.
(Inherited from LiveAcquirer.)
Public eventStateMachineStateChanged
Occurs when the state machine state changes
(Inherited from BaseSequenceManager.)
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