Time-of-Flight Library(ToF) 3.11.1
 
chronoptics::tof::Calibration Class Reference

This class contains all the calibration information. More...

#include <calibration.hpp>

+ Inheritance diagram for chronoptics::tof::Calibration:

Public Member Functions

 Calibration (tof_calibration_t ptr=nullptr)
 Construct from pointer.
 
 Calibration (StringView file_location)
 Read calibration from disk.
 
void write (StringView file_location) const
 Write calibration to disk.
 
std::vector< float > get_calibrated_frequencies () const
 The the calibrated frequencies in the calibration file.
 
double get_focal_length_x () const
 Get focal length x.
 
double get_focal_length_y () const
 Get focal length y.
 
double get_principal_point_x () const
 Get principal point x.
 
double get_principal_point_y () const
 Get principal point y.
 
std::array< double, 9 > get_depth_camera_matrix ()
 Get the camera matrix of the depth sensor and lens.
 
std::array< double, 5 > get_depth_distortion_coefficients ()
 Get the distortion coefficients of the depth lens.
 
std::array< double, 9 > get_rgb_camera_matrix ()
 Get the camera matrix of the rgb sensor and lens.
 
std::array< double, 5 > get_rgb_distortion_coefficients ()
 Get the distortion coefficients of the rgb lens.
 
std::array< double, 3 > get_rotation_vector ()
 Get the rotation vector between the depth and rgb sensor.
 
std::array< double, 3 > get_translation_vector ()
 Get the translation vector between the depth and rgb sensor.
 

Detailed Description

This class contains all the calibration information.

Definition at line 38 of file calibration.hpp.

Constructor & Destructor Documentation

◆ Calibration() [1/2]

chronoptics::tof::Calibration::Calibration ( tof_calibration_t  ptr = nullptr)
inline

Construct from pointer.

Definition at line 41 of file calibration.hpp.

◆ Calibration() [2/2]

chronoptics::tof::Calibration::Calibration ( StringView  file_location)
inline

Read calibration from disk.

Parameters
file_locationLocation of calibration file

Definition at line 48 of file calibration.hpp.

Member Function Documentation

◆ get_calibrated_frequencies()

std::vector< float > chronoptics::tof::Calibration::get_calibrated_frequencies ( ) const
inline

The the calibrated frequencies in the calibration file.

Returns
The calibrated modulation frequencies

Definition at line 62 of file calibration.hpp.

◆ get_depth_camera_matrix()

std::array< double, 9 > chronoptics::tof::Calibration::get_depth_camera_matrix ( )
inline

Get the camera matrix of the depth sensor and lens.

Returns
Camera matrix, 3x3 matrix

Definition at line 100 of file calibration.hpp.

◆ get_depth_distortion_coefficients()

std::array< double, 5 > chronoptics::tof::Calibration::get_depth_distortion_coefficients ( )
inline

Get the distortion coefficients of the depth lens.

Returns
Distortion coefficients, 5x1 matrix

Definition at line 110 of file calibration.hpp.

◆ get_focal_length_x()

double chronoptics::tof::Calibration::get_focal_length_x ( ) const
inline

Get focal length x.

Returns
Focal length

Definition at line 72 of file calibration.hpp.

◆ get_focal_length_y()

double chronoptics::tof::Calibration::get_focal_length_y ( ) const
inline

Get focal length y.

Returns
Focal length

Definition at line 79 of file calibration.hpp.

◆ get_principal_point_x()

double chronoptics::tof::Calibration::get_principal_point_x ( ) const
inline

Get principal point x.

Returns
Principal point

Definition at line 86 of file calibration.hpp.

◆ get_principal_point_y()

double chronoptics::tof::Calibration::get_principal_point_y ( ) const
inline

Get principal point y.

Returns
Principal point

Definition at line 93 of file calibration.hpp.

◆ get_rgb_camera_matrix()

std::array< double, 9 > chronoptics::tof::Calibration::get_rgb_camera_matrix ( )
inline

Get the camera matrix of the rgb sensor and lens.

Returns
Camera matrix, 3x3 matrix

Definition at line 120 of file calibration.hpp.

◆ get_rgb_distortion_coefficients()

std::array< double, 5 > chronoptics::tof::Calibration::get_rgb_distortion_coefficients ( )
inline

Get the distortion coefficients of the rgb lens.

Returns
Distortion coefficients, 5x1 matrix

Definition at line 130 of file calibration.hpp.

◆ get_rotation_vector()

std::array< double, 3 > chronoptics::tof::Calibration::get_rotation_vector ( )
inline

Get the rotation vector between the depth and rgb sensor.

Returns
Rotation vector, 3x1 matrix

Definition at line 140 of file calibration.hpp.

◆ get_translation_vector()

std::array< double, 3 > chronoptics::tof::Calibration::get_translation_vector ( )
inline

Get the translation vector between the depth and rgb sensor.

Returns
Translation vector, 3x1 matrix

Definition at line 150 of file calibration.hpp.

◆ write()

void chronoptics::tof::Calibration::write ( StringView  file_location) const
inline

Write calibration to disk.

Parameters
file_locationLocation to save the calibration file to

Definition at line 55 of file calibration.hpp.