CorrectionFile Class

Allows creating and accessing correction files.

Inheritance Hierarchy

SystemObject
RAYLASE.SPICE3CorrectionFile

Namespace: RAYLASE.SPICE3
Assembly: RAYLASE.SPICE3 (in RAYLASE.SPICE3.dll) Version: 3.6.0

Syntax

public class CorrectionFile : IDisposable

The CorrectionFile type exposes the following members.

Properties

	Name	Description
	HasExtraInfo	Indicates if the underlying correction file contains additional information.
	HasMetadata	Indicates if the underlying correction file contains additional information.
	HasScannerInfo	Indicates if the underlying correction file contains additional scanner information.
	Header	Header of the correction file
	SupportsMultipleTables	Whether the payload has the extended format that allows to store more than one table
	TableCount	How many tables are stored in this file.

Methods

	Name	Description
	AppendExtraInfo	Appends additional information to the underlying correction file.
	Close	Close the open streams
	CorrectionTable	Get a BinaryReader for the raw correction table
	Create(String, OpticalParameters, ListStream, Boolean, String, ScannerInfo, DictionaryString, String)	Creates a new correction file and adds several tables.
	Create(String, OpticalParameters, Stream, Boolean, String, ScannerInfo, DictionaryString, String)	Creates a new correction file.
	GetExtraInfo	Read additional information that are stored inside the underlying correction file.
	GetInverse	Calculates the inverse of this correction file. This can be useful to calculate scanner coordinates (in bits) back to user coordinates (in µm).
	GetMetadata	Read metadata that is stored inside the underlying correction file.
	GetScannerInfo	Read the additional ScannerInfo that can be stored inside the underlying correction file.
	OpenRead	Opens an existing correction file in read-only mode.
	OpenWrite	Opens an existing correction file in read-write mode.
	PayloadToStream	Copies the raw correction payload to a stream.
	SetExtraInfo	Write additional information to the underlying correction file.
	ToScanner(Point3D)	Converts the user coordinates in µm to scanner coordinates in bit.
	ToScanner(Point4D)	Converts the user coordinates in µm to scanner coordinates in bit.

Fields

	Name	Description
	FileExtension	The file extension of correction files.