NVIDIA DeepStream SDK API Reference

9.2 Release
pydeepstreamdoc::nvmeta::BatchMetaDoc Namespace Reference

Variables

constexpr const char * descr
 
constexpr const char * acquire_display_meta = R"pydeepstream(Acquires a default :class:`DisplayMetadata` object from the pool.)pydeepstream"
 
constexpr const char * acquire_frame_meta = R"pydeepstream(Acquires a default :class:`FrameMetadata` object from the pool.)pydeepstream"
 
constexpr const char * acquire_object_meta = R"pydeepstream(Acquires a default :class:`ObjectMeta` object from the pool.)pydeepstream"
 
constexpr const char * acquire_event_message_meta = R"pydeepstream(Acquires a default :class:`EventMessageUserMetadata` object from the pool.)pydeepstream"
 
constexpr const char * acquire_preprocess_batch_meta = R"pydeepstream(Acquires a default :class:`PreprocessBatchUserMetadata` object from the pool.)pydeepstream"
 
constexpr const char * acquire_user_meta
 
constexpr const char * acquire_obj_reid_meta
 
constexpr const char * user_meta_items
 
constexpr const char * append = R"pydeepstream(Append a :class:`PreprocessBatchUserMetadata` object to the current batch metadata.)pydeepstream"
 
constexpr const char * extract
 

Variable Documentation

◆ acquire_display_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_display_meta = R"pydeepstream(Acquires a default :class:`DisplayMetadata` object from the pool.)pydeepstream"
constexpr

◆ acquire_event_message_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_event_message_meta = R"pydeepstream(Acquires a default :class:`EventMessageUserMetadata` object from the pool.)pydeepstream"
constexpr

◆ acquire_frame_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_frame_meta = R"pydeepstream(Acquires a default :class:`FrameMetadata` object from the pool.)pydeepstream"
constexpr

◆ acquire_obj_reid_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_obj_reid_meta
constexpr
Initial value:
= R"pydeepstream(Acquires an :class:`ObjectReidUserMetadata` object from the batch meta's user meta pool.
The acquired ReID metadata can be filled with feature vectors and attached to object metadata
for use in re-identification tasks.
:returns: :class:`ObjectReidUserMetadata` object ready to be configured.)pydeepstream"

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

Referenced by module_metadata_bind().

◆ acquire_object_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_object_meta = R"pydeepstream(Acquires a default :class:`ObjectMeta` object from the pool.)pydeepstream"
constexpr

◆ acquire_preprocess_batch_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_preprocess_batch_meta = R"pydeepstream(Acquires a default :class:`PreprocessBatchUserMetadata` object from the pool.)pydeepstream"
constexpr

◆ acquire_user_meta

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::acquire_user_meta
constexpr
Initial value:
= R"pydeepstream(Acquires a :class:`UserMetadata` object from the batch meta's user meta pool.
The acquired user meta can be filled with custom data and then attached to a batch, frame, or object metadata.)pydeepstream"

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

Referenced by module_metadata_bind().

◆ append

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

◆ descr

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::descr
constexpr
Initial value:
= R"pydeepstream(
Holds information about a formed batch containing frames from different sources.
NOTE: Both Video and Audio metadata uses the same :class:`BatchMetadata` type.
NOTE: Audio batch metadata is formed within nvinferaudio plugin and will not be corresponding to any one buffer output from nvinferaudio.
The batch metadata for audio is attached to the last input buffer when the audio batch buffering reach configurable threshold (audio frame length)
and this is when inference output is available.
:ivar n_frames: *int* Number of frames present in the current batch.
:ivar is_audio: *bool* True when the batch contains :class:`AudioFrameMetadata` entries.
:ivar frame_items: *iterator* Iterator over items of type :class:`FrameMetadata` in use in the current batch.
:ivar audio_frame_items: *iterator* Iterator over items of type :class:`AudioFrameMetadata` in use in the current audio batch.
:ivar preprocess_batch_items: *iterator* Iterator over preprocess batch metadata in use in the current batch as items of type :class:`UserMetadata`
Each item *user_meta* can be called as :class:`PreprocessBatchUserMetadata` by calling *user_meta.as_preprocess_batch()*.)pydeepstream"

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

Referenced by module_metadata_bind().

◆ extract

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::extract
constexpr
Initial value:
= R"pydeepstream(
Extracts metadata from the batch into a list of dictionaries.
This method efficiently extracts all metadata (bounding boxes, labels, confidences, segmentation maps, audio labels, etc.)
from all frames in the batch. The extraction, data copying, and type conversions are performed in C++ for optimal performance.
:arg max_items: *int* - Maximum number of items in the returned list. The list will have this capacity,
indexed by frame *pad_index*.
:returns: *list of dict* - A list with size equal to *max_items*. Each element corresponds to a frame
indexed by *pad_index*. Elements without data will be *None*.
Each dictionary contains:
- **shape**: *list of int* - Frame dimensions [height, width]
- **bboxes**: *list of list of int* - Bounding boxes in [left, top, right, bottom] format
- **probs**: *list of float* - Confidence scores for each detected object
- **labels**: *list of list of str* - Labels for each object (including classifier outputs)
- **objects**: *list of int* - Object IDs for tracking
- **seg_maps**: *list of numpy.ndarray* - Segmentation maps (instance masks or semantic segmentation) as int arrays
- **timestamp**: *int* - Frame presentation timestamp (PTS)
Audio dictionaries also include **media_type**, **sample_rate**, **num_channels**,
**num_samples_per_frame**, **format**, **layout**, **infer_done**, **class_id**,
**class_label**, and **confidence**.
)pydeepstream"

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

Referenced by module_metadata_bind().

◆ user_meta_items

constexpr const char * pydeepstreamdoc::nvmeta::BatchMetaDoc::user_meta_items
constexpr
Initial value:
= R"pydeepstream(
Gets an iterator over user metadata items of a specific type attached to the batch.
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 55 of file service-maker/sources/python/src/bindings/docstrings/metadatadoc.h.

Referenced by module_metadata_bind().