Detailed Description
Object metadata.
The metadata is for describing a detected object
Definition at line 155 of file metadata.hpp.
Public Types | |
| typedef std::unique_ptr< AbstractIterator< ObjectMetadata > > | Iterator |
Public Member Functions | |
| ObjectMetadata (void *data=nullptr) | |
| Constructor through opaque data pointer. More... | |
| virtual | ~ObjectMetadata () |
| Destructor. More... | |
| unsigned int | uniqueComponentId () const |
| Number to identify the unique component that generates the metadata. More... | |
| void | setUniqueComponentId (unsigned int) |
| unsigned int | classId () const |
| Number to identify the class of the object. More... | |
| void | setClassId (unsigned int) |
| unsigned long int | objectId () const |
| Number to identify the object which is tracked in the scene. More... | |
| void | setObjectId (unsigned long) |
| float | confidence () const |
| Confidence level. More... | |
| void | setConfidence (float) |
| float | trackerConfidence () const |
| Confidence level from tracker. More... | |
| void | setTrackerConfidence (float) |
| NvOSD_RectParams & | rectParams () const |
| Bounding box of the object. More... | |
| void | setRectParams (const NvOSD_RectParams &) |
| NvOSD_MaskParams & | maskParams () const |
| Holds mask parameters for the object. More... | |
| void | setMaskParams (const NvOSD_MaskParams &) |
| NvOSD_TextParams & | textParams () const |
| Formated text description of the object, controlling osd display. More... | |
| void | setTextParams (const NvOSD_TextParams &) |
| std::string | label () const |
| A string to describe the object class. More... | |
| void | setLabel (std::string) |
| NvBbox_Coords & | nvBboxInfo () const |
| Bounding box of the object. More... | |
| void | setNvBboxInfo (const NvBbox_Coords &) |
| unsigned int | iterate (const std::function< void(const ClassifierMetadata &)> &func) const |
| Iterate the classifier metadata within it. More... | |
| void | initiateIterator (ClassifierMetadata::Iterator &) const |
| Get the iterator for object metadata within it. More... | |
| unsigned int | iterate (const std::function< void(const UserMetadata &)> &func, int meta_type) const |
| Iterate the user metadata within it. More... | |
| void | initiateIterator (UserMetadata::Iterator &, int meta_type) const |
| Get the iterator for user metadata within it. More... | |
| virtual | operator bool () |
| operator to check if a metadata is void More... | |
Protected Attributes | |
| void * | data_ |
Friends | |
| class | FrameMetadata |
Member Typedef Documentation
◆ Iterator
| typedef std::unique_ptr<AbstractIterator<ObjectMetadata> > deepstream::ObjectMetadata::Iterator |
Definition at line 157 of file metadata.hpp.
Constructor & Destructor Documentation
◆ ObjectMetadata()
| deepstream::ObjectMetadata::ObjectMetadata | ( | void * | data = nullptr | ) |
Constructor through opaque data pointer.
By default an empty object metadata object is created.
◆ ~ObjectMetadata()
|
virtual |
Destructor.
Member Function Documentation
◆ classId()
| unsigned int deepstream::ObjectMetadata::classId | ( | ) | const |
Number to identify the class of the object.
Referenced by deepstream::ObjectCounter::consume(), and deepstream::CountMarker::handleData().
◆ confidence()
| float deepstream::ObjectMetadata::confidence | ( | ) | const |
Confidence level.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump().
◆ initiateIterator() [1/2]
| void deepstream::ObjectMetadata::initiateIterator | ( | ClassifierMetadata::Iterator & | ) | const |
Get the iterator for object metadata within it.
◆ initiateIterator() [2/2]
| void deepstream::ObjectMetadata::initiateIterator | ( | UserMetadata::Iterator & | , |
| int | meta_type | ||
| ) | const |
Get the iterator for user metadata within it.
◆ iterate() [1/2]
| unsigned int deepstream::ObjectMetadata::iterate | ( | const std::function< void(const ClassifierMetadata &)> & | func | ) | const |
Iterate the classifier metadata within it.
Referenced by deepstream::NvDsKittiDump::generateTrackerKittiDump().
◆ iterate() [2/2]
| unsigned int deepstream::ObjectMetadata::iterate | ( | const std::function< void(const UserMetadata &)> & | func, |
| int | meta_type | ||
| ) | const |
Iterate the user metadata within it.
◆ label()
| std::string deepstream::ObjectMetadata::label | ( | ) | const |
A string to describe the object class.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump(), and deepstream::NvDsKittiDump::generateTrackerKittiDump().
◆ maskParams()
| NvOSD_MaskParams& deepstream::ObjectMetadata::maskParams | ( | ) | const |
Holds mask parameters for the object.
This mask is overlayed on object
◆ nvBboxInfo()
| NvBbox_Coords& deepstream::ObjectMetadata::nvBboxInfo | ( | ) | const |
Bounding box of the object.
Referenced by deepstream::NvDsKittiDump::generateTrackerKittiDump().
◆ objectId()
| unsigned long int deepstream::ObjectMetadata::objectId | ( | ) | const |
Number to identify the object which is tracked in the scene.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump(), and deepstream::NvDsKittiDump::generateTrackerKittiDump().
◆ operator bool()
|
inlinevirtualinherited |
operator to check if a metadata is void
Reimplemented in deepstream::UserMetadata.
Definition at line 51 of file metadata.hpp.
References deepstream::Metadata::data_.
◆ rectParams()
| NvOSD_RectParams& deepstream::ObjectMetadata::rectParams | ( | ) | const |
Bounding box of the object.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump().
◆ setClassId()
| void deepstream::ObjectMetadata::setClassId | ( | unsigned int | ) |
Referenced by deepstream::TensorMetaParser::handleData().
◆ setConfidence()
| void deepstream::ObjectMetadata::setConfidence | ( | float | ) |
Referenced by deepstream::TensorMetaParser::handleData().
◆ setLabel()
| void deepstream::ObjectMetadata::setLabel | ( | std::string | ) |
◆ setMaskParams()
| void deepstream::ObjectMetadata::setMaskParams | ( | const NvOSD_MaskParams & | ) |
◆ setNvBboxInfo()
| void deepstream::ObjectMetadata::setNvBboxInfo | ( | const NvBbox_Coords & | ) |
◆ setObjectId()
| void deepstream::ObjectMetadata::setObjectId | ( | unsigned long | ) |
◆ setRectParams()
| void deepstream::ObjectMetadata::setRectParams | ( | const NvOSD_RectParams & | ) |
Referenced by deepstream::TensorMetaParser::handleData().
◆ setTextParams()
| void deepstream::ObjectMetadata::setTextParams | ( | const NvOSD_TextParams & | ) |
◆ setTrackerConfidence()
| void deepstream::ObjectMetadata::setTrackerConfidence | ( | float | ) |
◆ setUniqueComponentId()
| void deepstream::ObjectMetadata::setUniqueComponentId | ( | unsigned int | ) |
◆ textParams()
| NvOSD_TextParams& deepstream::ObjectMetadata::textParams | ( | ) | const |
Formated text description of the object, controlling osd display.
◆ trackerConfidence()
| float deepstream::ObjectMetadata::trackerConfidence | ( | ) | const |
Confidence level from tracker.
Referenced by deepstream::NvDsKittiDump::generateTrackerKittiDump().
◆ uniqueComponentId()
| unsigned int deepstream::ObjectMetadata::uniqueComponentId | ( | ) | const |
Number to identify the unique component that generates the metadata.
Friends And Related Function Documentation
◆ FrameMetadata
|
friend |
Definition at line 210 of file metadata.hpp.
Field Documentation
◆ data_
|
protectedinherited |
Definition at line 54 of file metadata.hpp.
Referenced by deepstream::Metadata::operator bool(), and deepstream::UserMetadata::operator bool().
The documentation for this class was generated from the following file: