CalibrationParameters Class Reference

#include <peak_icv/algorithms/calibration/peak_icv_calibration_parameters.hpp>

Public Member Functions
	CalibrationParameters (const std::string &filePath)
	Constructs a CalibrationParameters instance by loading data from a JSON file.
	CalibrationParameters (const IntrinsicParameters &intrinsicParameters, const ExtrinsicParameters &extrinsicParameters)
	Constructs a CalibrationParameters instance from the provided intrinsic and extrinsic parameters.
	CalibrationParameters (const peak_icv_calibration_parameters_binary &calibrationParametersBinary)
	Constructs a CalibrationParameters instance from binary calibration parameters that have been read from the camera memory.
IntrinsicParameters	GetIntrinsicParameters () const
	Retrieves the intrinsic camera parameters.
ExtrinsicParameters	GetExtrinsicParameters () const
	Retrieves the extrinsic camera parameters.
peak_icv_calibration_parameters_binary	ToBinary () const
	Converts CalibrationParameters to binary calibration parameters that can be written to the camera memory.

Friends
class	CalibrationResult

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.

Warning

This function is still in development and not released.

Definition at line 41 of file peak_icv_calibration_parameters.hpp.

Constructor & Destructor Documentation

CalibrationParameters() [1/3]

CalibrationParameters ( const std::string & filePath )

inlineexplicit

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

[in]

filePath

Path to the JSON file containing 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.

Warning

This function is still in development and not released.

Definition at line 134 of file peak_icv_calibration_parameters.hpp.

CalibrationParameters() [2/3]

CalibrationParameters ( const IntrinsicParameters & intrinsicParameters, const ExtrinsicParameters & extrinsicParameters )

inline

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

Parameters

[in]	intrinsicParameters	The intrinsic camera parameters.
[in]	extrinsicParameters	The extrinsic camera parameters.

Warning

This function is still in development and not released.

Definition at line 145 of file peak_icv_calibration_parameters.hpp.

CalibrationParameters() [3/3]

CalibrationParameters ( const peak_icv_calibration_parameters_binary & calibrationParametersBinary )

inlineexplicit

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

Parameters

[in]

calibrationParametersBinary

The binary calibration parameters.

Exceptions

CorruptedException

If the binary calibration parameters are corrupted.

Warning

This function is still in development and not released.

Definition at line 151 of file peak_icv_calibration_parameters.hpp.

Member Function Documentation

GetExtrinsicParameters()

ExtrinsicParameters GetExtrinsicParameters ( ) const

inline

Retrieves the extrinsic camera parameters.

Returns

The extrinsic camera parameters.

Warning

This function is still in development and not released.

Definition at line 178 of file peak_icv_calibration_parameters.hpp.

GetIntrinsicParameters()

IntrinsicParameters GetIntrinsicParameters ( ) const

inline

Retrieves the intrinsic camera parameters.

Returns

The intrinsic camera parameters.

Warning

This function is still in development and not released.

Definition at line 173 of file peak_icv_calibration_parameters.hpp.

ToBinary()

peak_icv_calibration_parameters_binary ToBinary ( ) const

inline

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

Returns

The binary calibration parameters.

Warning

This function is still in development and not released.

Definition at line 194 of file peak_icv_calibration_parameters.hpp.

Friends And Related Symbol Documentation

CalibrationResult

friend class CalibrationResult

friend

Definition at line 124 of file peak_icv_calibration_parameters.hpp.