BodyTrackingFusionRuntimeParameters Class Reference

Holds the options used to change the behavior of the body tracking module at runtime. More...

Functions
bool	save (String filename, SERIALIZATION_FORMAT format=SERIALIZATION_FORMAT::JSON) const
	Saves the current set of parameters into a file to be reloaded with the load() method. More...
bool	load (String filename, SERIALIZATION_FORMAT format=SERIALIZATION_FORMAT::JSON)
	Loads a set of parameters from the values contained in a previously saved file. More...
bool	encode (String &serialized_content, SERIALIZATION_FORMAT format=SERIALIZATION_FORMAT::JSON) const
	Generate a JSON Object (with the struct type as a key) containing the serialized struct, converted into a string. More...
bool	decode (const String &serialized_content, SERIALIZATION_FORMAT format=SERIALIZATION_FORMAT::JSON)
	Fill the structure from the serialized json object contained in the input string. More...
bool	operator== (const BodyTrackingFusionRuntimeParameters &param1) const
	Comparison operator ==. More...
bool	operator!= (const BodyTrackingFusionRuntimeParameters &param1) const
	Comparison operator !=. More...

Attributes
int	skeleton_minimum_allowed_keypoints = -1
	If the fused skeleton has less than skeleton_minimum_allowed_keypoints keypoints, it will be discarded. More...
int	skeleton_minimum_allowed_camera = -1
	If a skeleton was detected in less than skeleton_minimum_allowed_camera cameras, it will be discarded. More...
float	skeleton_smoothing = 0.f
	This value controls the smoothing of the tracked or fitted fused skeleton. More...

Detailed Description

Holds the options used to change the behavior of the body tracking module at runtime.

Functions

save()

bool save	(	String	filename,
		SERIALIZATION_FORMAT	format = SERIALIZATION_FORMAT::JSON
	)		const

Saves the current set of parameters into a file to be reloaded with the load() method.

Parameters

filename

: Name of the file which will be created to store the parameters (extension '.yml' will be added if not set).

Returns

True if the file was successfully saved, otherwise false.

Warning

For security reasons, the file must not already exist.

In case a file already exists, the method will return false and existing file will not be updated.

load()

bool load	(	String	filename,
		SERIALIZATION_FORMAT	format = SERIALIZATION_FORMAT::JSON
	)

Loads a set of parameters from the values contained in a previously saved file.

Parameters

filename

: Path to the file from which the parameters will be loaded (extension '.yml' will be added at the end of the filename if not detected).

Returns

True if the file was successfully loaded, otherwise false.

encode()

bool encode	(	String &	serialized_content,
		SERIALIZATION_FORMAT	format = SERIALIZATION_FORMAT::JSON
	)		const

Generate a JSON Object (with the struct type as a key) containing the serialized struct, converted into a string.

Parameters

serialized_content	output string containing the JSON Object
format	serialization format, default is JSON

Returns

True if file was successfully saved, otherwise false.

decode()

bool decode	(	const String &	serialized_content,
		SERIALIZATION_FORMAT	format = SERIALIZATION_FORMAT::JSON
	)

Fill the structure from the serialized json object contained in the input string.

Parameters

serialized_content	input string containing the JSON Object
format	serialization format, default is JSON

Returns

True if the decoding was successful, otherwise false.

operator==()

bool operator==

(

const BodyTrackingFusionRuntimeParameters &

param1

)

const

Comparison operator ==.

Parameters

BodyTrackingFusionRuntimeParameters

to compare

Returns

true if the two struct are identical

operator!=()

bool operator!=

(

const BodyTrackingFusionRuntimeParameters &

param1

)

const

Comparison operator !=.

Parameters

BodyTrackingFusionRuntimeParameters

to compare

Returns

true if the two struct are different

Variables

skeleton_minimum_allowed_keypoints

int skeleton_minimum_allowed_keypoints = -1

If the fused skeleton has less than skeleton_minimum_allowed_keypoints keypoints, it will be discarded.

skeleton_minimum_allowed_camera

int skeleton_minimum_allowed_camera = -1

If a skeleton was detected in less than skeleton_minimum_allowed_camera cameras, it will be discarded.

skeleton_smoothing

float skeleton_smoothing = 0.f

This value controls the smoothing of the tracked or fitted fused skeleton.

It is ranged from 0 (low smoothing) and 1 (high smoothing).