BodyTrackingRuntimeParameters Struct Reference

Structure containing a set of runtime parameters for the body tracking module. More...

Functions
	BodyTrackingRuntimeParameters (float detection_confidence_threshold=20.f, int minimum_keypoints_threshold=0, float skeleton_smoothing=0.f)
	Default constructor. More...
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 BodyTrackingRuntimeParameters &param1) const
bool	operator!= (const BodyTrackingRuntimeParameters &param1) const

Attributes
float	detection_confidence_threshold
	Confidence threshold. More...
int	minimum_keypoints_threshold
	Minimum threshold for the keypoints. More...
float	skeleton_smoothing = 0.f
	Control of the smoothing of the fitted fused skeleton. More...

Detailed Description

Structure containing a set of runtime parameters for the body tracking module.

The default constructor sets all parameters to their default settings.

Note

Parameters can be adjusted by the user.

Constructor and Destructor

BodyTrackingRuntimeParameters()

BodyTrackingRuntimeParameters	(	float	detection_confidence_threshold = 20.f,
		int	minimum_keypoints_threshold = 0,
		float	skeleton_smoothing = 0.f
	)

Default constructor.

All the parameters are set to their default values.

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 BodyTrackingRuntimeParameters &

param1

)

const

Comparison operator ==

Parameters

BodyTrackingRuntimeParameters

to compare

Returns

true if the two struct are identical

operator!=()

bool operator!=

(

const BodyTrackingRuntimeParameters &

param1

)

const

Comparison operator !=

Parameters

BodyTrackingRuntimeParameters

to compare

Returns

true if the two struct are different

Variables

detection_confidence_threshold

float detection_confidence_threshold

Confidence threshold.

From 1 to 100, with 1 meaning a low threshold, more uncertain objects and 99 very few but very precise objects.
Default: 20.f

Note

If the scene contains a lot of objects, increasing the confidence can slightly speed up the process, since every object instance is tracked.

minimum_keypoints_threshold

int minimum_keypoints_threshold

Minimum threshold for the keypoints.

The ZED SDK will only output the keypoints of the skeletons with threshold greater than this value.
Default: 0

Note

It is useful, for example, to remove unstable fitting results when a skeleton is partially occluded.

skeleton_smoothing

float skeleton_smoothing = 0.f

Control of the smoothing of the fitted fused skeleton.

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