RuntimeParameters Class Reference

Parameters that defines the behavior of the grab. More...

General Functions

 RuntimeParameters (SENSING_MODE sensing_mode_=SENSING_MODE_STANDARD, bool enable_depth_=true, bool enable_point_cloud_=true, REFERENCE_FRAME measure3D_reference_frame_=REFERENCE_FRAME_CAMERA)
 Default constructor, set all parameters to their default and optimized values. More...
 
bool save (String filename)
 Saves the current set of parameters into a file. More...
 
bool load (String filename)
 Loads the values of the parameters contained in a file. More...
 

Attributes

SENSING_MODE sensing_mode
 
REFERENCE_FRAME measure3D_reference_frame
 
bool enable_depth
 
bool enable_point_cloud
 

Detailed Description

Parameters that defines the behavior of the grab.

Default values are enabled.
You can customize it to fit your application and then save it to create a preset that can be loaded for further executions.

Constructor and Destructor

RuntimeParameters ( SENSING_MODE  sensing_mode_ = SENSING_MODE_STANDARD,
bool  enable_depth_ = true,
bool  enable_point_cloud_ = true,
REFERENCE_FRAME  measure3D_reference_frame_ = REFERENCE_FRAME_CAMERA 
)
inline

Default constructor, set all parameters to their default and optimized values.

Functions

bool save ( String  filename)

Saves the current set of parameters into a file.

Parameters
filename: the path to the file in which the parameters will be stored.
Returns
true if the file was successfully saved, otherwise false.
bool load ( String  filename)

Loads the values of the parameters contained in a file.

Parameters
filename: the path to the file from which the parameters will be loaded.
Returns
true if the file was successfully loaded, otherwise false.

Variables

SENSING_MODE sensing_mode

Defines the algorithm used for depth map computation, more info : SENSING_MODE definition.
default : SENSING_MODE_STANDARD

REFERENCE_FRAME measure3D_reference_frame

Provides 3D measures (point cloud and normals) in the desired reference frame (default is REFERENCE_FRAME_CAMERA)
default : REFERENCE_FRAME_CAMERA

Note
: replaces previous move_point_cloud_to_world_frame parameter.
bool enable_depth

Defines if the depth map should be computed.
If false, only the images are available.
default : true

bool enable_point_cloud

Defines if the point cloud should be computed (including XYZRGBA).
default : true

Deprecated:
Point cloud is now enabled when depth is.