 | TriggeredSequenceRecorder Class |
Class managing sequence recording in a buffer of fixed size via a triggered event.
Inheritance HierarchySystemObject
LynceeTec.API.SequenceConfigurationEventsManager
LynceeTec.API.SequenceBaseSequenceManager
LynceeTec.API.SequenceLiveAcquirer
LynceeTec.API.SequenceTriggeredSequenceRecorder
LynceeTec.API.SequenceConfigurationEventsManager
LynceeTec.API.SequenceBaseSequenceManager
LynceeTec.API.SequenceLiveAcquirer
LynceeTec.API.SequenceTriggeredSequenceRecorder
Namespace: LynceeTec.API.Sequence
Assembly: LynceeTec.API.Sequence (in LynceeTec.API.Sequence.dll) Version: 9.0.26418.0 , built 2021-10-22 08:54:13 UTC
SyntaxThe TriggeredSequenceRecorder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TriggeredSequenceRecorder(ICameraController, IConfigManager) | Initializes a new instance of the TriggeredSequenceRecorder class |
| TriggeredSequenceRecorder(ICameraItem, IConfigManager) | Initializes a new instance of the TriggeredSequenceRecorder class |
Properties| Name | Description | |
|---|---|---|
 | AcquisitionFps |
Gets or sets the acquisition frame rate.
(Inherited from LiveAcquirer.) |
| BufferSize |
Gets or sets the size of the acquisition buffer.
|
| ConfigManager |
Gets the current ConfigManager in use.
(Inherited from BaseSequenceManager.) |
| Configuration |
Gets the current configuration used for hologram reconstruction.
(Inherited from BaseSequenceManager.) |
| CurrentState |
Gets the current state of the sequence manager.
(Inherited from BaseSequenceManager.) |
| EffectiveAcquisitionFps |
Gets the effective acquisition frame rate.
(Inherited from LiveAcquirer.) |
| EffectiveReconstructionFps |
Gets the effective reconstruction frame rate.
(Inherited from LiveAcquirer.) |
| NumberOfHolograms |
Gets the total number of holograms currently recorded.
(Inherited from BaseSequenceManager.) |
| ReconstructionFps |
Gets or sets the reconstruction frame rate.
(Inherited from LiveAcquirer.) |
| TriggerFrameIndex |
Gets or sets the index associated to the trigger event.
|
| UseReconstruction | (Inherited from LiveAcquirer.) |
| UseReferenceHologramSaving |
Gets or sets the option saving the reference hologram(s) in the first hologram metadata of the acquired sequence.
(Inherited from BaseSequenceManager.) |
Methods| Name | Description | |
|---|---|---|
| AccessHologram |
Accesses the hologram object directly in the current buffer.
(Inherited from BaseSequenceManager.) |
| CancelRecording |
Cancels the record of a sequence.
|
| CancelSaving |
Cancels the saving of a sequence.
(Inherited from BaseSequenceManager.) |
| ComputeAndApplyFittingToConfiguration |
Compute fitting on the phase result of the next acquisition using configuration parameters.
(Inherited from LiveAcquirer.) |
| ComputeAndApplyFittingToConfiguration(Int32) |
Compute fitting on specified phase result using configuration parameters.
(Inherited from BaseSequenceManager.) |
| DeregisterConfigurationMemberModification |
Deregister a function registered to the specified member.
(Inherited from ConfigurationEventsManager.) |
| DeregisterConfigurationModification |
Deregister a registered function.
(Inherited from ConfigurationEventsManager.) |
| Dispose | (Inherited from BaseSequenceManager.) |
| GetHologramCopy |
Gets a copy of the defined hologram in the current buffer.
(Inherited from BaseSequenceManager.) |
| GetNextAcquisition |
Copies the last acquisition into an existing hologram.
(Inherited from LiveAcquirer.) |
| GetNextReconstruction |
Get the reconstruction results of the next acquired hologram.
(Inherited from LiveAcquirer.) |
| GetReconstruction |
Gets the reconstruction results of a hologram in the current buffer.
(Inherited from BaseSequenceManager.) |
| RegisterConfigurationModification(ConfigurationEventsManagerConfigurationDelegate) |
Register a function that will be executed when any configuration property is modified.
(Inherited from ConfigurationEventsManager.) |
| RegisterConfigurationModification(MemberInfo, ConfigurationEventsManagerConfigurationDelegate) |
Register a function that will be executed when the specified member is modified.
(Inherited from ConfigurationEventsManager.) |
| SaveBigTiffSequence |
Saves the sequence into a BigTiff (.btf) format.
(Inherited from BaseSequenceManager.) |
| SaveKoalaSequence |
Saves the sequence in a Koala compatible format.
(Inherited from BaseSequenceManager.) |
| SetHologramValidity |
Sets the validity state for a hologram in the current buffer.
(Inherited from BaseSequenceManager.) |
| StartAcquiring |
Starts the live acquisition.
(Overrides LiveAcquirerStartAcquiring.) |
| StartAcquiring(IProgressSingle) |
Starts the live acquisition.
|
| StopAcquiring |
Stops the live acquisition.
(Inherited from LiveAcquirer.) |
| Trigger |
Trigger the sequence recording in the configured buffer.
|
Events| Name | Description | |
|---|---|---|
 | LastReconstructionComputed |
Sends results for each new reconstruction. If UseReconstruction is disabled, the hologram only is send at acquisition frame rate.
(Inherited from LiveAcquirer.) |
| StateMachineStateChanged |
Occurs when the state machine state changes
(Inherited from BaseSequenceManager.) |
RemarksSome calls to the class elements can only be performed when CurrentState has some defined values. The following scheme describes the allowed actions.
Thread SafetyInstance members of this type are safe for multi-threaded operations.
See Also