Intel® RealSense™ Cross Platform API
Intel Realsense Cross-platform API
Public Member Functions | List of all members
rs2::auto_calibrated_device Class Reference

#include <rs_device.hpp>

Inheritance diagram for rs2::auto_calibrated_device:
rs2::calibrated_device rs2::device

Public Member Functions

 auto_calibrated_device (device d)
 
template<class T >
calibration_table run_on_chip_calibration (std::string json_content, float *health, T callback, int timeout_ms=5000) const
 
calibration_table run_on_chip_calibration (std::string json_content, float *health, int timeout_ms=5000) const
 
template<class T >
calibration_table run_tare_calibration (float ground_truth_mm, std::string json_content, T callback, int timeout_ms=5000) const
 
calibration_table run_tare_calibration (float ground_truth_mm, std::string json_content, int timeout_ms=5000) const
 
calibration_table get_calibration_table ()
 
void set_calibration_table (const calibration_table &calibration)
 
- Public Member Functions inherited from rs2::calibrated_device
 calibrated_device (device d)
 
void write_calibration () const
 
void reset_to_factory_calibration ()
 
- Public Member Functions inherited from rs2::device
std::vector< sensorquery_sensors () const
 
template<class T >
first () const
 
bool supports (rs2_camera_info info) const
 
const char * get_info (rs2_camera_info info) const
 
void hardware_reset ()
 
deviceoperator= (const std::shared_ptr< rs2_device > dev)
 
deviceoperator= (const device &dev)
 
 device ()
 
 operator bool () const
 
const std::shared_ptr< rs2_device > & get () const
 
template<class T >
bool is () const
 
template<class T >
as () const
 
virtual ~device ()
 
 operator std::shared_ptr< rs2_device > ()
 
 device (std::shared_ptr< rs2_device > dev)
 

Additional Inherited Members

- Protected Attributes inherited from rs2::device
std::shared_ptr< rs2_device_dev
 

Constructor & Destructor Documentation

◆ auto_calibrated_device()

rs2::auto_calibrated_device::auto_calibrated_device ( device  d)
inline

Member Function Documentation

◆ get_calibration_table()

calibration_table rs2::auto_calibrated_device::get_calibration_table ( )
inline

Read current calibration table from flash.

Returns
Calibration table

◆ run_on_chip_calibration() [1/2]

template<class T >
calibration_table rs2::auto_calibrated_device::run_on_chip_calibration ( std::string  json_content,
float *  health,
callback,
int  timeout_ms = 5000 
) const
inline

This will improve the depth noise.

Parameters
[in]json_contentJson string to configure speed on chip calibration parameters: { "speed": 3, "scan parameter": 0, "data sampling": 0 } speed - value can be one of: Very fast = 0, Fast = 1, Medium = 2, Slow = 3, White wall = 4, default is Slow scan_parameter - value can be one of: Py scan (default) = 0, Rx scan = 1 data_sampling - value can be one of:polling data sampling = 0, interrupt data sampling = 1 if json is nullptr it will be ignored and calibration will use the default parameters
[out]healthCalibration Health-Check captures how far camera calibration is from the optimal one [0, 0.25) - Good [0.25, 0.75) - Can be Improved [0.75, ) - Requires Calibration
[in]callbackOptional callback to get progress notifications
[in]timeout_msTimeout in ms
Returns
New calibration table

◆ run_on_chip_calibration() [2/2]

calibration_table rs2::auto_calibrated_device::run_on_chip_calibration ( std::string  json_content,
float *  health,
int  timeout_ms = 5000 
) const
inline

This will improve the depth noise.

Parameters
[in]json_contentJson string to configure speed on chip calibration parameters: { "speed": 3, "scan parameter": 0, "data sampling": 0 } speed - value can be one of: Very fast = 0, Fast = 1, Medium = 2, Slow = 3, White wall = 4, default is Slow scan parameter - value can be one of: Py scan (default) = 0, Rx scan = 1 data sampling - value can be one of:polling data sampling = 0, interrupt data sampling = 1 if json is nullptr it will be ignored and calibration will use the default parameters
[out]healthCalibration Health-Check captures how far camera calibration is from the optimal one [0, 0.25) - Good [0.25, 0.75) - Can be Improved [0.75, ) - Requires Calibration
[in]timeout_msTimeout in ms
Returns
New calibration table

◆ run_tare_calibration() [1/2]

template<class T >
calibration_table rs2::auto_calibrated_device::run_tare_calibration ( float  ground_truth_mm,
std::string  json_content,
callback,
int  timeout_ms = 5000 
) const
inline

This will adjust camera absolute distance to flat target. User needs to enter the known ground truth.

Parameters
[in]ground_truth_mmGround truth in mm must be between 2500 - 2000000
[in]json_contentJson string to configure tare calibration parameters: { "average step count": 20, "step count": 20, "accuracy": 2, "scan parameter": 0, "data sampling": 0 } average step count - number of frames to average, must be between 1 - 30, default = 20 step count - max iteration steps, must be between 5 - 30, default = 10 accuracy - Subpixel accuracy level, value can be one of: Very high = 0 (0.025%), High = 1 (0.05%), Medium = 2 (0.1%), Low = 3 (0.2%), Default = Very high (0.025%), default is very high (0.025%) scan_parameter - value can be one of: Py scan (default) = 0, Rx scan = 1 data_sampling - value can be one of:polling data sampling = 0, interrupt data sampling = 1 if json is nullptr it will be ignored and calibration will use the default parameters
[in]content_sizeJson string size if its 0 the json will be ignored and calibration will use the default parameters
[in]callbackOptional callback to get progress notifications
[in]timeout_msTimeout in ms
Returns
New calibration table

◆ run_tare_calibration() [2/2]

calibration_table rs2::auto_calibrated_device::run_tare_calibration ( float  ground_truth_mm,
std::string  json_content,
int  timeout_ms = 5000 
) const
inline

This will adjust camera absolute distance to flat target. User needs to enter the known ground truth.

Parameters
[in]ground_truth_mmGround truth in mm must be between 2500 - 2000000
[in]json_contentJson string to configure tare calibration parameters: { "average step count": 20, "step count": 20, "accuracy": 2, "scan parameter": 0, "data sampling": 0 } average step count - number of frames to average, must be between 1 - 30, default = 20 step count - max iteration steps, must be between 5 - 30, default = 10 accuracy - Subpixel accuracy level, value can be one of: Very high = 0 (0.025%), High = 1 (0.05%), Medium = 2 (0.1%), Low = 3 (0.2%), Default = Very high (0.025%), default is very high (0.025%) scan_parameter - value can be one of: Py scan (default) = 0, Rx scan = 1 data_sampling - value can be one of:polling data sampling = 0, interrupt data sampling = 1 if json is nullptr it will be ignored and calibration will use the default parameters
[in]content_sizeJson string size if its 0 the json will be ignored and calibration will use the default parameters
[in]timeout_msTimeout in ms
Returns
New calibration table

◆ set_calibration_table()

void rs2::auto_calibrated_device::set_calibration_table ( const calibration_table calibration)
inline

Set current table to dynamic area.

Parameters
[in]Calibrationtable

The documentation for this class was generated from the following file: