CalibrationParameters Class Reference

Public Member Functions
None	__init__ (self, *Any args, **Any kwargs)
	In order to create CalibrationParameters, please refer to the classmethods.
CalibrationParameters	create_from_file (cls, str file_path)
	Creates an instance of CalibrationParameters from a file.
CalibrationParameters	create_from_parameters (cls, IntrinsicParameters intrinsic_parameters, ExtrinsicParameters extrinsic_parameters)
	Creates an instance of CalibrationParameters using intrinsic and extrinsic parameters.
CalibrationParameters	create_from_binary (cls, np.ndarray binary)
	Creates an instance of CalibrationParameters from binary data.
np.ndarray	to_binary (self)
	Converts the CalibrationParameters instance to a binary representation.
IntrinsicParameters	intrinsic_parameters (self)
	Retrieves the intrinsic parameters of the calibration.
ExtrinsicParameters	extrinsic_parameters (self)
	Retrieves the extrinsic parameters of the calibration.
None	save (self, str file_path)
	Saves the calibration parameters to a file.
bool	__eq__ (self, object other)
	Compares two CalibrationParameters instances for equality.

Data Fields
IntrinsicParameters	intrinsic_parameters = other.intrinsic_parameters and
ExtrinsicParameters	extrinsic_parameters = other.extrinsic_parameters)

Protected Attributes
	_intrinsic_parameters = IntrinsicParameters(_parameters=parameters.intrinsic_parameters)
	_extrinsic_parameters = ExtrinsicParameters(_parameters=parameters.extrinsic_parameters)

Detailed Description

Represents the calibration parameters, which include intrinsic and extrinsic parameters.

Since

ids_peak_icv 1.1

Definition at line 16 of file calibration_parameters.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*Any	args,
		**Any	kwargs )

In order to create CalibrationParameters, please refer to the classmethods.

Since

ids_peak_icv 1.1

Definition at line 26 of file calibration_parameters.py.

Member Function Documentation

__eq__()

bool __eq__	(		self,
		object	other )

Compares two CalibrationParameters instances for equality.

Parameters

other

Another instance to compare.

Returns

True if both instances are equal, False otherwise.

Since

ids_peak_icv 1.1

Definition at line 211 of file calibration_parameters.py.

create_from_binary()

CalibrationParameters create_from_binary	(		cls,
		np.ndarray	binary )

Creates an instance of CalibrationParameters from binary data.

Parameters

binary

A NumPy array containing the binary representation of calibration parameters.

Returns

A new instance of CalibrationParameters

Exceptions

CorruptedException

If the binary calibration parameters are corrupted.

Since

ids_peak_icv 1.1

Definition at line 95 of file calibration_parameters.py.

create_from_file()

CalibrationParameters create_from_file	(		cls,
		str	file_path )

Creates an instance of CalibrationParameters from a file.

Parameters

file_path

An existing file path to a JSON file containing the calibration parameters.

Exceptions

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

Returns

A new instance of CalibrationParameters

Since

ids_peak_icv 1.1

Definition at line 49 of file calibration_parameters.py.

create_from_parameters()

CalibrationParameters create_from_parameters	(		cls,
		IntrinsicParameters	intrinsic_parameters,
		ExtrinsicParameters	extrinsic_parameters )

Creates an instance of CalibrationParameters using intrinsic and extrinsic parameters.

Parameters

intrinsic_parameters	The intrinsic camera parameters.
extrinsic_parameters	The extrinsic camera parameters.

Returns

A new instance of CalibrationParameters

Since

ids_peak_icv 1.1

Definition at line 76 of file calibration_parameters.py.

extrinsic_parameters()

ExtrinsicParameters extrinsic_parameters

(

self

)

Retrieves the extrinsic parameters of the calibration.

Returns

The extrinsic camera parameters.

Since

ids_peak_icv 1.1

Definition at line 176 of file calibration_parameters.py.

intrinsic_parameters()

IntrinsicParameters intrinsic_parameters

(

self

)

Retrieves the intrinsic parameters of the calibration.

Returns

The intrinsic camera parameters.

Since

ids_peak_icv 1.1

Definition at line 164 of file calibration_parameters.py.

save()

None save	(		self,
		str	file_path )

Saves the calibration parameters to a file.

Parameters

file_path

The path where the parameters should be saved.

Exceptions

IOException

If the file cannot be saved or permissions are insufficient.

Since

ids_peak_icv 1.1

Definition at line 187 of file calibration_parameters.py.

to_binary()

np.ndarray to_binary

(

self

)

Converts the CalibrationParameters instance to a binary representation.

Returns

A NumPy array containing the binary data.

Since

ids_peak_icv 1.1

Definition at line 133 of file calibration_parameters.py.

Field Documentation

_extrinsic_parameters

_extrinsic_parameters = ExtrinsicParameters(_parameters=parameters.extrinsic_parameters)

protected

Definition at line 37 of file calibration_parameters.py.

_intrinsic_parameters

_intrinsic_parameters = IntrinsicParameters(_parameters=parameters.intrinsic_parameters)

protected

Definition at line 36 of file calibration_parameters.py.

extrinsic_parameters

ExtrinsicParameters extrinsic_parameters = other.extrinsic_parameters)

Definition at line 227 of file calibration_parameters.py.

intrinsic_parameters

IntrinsicParameters intrinsic_parameters = other.intrinsic_parameters and

Definition at line 226 of file calibration_parameters.py.