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.
template<class Container >
	CalibrationParameters (const Container &binaryData)
	Constructs a CalibrationParameters instance from binary data that have been read from the camera memory.
IntrinsicParameters	GetIntrinsicParameters () const
	Retrieves the intrinsic camera parameters.
ExtrinsicParameters	GetExtrinsicParameters () const
	Retrieves the extrinsic camera parameters.
void	SetExtrinsicParameters (const ExtrinsicParameters &extrinsicParameters)
	Sets the extrinsic camera parameters.
std::vector< uint8_t >	ToBinary () const
	Converts CalibrationParameters to binary data 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.

Since

ids_peak_icv 1.1

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.

Since

ids_peak_icv 1.1

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.

Since

ids_peak_icv 1.1

CalibrationParameters() [3/3]

template<class Container >

CalibrationParameters ( const Container & binaryData )

inlineexplicit

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

Parameters

[in]

binaryData

The binary data.

Exceptions

CorruptedException

If the binary data is corrupted.

Since

ids_peak_icv 1.1

Member Function Documentation

GetExtrinsicParameters()

ExtrinsicParameters GetExtrinsicParameters ( ) const

inline

Retrieves the extrinsic camera parameters.

Returns

The extrinsic camera parameters.

Since

ids_peak_icv 1.1

GetIntrinsicParameters()

IntrinsicParameters GetIntrinsicParameters ( ) const

inline

Retrieves the intrinsic camera parameters.

Returns

The intrinsic camera parameters.

Since

ids_peak_icv 1.1

SetExtrinsicParameters()

void SetExtrinsicParameters ( const ExtrinsicParameters & extrinsicParameters )

inline

Sets the extrinsic camera parameters.

Parameters

[in]

extrinsicParameters

The extrinsic camera parameters.

Since

ids_peak_icv 1.2

ToBinary()

std::vector< uint8_t > ToBinary ( ) const

inline

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

Returns

The binary data.

Since

ids_peak_icv 1.1

Friends And Related Symbol Documentation

CalibrationResult

friend class CalibrationResult

friend