CustomObjectDetectionProperties Class Reference

Class containing a set of runtime properties of a certain class ID for the object detection module using a custom model. More...

Functions
CustomObjectDetectionProperties	__cinit__ (self, enabled=False, detection_confidence_threshold=20., is_grounded=True, is_static=False, tracking_timeout=-1., tracking_max_dist=-1., max_box_width_normalized=-1., min_box_width_normalized=-1., max_box_height_normalized=-1., min_box_height_normalized=-1.)
	Default constructor. More...
bool	enabled (self)
	Whether the object object is kept or not.
float	detection_confidence_threshold (self)
	Confidence threshold. More...
bool	is_grounded (self)
	Provide hypothesis about the object movements (degrees of freedom or DoF) to improve the object tracking. More...
bool	is_static (self)
	Provide hypothesis about the object staticity to improve the object tracking. More...
float	tracking_timeout (self)
	Maximum tracking time threshold (in seconds) before dropping the tracked object when unseen for this amount of time. More...
float	tracking_max_dist (self)
	Maximum tracking distance threshold (in meters) before dropping the tracked object when unseen for this amount of meters. More...
float	max_box_width_normalized (self)
	Maximum allowed width normalized to the image size. More...
float	min_box_width_normalized (self)
	Minimum allowed width normalized to the image size. More...
float	max_box_height_normalized (self)
	Maximum allowed height normalized to the image size. More...
float	min_box_height_normalized (self)
	Minimum allowed height normalized to the image size. More...

Detailed Description

Class containing a set of runtime properties of a certain class ID for the object detection module using a custom model.

The default constructor sets all parameters to their default settings.

Note

Parameters can be adjusted by the user.

Functions

__cinit__()

CustomObjectDetectionProperties __cinit__	(		self,
			enabled = False,
			detection_confidence_threshold = 20.,
			is_grounded = True,
			is_static = False,
			tracking_timeout = -1.,
			tracking_max_dist = -1.,
			max_box_width_normalized = -1.,
			min_box_width_normalized = -1.,
			max_box_height_normalized = -1.,
			min_box_height_normalized = -1.
	)

Default constructor.

All the parameters are set to their default values.

Parameters

detection_confidence_threshold	: Chosen detection_confidence_threshold
object_class_filter	: Chosen object_class_filter
object_class_detection_confidence_threshold	: Chosen object_class_detection_confidence_threshold

detection_confidence_threshold()

float detection_confidence_threshold

(

self

)

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.

is_grounded()

bool is_grounded

(

self

)

Provide hypothesis about the object movements (degrees of freedom or DoF) to improve the object tracking.

• true: 2 DoF projected alongside the floor plane. Case for object standing on the ground such as person, vehicle, etc. The projection implies that the objects cannot be superposed on multiple horizontal levels.
• false: 6 DoF (full 3D movements are allowed).

Note

This parameter cannot be changed for a given object tracking id.

It is advised to set it by labels to avoid issues.

is_static()

bool is_static

(

self

)

Provide hypothesis about the object staticity to improve the object tracking.

• true: the object will be assumed to never move nor being moved.
• false: the object will be assumed to be able to move or being moved.

tracking_timeout()

float tracking_timeout

(

self

)

Maximum tracking time threshold (in seconds) before dropping the tracked object when unseen for this amount of time.

By default, let the tracker decide internally based on the internal sub class of the tracked object. Only valid for static object.

tracking_max_dist()

float tracking_max_dist

(

self

)

Maximum tracking distance threshold (in meters) before dropping the tracked object when unseen for this amount of meters.

By default, do not discard tracked object based on distance. Only valid for static object.

max_box_width_normalized()

float max_box_width_normalized

(

self

)

Maximum allowed width normalized to the image size.

Any prediction bigger than that will be filtered out. Default: -1 (no filtering)

min_box_width_normalized()

float min_box_width_normalized

(

self

)

Minimum allowed width normalized to the image size.

Any prediction smaller than that will be filtered out. Default: -1 (no filtering)

max_box_height_normalized()

float max_box_height_normalized

(

self

)

Maximum allowed height normalized to the image size.

Any prediction bigger than that will be filtered out. Default: -1 (no filtering)

min_box_height_normalized()

float min_box_height_normalized

(

self

)

Minimum allowed height normalized to the image size.

Any prediction smaller than that will be filtered out. Default: -1 (no filtering)