CalibrationParameters Class Reference

Public Member Functions
	CalibrationParameters (string filePath)
	Constructs a CalibrationParameters instance by loading data from a JSON file.
	CalibrationParameters (IntrinsicParameters intrinsicParameters, ExtrinsicParameters extrinsicParameters)
	Constructs a CalibrationParameters instance from the provided intrinsic and extrinsic parameters.
	CalibrationParameters (byte[] data)
	Constructs a CalibrationParameters instance from binary data that have been read from the camera memory.
byte[]	ToBinary ()
	Converts CalibrationParameters to binary data that can be written to the camera memory.
override string	ToString ()
	Returns a string representation of the calibration parameters.
override int	GetHashCode ()
	Returns a hash code for the calibration parameters.

Properties
IntrinsicParameters	IntrinsicParameters [get]
	Gets the intrinsic camera parameters.
ExtrinsicParameters	ExtrinsicParameters [get, set]
	Gets or sets the extrinsic camera parameters.
static IEqualityComparer< CalibrationParameters >	Comparer [get]
	Gets a default equality comparer for comparing CalibrationParameters data values.

Detailed Description

Holds a complete set of camera calibration parameters, including both intrinsic and extrinsic data.

The CalibrationParameters class represents a minimal dataset derived from a full CalibrationResult. It includes only the essential information required to apply the intrinsic and extrinsic calibration to images or depth maps.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 18 of file CalibrationParameters.cs.

Constructor & Destructor Documentation

CalibrationParameters() [1/3]

CalibrationParameters ( string filePath )

inline

Constructs a CalibrationParameters instance by loading data from a JSON file.

Allows calibration parameters to be loaded from a file, avoiding the need for recalibration and enabling consistent application of intrinsic and extrinsic camera parameters across sessions.

The file may contain either a CalibrationParameters object or a full CalibrationResult. From a full CalibrationResult, only the calibration parameters are extracted as follows:

• Intrinsic parameters: Always extracted from the CalibrationResult.
• Extrinsic parameters: If the CalibrationResult contains a single calibration view, the extrinsic parameters from that view are used; if multiple calibration views are present (e.g., from a camera calibration), the extrinsic parameters are set to the identity matrix.

Parameters

filePath

Path to the JSON file containing calibration parameters.

Exceptions

IcvIOException	If the given file_path does not exist, or the permissions are not sufficient to read it.
IcvCorruptedException	If the file content is corrupted.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 58 of file CalibrationParameters.cs.

CalibrationParameters() [2/3]

CalibrationParameters ( IntrinsicParameters intrinsicParameters, ExtrinsicParameters extrinsicParameters )

inline

Constructs a CalibrationParameters instance from the provided intrinsic and extrinsic parameters.

Parameters

intrinsicParameters	The intrinsic camera parameters.
extrinsicParameters	The extrinsic camera parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 82 of file CalibrationParameters.cs.

CalibrationParameters() [3/3]

CalibrationParameters ( byte[] data )

inline

Constructs a CalibrationParameters instance from binary data that have been read from the camera memory.

Parameters

data	The binary calibration parameters.

Exceptions

IcvCorruptedException

The binary data is corrupted.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 99 of file CalibrationParameters.cs.

Member Function Documentation

GetHashCode()

override int GetHashCode ( )

inline

Returns a hash code for the calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 195 of file CalibrationParameters.cs.

ToBinary()

byte[] ToBinary ( )

inline

Converts CalibrationParameters to binary data that can be written to the camera memory.

Returns

The binary calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 162 of file CalibrationParameters.cs.

ToString()

override string ToString ( )

inline

Returns a string representation of the calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 186 of file CalibrationParameters.cs.

Property Documentation

Comparer

IEqualityComparer<CalibrationParameters> Comparer

staticget

Initial value:

=
        new CalibrationParametersEqualityComparer()

Gets a default equality comparer for comparing CalibrationParameters data values.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 152 of file CalibrationParameters.cs.

ExtrinsicParameters

ExtrinsicParameters ExtrinsicParameters

getset

Gets or sets the extrinsic camera parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 146 of file CalibrationParameters.cs.

IntrinsicParameters

IntrinsicParameters IntrinsicParameters

get

Gets the intrinsic camera parameters.

Since

IDSImaging.Peak.ICV 1.3

Definition at line 140 of file CalibrationParameters.cs.