NVIDIA DeepStream SDK API Reference

8.0 Release
API

Detailed Description

Defines the DeepStream tracker metadata fusion API.

Data Structures

struct  _NvMOTMFConfig
 
struct  _NvMOTMFConfigResponse
 Holds a tracker's configuration status. More...
 
struct  _NvMOTMFTrackerFusedData
 Tracker misc data. More...
 
struct  _NvMOTMFTrackedObjMeta
 Holds all the input metadata of a video chunk to be processed. More...
 
struct  _NvMOTMFQuery
 

Typedefs

typedef uint64_t NvMOTObjectId
 
typedef uint32_t NvMOTFrameNum
 
typedef std::map< NvMOTObjectId, std::map< NvMOTFrameNum, uint32_t > > NvMOTReidEmbeddingsList
 
typedef std::map< NvMOTObjectId, NvMOTObjectIdNvMOTMFObjectIdMap
 
typedef struct _NvMOTMFConfig NvMOTMFConfig
 
typedef struct _NvMOTMFConfigResponse NvMOTMFConfigResponse
 Holds a tracker's configuration status. More...
 
typedef struct _NvMOTMFTrackerFusedData NvMOTMFTrackerFusedData
 Tracker misc data. More...
 
typedef struct _NvMOTMFTrackedObjMeta NvMOTMFTrackedObjMeta
 Holds all the input metadata of a video chunk to be processed. More...
 
typedef struct NvMOTMFContext * NvMOTMFContextHandle
 
typedef struct _NvMOTMFQuery NvMOTMFQuery
 

Enumerations

enum  NvMOTMFConfigStatus {
  NvMOTMFConfigStatus_OK,
  NvMOTMFConfigStatus_Error,
  NvMOTMFConfigStatus_Invalid,
  NvMOTMFConfigStatus_Unsupported
}
 Defines configuration request return codes. More...
 
enum  NvMOTMFStatus {
  NvMOTMFStatus_OK,
  NvMOTMFStatus_Error,
  NvMOTMFStatus_Invalid_Path
}
 

Functions

NvMOTMFStatus NvMOTMF_Init (NvMOTMFConfig *pConfigIn, NvMOTMFContextHandle *pContextHandle, NvMOTMFConfigResponse *pConfigResponse)
 Initializes the fusion context. More...
 
void NvMOTMF_DeInit (NvMOTMFContextHandle contextHandle)
 Deinitializes fusion context. More...
 
NvMOTMFStatus NvMOTMF_Process (NvMOTMFContextHandle contextHandle, NvMOTMFTrackedObjMeta *pVideoChunk, NvMOTMFObjectIdMap &ipOpObjectIdMap)
 Processes a video chunk. More...
 
NvMOTMFStatus NvMOTMF_RetrieveFusedData (NvMOTMFContextHandle contextHandle, NvMOTMFTrackerFusedData *pTrackerMiscData, bool eos)
 Retrieve the fused data. More...
 
NvMOTMFStatus NvMOTMF_Query (NvMOTMFQuery *pQuery)
 Query metadata fusion lib capabilities and requirements. More...
 

Typedef Documentation

◆ NvMOTFrameNum

typedef uint32_t NvMOTFrameNum

Definition at line 46 of file nvdsmotmetafusion.h.

◆ NvMOTMFConfig

typedef struct _NvMOTMFConfig NvMOTMFConfig

◆ NvMOTMFConfigResponse

Holds a tracker's configuration status.

Holds the status of a configuration request; includes both summary and per-configuration status.

◆ NvMOTMFContextHandle

typedef struct NvMOTMFContext* NvMOTMFContextHandle

Definition at line 136 of file nvdsmotmetafusion.h.

◆ NvMOTMFObjectIdMap

Definition at line 49 of file nvdsmotmetafusion.h.

◆ NvMOTMFQuery

typedef struct _NvMOTMFQuery NvMOTMFQuery

