Click or drag to resize

SequenceLoaderLoadSequence Method

Loads an existing sequence.

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 Task LoadSequence(
	string path,
	IProgress<float> progress = null,
	int startIndex = 0,
	int endIndex = 2147483647
)

Parameters

path
Type: SystemString
The path with .btf extension
progress (Optional)
Type: SystemIProgressSingle
IProgress object used to track the loading process. [0 - 100%]
startIndex (Optional)
Type: SystemInt32
The index of the first hologram to be loaded.
endIndex (Optional)
Type: SystemInt32
The index of the last hologram to be loaded.

Return Value

Type: Task
The task loading the sequence.
Exceptions
ExceptionCondition
InvalidOperationExceptionThe current state does not allow the method to be called.
Remarks

If the path points to a directory, tries to load sequence in the Koala format; else tries to load a BigTiff (.btf) sequence.

Sets CurrentState value first to Loading, then to Loaded or NoHologram if an error occurs.

Can only be called when CurrentState is Created, NoHologram, Loaded or Saved.

See Also