SequenceLoader Class

Class managing sequences loading from disk.

Inheritance Hierarchy

SystemObject
  LynceeTec.API.SequenceConfigurationEventsManager
    LynceeTec.API.SequenceBaseSequenceManager
      LynceeTec.API.SequenceSequenceLoader

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

C++

Copy

public class SequenceLoader : BaseSequenceManager

public ref class SequenceLoader : public BaseSequenceManager

The SequenceLoader type exposes the following members.

Constructors

	Name	Description
	SequenceLoader(UInt32)	Initializes a new instance of the SequenceLoader class
	SequenceLoader(IConfigManager, UInt32)	Initializes a new instance of the SequenceLoader class

Top

Properties

	Name	Description
	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.)
	IsDatabaseConfigurationInitialized	Gets a value indicating whether the database configuration is initialized.
	IsMetadataConfigurationInitialized	Gets a value indicating whether the metadata configuration is initialized.
	NumberOfRecords	Gets the current total number of records. (Inherited from BaseSequenceManager.)
	ReconstructionWindowHalfSize	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.)
	TemporalAveragingFramesNumber	(Overrides BaseSequenceManagerTemporalAveragingFramesNumber.)
	UseMetadataConfiguration	Gets or sets a value indicating whether to use the configuration created from the metadata or the database.
	UseReconstruction	Gets or sets a value indicating whether the reconstruction is enabled. (Inherited from BaseSequenceManager.)
	UseReferenceHologramSaving	Gets or sets the option saving the reference hologram(s) in the first hologram metadata of the acquired sequence. (Inherited from BaseSequenceManager.)

Top

Methods

	Name	Description
	AccessHologram	Accesses the hologram object directly in the current buffer. (Inherited from BaseSequenceManager.)
	CancelLoading	Cancels the loading of a sequence from a file.
	CancelSaving	Cancels the saving of a sequence. (Inherited from BaseSequenceManager.)
	CastSequence	Casts an existing sequence into the current buffer. (Overrides BaseSequenceManagerCastSequence(BaseSequenceManagerHologramGroupBuffer).)
	ComputeAndApplyFittingToConfiguration	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 ConfigurationEventsManager.)
	ExtractSequence	Extract the current sequence buffer and resets the data. (Inherited from BaseSequenceManager.)
	GetHologramCopy	Gets a copy of the defined hologram in the current buffer. (Inherited from BaseSequenceManager.)
	GetReconstruction	Gets the reconstruction results of a record in the current buffer. (Inherited from BaseSequenceManager.)
	IsInState	Determines if the state machine is in the supplied state. (Inherited from BaseSequenceManager.)
	LoadSequence	Loads an existing sequence.
	RegisterConfigurationMemberModification	Register a function that will be executed when the specified member is modified. (Inherited from ConfigurationEventsManager.)
	RegisterConfigurationModification	Register a function that will be executed when any configuration member is modified. (Inherited from ConfigurationEventsManager.)
	Reset	Resets recorded buffer. (Inherited from BaseSequenceManager.)
	SaveBigTiffSequence	Saves the sequence into a BigTiff (.btf) format. (Inherited from BaseSequenceManager.)
	SaveKoalaSequence	Saves the sequence in a Koala compatible format. (Inherited from BaseSequenceManager.)

Top

Events

	Name	Description
	StateMachineStateChanged	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.

Reference

LynceeTec.API.Sequence Namespace