chronoptics::tof::UserConfig Class Reference

Simple interface for camera configuration generation. More...

#include <user_config.hpp>

Inheritance diagram for chronoptics::tof::UserConfig:

Public Member Functions
	UserConfig (tof_user_config_t ptr)
	Construct from pointer.
	UserConfig ()
	Create default user config.
CameraConfig	to_camera_config (Camera &camera) const
	Convert to a camera configuration.
ImagingEnvironment	get_environment () const
	Get the camera operating environment.
void	set_environment (ImagingEnvironment imaging_environment)
	Set the camera operating environment.
float	get_max_distance () const
	Get the maximum distance photons reflect from.
void	set_max_distance (float max_distance)
	Set the maximum distance photons reflect from.
float	get_fps () const
	Get the depth frame rate.
void	set_fps (float fps)
	Set the depth frame rate.
bool	get_lens_flare () const
	Get if lens flare is expected in the scene.
void	set_lens_flare (bool lens_flare)
	Set if lens flare is expected in the scene.
bool	get_translucent () const
	Get if there are translucent objects in the scene.
void	set_translucent (bool translucent)
	Set if there are translucent objects in the scene.
bool	get_hdr () const
	Get high dynamic range enabled.
void	set_hdr (bool hdr)
	Set high dynamic range enabled.
IntegrationTime	get_integration_time () const
	Get the integration time.
void	set_integration_time (IntegrationTime int_time)
	Set the integration time.
Strategy	get_strategy () const
	Get what the configuration is being optimized for.
void	set_strategy (Strategy strategy)
	Set what the configuration is being optimized for.
int32_t	get_channel () const
	Get The camera channel, increment to support multi-camera usage.
void	set_channel (int32_t channel)
	Set The camera channel, increment to support multi-camera usage.

Detailed Description

Simple interface for camera configuration generation.

Definition at line 37 of file user_config.hpp.

Constructor & Destructor Documentation

UserConfig() [1/2]

chronoptics::tof::UserConfig::UserConfig ( tof_user_config_t  ptr )

inline

Construct from pointer.

Definition at line 40 of file user_config.hpp.

UserConfig() [2/2]

chronoptics::tof::UserConfig::UserConfig ( )

inline

Create default user config.

Definition at line 46 of file user_config.hpp.

Member Function Documentation

get_channel()

int32_t chronoptics::tof::UserConfig::get_channel ( ) const

inline

Get The camera channel, increment to support multi-camera usage.

Returns

The channel number, set to 0, otherwise increment with number of cameras.

Definition at line 181 of file user_config.hpp.

get_environment()

ImagingEnvironment chronoptics::tof::UserConfig::get_environment ( ) const

inline

Get the camera operating environment.

Returns

Imaging environment

Definition at line 64 of file user_config.hpp.

get_fps()

float chronoptics::tof::UserConfig::get_fps ( ) const

inline

Get the depth frame rate.

Returns

The depth fps

Definition at line 92 of file user_config.hpp.

get_hdr()

bool chronoptics::tof::UserConfig::get_hdr ( ) const

inline

Get high dynamic range enabled.

Enable this when pixel saturation occurs. This will only happen for retroreflectors or reflective objects close (<20cm) to the camera

Returns

Enable high dynamic range

Definition at line 136 of file user_config.hpp.

get_integration_time()

IntegrationTime chronoptics::tof::UserConfig::get_integration_time ( ) const

inline

Get the integration time.

Returns

The integration time

Definition at line 152 of file user_config.hpp.

get_lens_flare()

bool chronoptics::tof::UserConfig::get_lens_flare ( ) const

inline

Get if lens flare is expected in the scene.

Returns

if lens flare is present

Definition at line 106 of file user_config.hpp.

get_max_distance()

float chronoptics::tof::UserConfig::get_max_distance ( ) const

inline

Get the maximum distance photons reflect from.

Returns

Maximum distance in meters

Definition at line 78 of file user_config.hpp.

get_strategy()

Strategy chronoptics::tof::UserConfig::get_strategy ( ) const

inline

Get what the configuration is being optimized for.

Returns

The user configuration strategy

Definition at line 166 of file user_config.hpp.

get_translucent()

bool chronoptics::tof::UserConfig::get_translucent ( ) const

inline

Get if there are translucent objects in the scene.

Returns

If translucent objects

Definition at line 120 of file user_config.hpp.

set_channel()

void chronoptics::tof::UserConfig::set_channel ( int32_t  channel )

inline

Set The camera channel, increment to support multi-camera usage.

Parameters

channel

The channel number, set to 0, otherwise increment with number of cameras.

Definition at line 189 of file user_config.hpp.

set_environment()

void chronoptics::tof::UserConfig::set_environment ( ImagingEnvironment  imaging_environment )

inline

Set the camera operating environment.

Parameters

imaging_environment

Imaging environment

Definition at line 71 of file user_config.hpp.

set_fps()

void chronoptics::tof::UserConfig::set_fps ( float  fps )

inline

Set the depth frame rate.

Parameters

fps	The depth fps

Definition at line 99 of file user_config.hpp.

set_hdr()

void chronoptics::tof::UserConfig::set_hdr ( bool  hdr )

inline

Set high dynamic range enabled.

Enable this when pixel saturation occurs. This will only happen for retroreflectors or reflective objects close (<20cm) to the camera

Parameters

hdr	Enable high dynamic range

Definition at line 145 of file user_config.hpp.

set_integration_time()

void chronoptics::tof::UserConfig::set_integration_time ( IntegrationTime  int_time )

inline

Set the integration time.

Parameters

int_time

The integration time

Definition at line 159 of file user_config.hpp.

set_lens_flare()

void chronoptics::tof::UserConfig::set_lens_flare ( bool  lens_flare )

inline

Set if lens flare is expected in the scene.

Parameters

lens_flare

if lens flare is present

Definition at line 113 of file user_config.hpp.

set_max_distance()

void chronoptics::tof::UserConfig::set_max_distance ( float  max_distance )

inline

Set the maximum distance photons reflect from.

Parameters

max_distance

Maximum distance in meters

Definition at line 85 of file user_config.hpp.

set_strategy()

void chronoptics::tof::UserConfig::set_strategy ( Strategy  strategy )

inline

Set what the configuration is being optimized for.

Parameters

strategy

The user configuration strategy

Definition at line 173 of file user_config.hpp.

set_translucent()

void chronoptics::tof::UserConfig::set_translucent ( bool  translucent )

inline

Set if there are translucent objects in the scene.

Parameters

translucent

If translucent objects

Definition at line 127 of file user_config.hpp.

to_camera_config()

CameraConfig chronoptics::tof::UserConfig::to_camera_config ( Camera &  camera ) const

inline

Convert to a camera configuration.

Parameters

camera

The camera

Returns

The camera configuration

Definition at line 54 of file user_config.hpp.