◆ NvMOTMFTrackedObjMeta

Holds all the input metadata of a video chunk to be processed.

◆ NvMOTMFTrackerFusedData

Tracker misc data.

◆ NvMOTObjectId

typedef uint64_t NvMOTObjectId

Definition at line 45 of file nvdsmotmetafusion.h.

◆ NvMOTReidEmbeddingsList

typedef std::map<NvMOTObjectId, std::map<NvMOTFrameNum, uint32_t> > NvMOTReidEmbeddingsList

Definition at line 48 of file nvdsmotmetafusion.h.

Enumeration Type Documentation

◆ NvMOTMFConfigStatus

Defines configuration request return codes.

Enumerator
NvMOTMFConfigStatus_OK 
NvMOTMFConfigStatus_Error 
NvMOTMFConfigStatus_Invalid 
NvMOTMFConfigStatus_Unsupported 

Definition at line 68 of file nvdsmotmetafusion.h.

◆ NvMOTMFStatus

Enumerator
NvMOTMFStatus_OK 
NvMOTMFStatus_Error 
NvMOTMFStatus_Invalid_Path 

Definition at line 98 of file nvdsmotmetafusion.h.

Function Documentation

◆ NvMOTMF_DeInit()

void NvMOTMF_DeInit ( NvMOTMFContextHandle  contextHandle)

Deinitializes fusion context.

The specified context is retired and may not be used again.

Parameters
contextHandleThe handle for the fusion context to be retired.

◆ NvMOTMF_Init()

NvMOTMFStatus NvMOTMF_Init ( NvMOTMFConfig pConfigIn,
NvMOTMFContextHandle pContextHandle,
NvMOTMFConfigResponse pConfigResponse 
)

Initializes the fusion context.

If successful, the context is configured as specified by pConfigIn.

Parameters
[in]pConfigInA pointer to to a structure specifying the configuration.
[out]pContextHandleA pointer to a handle for the fusion context. The fusion context is created and owned by the fusion module. The returned context handle must be included in all subsequent calls for the specified stream.
[out]pConfigResponseA pointer to a structure that describes the operation's status.
Returns
The outcome of the initialization attempt.

◆ NvMOTMF_Process()

NvMOTMFStatus NvMOTMF_Process ( NvMOTMFContextHandle  contextHandle,
NvMOTMFTrackedObjMeta pVideoChunk,
NvMOTMFObjectIdMap ipOpObjectIdMap 
)

Processes a video chunk.

Given a context and a video chunk metadata, processes the metadata chunk. Once processed, each chunk becomes part of the history and will be used for processing all the future video chunks

Parameters
[in]contextHandleA context handle obtained from NvMOTInit().
[in]pVideoChunkA pointer to the metadata of the chunk to be processed.
[out]ipOpObjectIdMapReference to a map to return input object id to output object id mapping
Returns
The status of chunk processing.

◆ NvMOTMF_Query()

NvMOTMFStatus NvMOTMF_Query ( NvMOTMFQuery pQuery)

Query metadata fusion lib capabilities and requirements.

Answer query for this metadata fusion lib's capabilities and requirements.

Parameters
[out]pQueryA pointer to a query structure to be filled by the library.
Returns
Status of the query.

◆ NvMOTMF_RetrieveFusedData()

NvMOTMFStatus NvMOTMF_RetrieveFusedData ( NvMOTMFContextHandle  contextHandle,
NvMOTMFTrackerFusedData pTrackerMiscData,
bool  eos 
)

Retrieve the fused data.

Given a context retrieve the fused tracklets The fused tracklets are returned in "pFusedTracksStream" If eos = false : only the terminated tracklets are returned If eos = true, all the active tracklets are terminated and returned

Parameters
[in]contextHandleThe context handle obtained from NvMOTInit()
[out]pTrackerMiscDataMisc data from low level tracker that contains the fused tracklet data in pFusedTracksStream
Returns
Status of the call