NVIDIA DeepStream SDK API Reference

9.2 Release
pydeepstreamdoc::nvmeta::ObjectMetaDoc Namespace Reference

Variables

constexpr const char * descr
 
constexpr const char * append = R"pydeepstream(Append a :class:`UserMetadata` object to the current object metadata.)pydeepstream"
 
constexpr const char * user_meta_items
 

Variable Documentation

◆ append

constexpr const char * pydeepstreamdoc::nvmeta::ObjectMetaDoc::append = R"pydeepstream(Append a :class:`UserMetadata` object to the current object metadata.)pydeepstream"
constexpr

◆ descr

constexpr const char * pydeepstreamdoc::nvmeta::ObjectMetaDoc::descr
constexpr
Initial value:
= R"pydeepstream(
Holds information of object metadata in the frame.
:ivar class_id: *int*, Index of the object class infered by the primary detector/classifier
:ivar object_id: *int*, Unique ID for tracking the object.
:ivar unique_component_id: *int*, Unique id of the component that generates the object metadata.
:ivar confidence: *float*, Holds a confidence value for the object, set by the inference component.
Confidence will be set to -0.1, if "Group Rectangles" mode of clustering is chosen since the algorithm does not preserve confidence values.
Also, for objects found by tracker and not inference component, confidence will be set to -0.1
:ivar tracker_confidence: *float*, Holds a confidence value for the object, set by the tracker component.
:ivar rect_params: :class:`NvOSD_RectParams`, Structure containing the positional parameters of the object in the frame.
Can also be used to overlay borders / semi-transparent boxes on top of objects. See :class:`NvOSD_RectParams`
:ivar mask_params: :class:`NvOSD_MaskParams`, Mask parameters for the object. This mask is overlaid over the object See :class:`NvOSD_MaskParams`
:ivar text_params: :class:`NvOSD_TextParams`, Text for describing the object. See :class:`NvOSD_TextParams`
:ivar label: *str*, Label describing the class of the detected object.
:ivar classifier_items: *iterator* Iterator over items of type :class:`ClassifierMetadata` in use in the current object.
:ivar tensor_items: *iterator* Iterator over items of type :class:`UserMetadata` in use in the current object as items of type :class:`TensorOutputUserMetadata`
Each item *user_meta* can be called as :class:`TensorOutputUserMetadata` by calling *user_meta.as_tensor_output()*.
:ivar obj_reid_items: *iterator* Iterator over ReID user metadata items of type :class:`UserMetadata`.
Each item *user_meta* can be cast to :class:`ObjectReidUserMetadata` by calling *user_meta.as_obj_reid()*.)pydeepstream"

Definition at line 155 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().

◆ user_meta_items

constexpr const char * pydeepstreamdoc::nvmeta::ObjectMetaDoc::user_meta_items
constexpr
Initial value:
= R"pydeepstream(
Gets an iterator over user metadata items of a specific type attached to the object.
This generic method allows accessing any user metadata type without requiring
specific bindings for each type.
:arg meta_type: *int*, The NvDsMetaType value (e.g., NVDS_TRACKER_OBJ_REID_META).
:returns: Iterator over :class:`UserMetadata` items matching the specified type.)pydeepstream"

Definition at line 177 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().