Click or drag to resize

BaseSequenceManagerSaveBigTiffSequence Method

Saves the sequence into a BigTiff (.btf) format.

Namespace: LynceeTec.API.Sequence
Assembly: LynceeTec.API.Sequence (in LynceeTec.API.Sequence.dll) Version: 10.2.3317.0 , built 2025-03-17 14:55:36 UTC
Syntax
Copy
public Task SaveBigTiffSequence(
	Dictionary<SavingType, string> filesPaths,
	bool saveValidOnly = false,
	IProgress<float> progress = null,
	int startIndex = 0,
	int endIndex = 2147483647
)

Parameters

filesPaths  DictionarySavingType, String
Structure defining which images are exported and their corresonding file path.
saveValidOnly  Boolean  (Optional)
true if only valid holograms are saved; otherwise, false.
progress  IProgressSingle  (Optional)
IProgress object used to track the saving process. [0 - 100%]
startIndex  Int32  (Optional)
The starting hologram index between 0 and NumberOfRecords excluded.
endIndex  Int32  (Optional)
The ending index between 0 and NumberOfRecords excluded.

Return Value

Task
The task saving the sequence.
Exceptions
ExceptionCondition
InvalidOperationExceptionThe current state does not allow the method to be called.
FileLoadExceptionReference hologram could not be loaded.
EmptySequenceExceptionThe current sequence is empty, or contains only invalid holograms.
Remarks

Sets CurrentState value first to Saving, then to Saved or previous state if an error occurs.

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

See Also