ObjectDetectionRuntimeParameters Class Reference

Structure containing a set of runtime parameters for the object detection module. More...

Functions
	ObjectDetectionRuntimeParameters (float detection_confidence_threshold=20.f, std::vector< OBJECT_CLASS > object_class_filter={}, std::map< OBJECT_CLASS, float > object_class_detection_confidence_threshold=std::map< OBJECT_CLASS, float >())
	Default constructor. More...
bool	operator== (const ObjectDetectionRuntimeParameters &param1) const
bool	operator!= (const ObjectDetectionRuntimeParameters &param1) const

Attributes
float	detection_confidence_threshold
	Confidence threshold. More...
std::vector< OBJECT_CLASS >	object_class_filter
	Defines which object types to detect and track. More...
std::map< OBJECT_CLASS, float >	object_class_detection_confidence_threshold
	Map of confidence thresholds for each class (can be empty for some classes). More...

Detailed Description

Structure containing a set of runtime parameters for the object detection module.

The default constructor sets all parameters to their default settings.

Note

Parameters can be adjusted by the user.

Constructor and Destructor

ObjectDetectionRuntimeParameters()

ObjectDetectionRuntimeParameters	(	float	detection_confidence_threshold = 20.f,
		std::vector< OBJECT_CLASS >	object_class_filter = {},
		std::map< OBJECT_CLASS, float >	object_class_detection_confidence_threshold = std::map< OBJECT_CLASS, float >()
	)

Default constructor.

All the parameters are set to their default values.

Functions

operator==()

bool operator==

(

const ObjectDetectionRuntimeParameters &

param1

)

const

Comparison operator ==

Parameters

ObjectDetectionRuntimeParameters

to compare

Returns

true if the two struct are identical

operator!=()

bool operator!=

(

const ObjectDetectionRuntimeParameters &

param1

)

const

Comparison operator !=

Parameters

ObjectDetectionRuntimeParameters

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.

detection_confidence_threshold is used as a fallback when sl::ObjectDetectionRuntimeParameters.object_class_detection_confidence_threshold is partially set.

object_class_filter

std::vector<OBJECT_CLASS> object_class_filter

Defines which object types to detect and track.

Default: {} (all classes are tracked)

Note

Fewer object types can slightly speed up the process since every object is tracked.

Will output only the selected classes.

In order to get all the available classes, the filter vector must be empty :

object_class_filter = {};

To select a set of specific object classes, like vehicles, persons and animals for instance:

object_class_filter = {OBJECT_CLASS::VEHICLE, OBJECT_CLASS::PERSON, OBJECT_CLASS::ANIMAL};

object_class_detection_confidence_threshold

std::map<OBJECT_CLASS, float> object_class_detection_confidence_threshold

Map of confidence thresholds for each class (can be empty for some classes).

Note

sl::ObjectDetectionRuntimeParameters.detection_confidence_threshold will be taken as fallback/default value.