Detailed Description
Holds information for a single frame.
Iterable via iterators for ObjectMetadata and DisplayMetadata.
Definition at line 417 of file metadata.hpp.
Public Types | |
| typedef std::unique_ptr< AbstractIterator< FrameMetadata > > | Iterator |
Public Member Functions | |
| FrameMetadata (void *data=nullptr) | |
| Constructor through opaque data pointer. More... | |
| virtual | ~FrameMetadata () |
| Destructor. More... | |
| unsigned int | iterate (const std::function< void(const ObjectMetadata &)> &func) const |
| Iterate the object metadata within it. More... | |
| void | initiateIterator (ObjectMetadata::Iterator &) const |
| Get the iterator for object metadata within it. More... | |
| unsigned int | iterate (const std::function< void(const DisplayMetadata &)> &func) const |
| Iterate the display metadata within it. More... | |
| void | initiateIterator (DisplayMetadata::Iterator &) const |
| Get the iterator for display 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... | |
| unsigned int | padIndex () const |
| Index of the pad from which the frame is generated. More... | |
| unsigned int | batchId () const |
| Location the frame in the batch. More... | |
| int | frameNum () const |
| Frame number. More... | |
| unsigned int | sourceId () const |
| Identify the source of the frame, e.g. More... | |
| unsigned int | sourceWidth () const |
| Picture width of the source. More... | |
| unsigned int | sourceHeight () const |
| Picture height of the source. More... | |
| unsigned int | pipelineWidth () const |
| Picture width of the pipeline. More... | |
| unsigned int | pipelineHeight () const |
| Picture height of the pipeline. More... | |
| uint64_t | bufferPTS () const |
| Holds the presentation timestamp (PTS) of the frame. More... | |
| uint64_t | ntpTimestamp () const |
| Holds the ntp timestamp. More... | |
| void | append (const DisplayMetadata &) |
| Append display metadata to the frame. More... | |
| void | append (const UserMetadata &) |
| Append user metadata to the frame. More... | |
| void | append (const ObjectMetadata &) |
| Append object metadata to the frame. More... | |
| virtual | operator bool () |
| operator to check if a metadata is void More... | |
Protected Attributes | |
| void * | data_ |
Friends | |
| class | BatchMetadata |
Member Typedef Documentation
◆ Iterator
| typedef std::unique_ptr<AbstractIterator<FrameMetadata> > deepstream::FrameMetadata::Iterator |
Definition at line 419 of file metadata.hpp.
Constructor & Destructor Documentation
◆ FrameMetadata()
| deepstream::FrameMetadata::FrameMetadata | ( | void * | data = nullptr | ) |
Constructor through opaque data pointer.
By default an empty frame metadata object is created.
◆ ~FrameMetadata()
|
virtual |
Destructor.
Member Function Documentation
◆ append() [1/3]
| void deepstream::FrameMetadata::append | ( | const DisplayMetadata & | ) |
Append display metadata to the frame.
Referenced by deepstream::TensorMetaParser::handleData().
◆ append() [2/3]
| void deepstream::FrameMetadata::append | ( | const ObjectMetadata & | ) |
Append object metadata to the frame.
◆ append() [3/3]
| void deepstream::FrameMetadata::append | ( | const UserMetadata & | ) |
Append user metadata to the frame.
◆ batchId()
| unsigned int deepstream::FrameMetadata::batchId | ( | ) | const |
Location the frame in the batch.
◆ bufferPTS()
| uint64_t deepstream::FrameMetadata::bufferPTS | ( | ) | const |
Holds the presentation timestamp (PTS) of the frame.
◆ frameNum()
| int deepstream::FrameMetadata::frameNum | ( | ) | const |
Frame number.
Referenced by deepstream::ObjectCounter::consume(), and deepstream::TensorMetaParser::handleData().
◆ initiateIterator() [1/3]
| void deepstream::FrameMetadata::initiateIterator | ( | DisplayMetadata::Iterator & | ) | const |
Get the iterator for display metadata within it.
◆ initiateIterator() [2/3]
| void deepstream::FrameMetadata::initiateIterator | ( | ObjectMetadata::Iterator & | ) | const |
Get the iterator for object metadata within it.
Referenced by deepstream::NvDsKittiDump::generateInferenceKittiDump(), deepstream::NvDsKittiDump::generateTrackerKittiDump(), and deepstream::CountMarker::handleData().
◆ initiateIterator() [3/3]
| void deepstream::FrameMetadata::initiateIterator | ( | UserMetadata::Iterator & | , |
| int | meta_type | ||
| ) | const |
Get the iterator for user metadata within it.
◆ iterate() [1/3]
| unsigned int deepstream::FrameMetadata::iterate | ( | const std::function< void(const DisplayMetadata &)> & | func | ) | const |
Iterate the display metadata within it.
◆ iterate() [2/3]
| unsigned int deepstream::FrameMetadata::iterate | ( | const std::function< void(const ObjectMetadata &)> & | func | ) | const |
Iterate the object metadata within it.
Referenced by deepstream::ObjectCounter::consume(), and deepstream::TensorMetaParser::handleData().
◆ iterate() [3/3]
| unsigned int deepstream::FrameMetadata::iterate | ( | const std::function< void(const UserMetadata &)> & | func, |
| int | meta_type | ||
| ) | const |
Iterate the user metadata within it.
◆ ntpTimestamp()
| uint64_t deepstream::FrameMetadata::ntpTimestamp | ( | ) | const |
Holds the ntp timestamp.
◆ 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_.
◆ padIndex()
| unsigned int deepstream::FrameMetadata::padIndex | ( | ) | const |
Index of the pad from which the frame is generated.
Referenced by deepstream::ObjectCounter::consume(), deepstream::TensorMetaParser::handleData(), and deepstream::FPSCounter::handleData().
◆ pipelineHeight()
| unsigned int deepstream::FrameMetadata::pipelineHeight | ( | ) | const |
Picture height of the pipeline.
◆ pipelineWidth()
| unsigned int deepstream::FrameMetadata::pipelineWidth | ( | ) | const |
Picture width of the pipeline.
◆ sourceHeight()
| unsigned int deepstream::FrameMetadata::sourceHeight | ( | ) | const |
Picture height of the source.
◆ sourceId()
| unsigned int deepstream::FrameMetadata::sourceId | ( | ) | const |
Identify the source of the frame, e.g.
camera ID
◆ sourceWidth()
| unsigned int deepstream::FrameMetadata::sourceWidth | ( | ) | const |
Picture width of the source.
Friends And Related Function Documentation
◆ BatchMetadata
|
friend |
Definition at line 476 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: