NVIDIA DeepStream SDK API Reference

9.0 Release
Pre-Process Metadata

Detailed Description

Specifies metadata concerning ROIs used in nvdspreprocess plugin.

Data Structures

struct  NvDsRoiMeta
 Holds Information about ROI Metadata. More...
 

Macros

#define DS_MAX_POLYGON_POINTS   8
 max polygon points ; currently not being used More...
 
#define DS_MAX_POLYGON_POINTS   8
 max polygon points ; currently not being used More...
 

Typedefs

typedef struct NvBufSurfaceParams NvBufSurfaceParams
 DS NvBufSurfaceParams. More...
 
typedef struct _NvDsFrameMeta NvDsFrameMeta
 DS NvDsFrameMeta. More...
 
typedef struct _NvDsObjectMeta NvDsObjectMeta
 DS NvDsObjectMeta. More...
 
typedef GList NvDsClassifierMetaList
 classifier meta list More...
 
typedef GList NvDsUserMetaList
 user meta list More...
 
typedef struct NvDsRoiMeta NvDsRoiMeta
 Holds Information about ROI Metadata. More...
 
typedef struct NvBufSurfaceParams NvBufSurfaceParams
 DS NvBufSurfaceParams. More...
 
typedef struct _NvDsFrameMeta NvDsFrameMeta
 DS NvDsFrameMeta. More...
 
typedef struct _NvDsObjectMeta NvDsObjectMeta
 DS NvDsObjectMeta. More...
 
typedef GList NvDsClassifierMetaList
 classifier meta list More...
 
typedef GList NvDsUserMetaList
 user meta list More...
 
typedef struct NvDsRoiMeta NvDsRoiMeta
 Holds Information about ROI Metadata. More...
 

Enumerations

enum  NvDsDataType {
  NvDsDataType_FP32,
  NvDsDataType_UINT8,
  NvDsDataType_INT8,
  NvDsDataType_UINT32,
  NvDsDataType_INT32,
  NvDsDataType_INT64,
  NvDsDataType_UINT64,
  NvDsDataType_FP16,
  NvDsDataType_FP32,
  NvDsDataType_UINT8,
  NvDsDataType_INT8,
  NvDsDataType_UINT32,
  NvDsDataType_INT32,
  NvDsDataType_INT64,
  NvDsDataType_UINT64,
  NvDsDataType_FP16
}
 Data type used for model in infer. More...
 
enum  NvDsUnitType {
  NvDsUnitType_FullFrame = 0,
  NvDsUnitType_ROI,
  NvDsUnitType_Object,
  NvDsUnitType_FullFrame = 0,
  NvDsUnitType_ROI,
  NvDsUnitType_Object
}
 Unit Type Fullframe/ROI/Crop Objects. More...
 
enum  NvDsDataType {
  NvDsDataType_FP32,
  NvDsDataType_UINT8,
  NvDsDataType_INT8,
  NvDsDataType_UINT32,
  NvDsDataType_INT32,
  NvDsDataType_INT64,
  NvDsDataType_UINT64,
  NvDsDataType_FP16,
  NvDsDataType_FP32,
  NvDsDataType_UINT8,
  NvDsDataType_INT8,
  NvDsDataType_UINT32,
  NvDsDataType_INT32,
  NvDsDataType_INT64,
  NvDsDataType_UINT64,
  NvDsDataType_FP16
}
 Data type used for model in infer. More...
 
enum  NvDsUnitType {
  NvDsUnitType_FullFrame = 0,
  NvDsUnitType_ROI,
  NvDsUnitType_Object,
  NvDsUnitType_FullFrame = 0,
  NvDsUnitType_ROI,
  NvDsUnitType_Object
}
 Unit Type Fullframe/ROI/Crop Objects. More...
 

Variables

NvOSD_RectParams NvDsRoiMeta::roi
 
guint NvDsRoiMeta::roi_polygon [DS_MAX_POLYGON_POINTS][2]
 currently not being used More...
 
NvBufSurfaceParamsNvDsRoiMeta::converted_buffer
 
NvDsFrameMetaNvDsRoiMeta::frame_meta
 
gdouble NvDsRoiMeta::scale_ratio_x
 Ratio by which the frame/ROI crop was scaled in horizontal direction Required when scaling co-ordinates/sizes in metadata back to input resolution. More...
 
gdouble NvDsRoiMeta::scale_ratio_y
 Ratio by which the frame/ROI crop was scaled in vertical direction Required when scaling co-ordinates/sizes in metadata back to input resolution. More...
 
gdouble NvDsRoiMeta::offset_left
 offsets in horizontal direction while scaling More...
 
gdouble NvDsRoiMeta::offset_top
 offsets in vertical direction while scaling More...
 
NvDsClassifierMetaListNvDsRoiMeta::classifier_meta_list
 Holds a pointer to a list of pointers of type NvDsClassifierMeta. More...
 
NvDsUserMetaListNvDsRoiMeta::roi_user_meta_list
 Holds a pointer to a list of pointers of type NvDsUserMeta. More...
 
NvDsObjectMetaNvDsRoiMeta::object_meta
 

Macro Definition Documentation

◆ DS_MAX_POLYGON_POINTS [1/2]

#define DS_MAX_POLYGON_POINTS   8

max polygon points ; currently not being used

Definition at line 34 of file sources/includes/nvds_roi_meta.h.

◆ DS_MAX_POLYGON_POINTS [2/2]

#define DS_MAX_POLYGON_POINTS   8

max polygon points ; currently not being used

Definition at line 34 of file 9.0/sources/includes/nvds_roi_meta.h.

Typedef Documentation

◆ NvBufSurfaceParams [1/2]

◆ NvBufSurfaceParams [2/2]

◆ NvDsClassifierMetaList [1/2]

typedef GList NvDsClassifierMetaList

classifier meta list

Definition at line 46 of file sources/includes/nvds_roi_meta.h.

◆ NvDsClassifierMetaList [2/2]

typedef GList NvDsClassifierMetaList

classifier meta list

Definition at line 46 of file 9.0/sources/includes/nvds_roi_meta.h.

◆ NvDsFrameMeta [1/2]

typedef struct _NvDsFrameMeta NvDsFrameMeta

DS NvDsFrameMeta.

Definition at line 40 of file sources/includes/nvds_roi_meta.h.

◆ NvDsFrameMeta [2/2]

typedef struct _NvDsFrameMeta NvDsFrameMeta

DS NvDsFrameMeta.

Definition at line 40 of file 9.0/sources/includes/nvds_roi_meta.h.

◆ NvDsObjectMeta [1/2]

DS NvDsObjectMeta.

Definition at line 43 of file 9.0/sources/includes/nvds_roi_meta.h.

◆ NvDsObjectMeta [2/2]

DS NvDsObjectMeta.

Definition at line 43 of file sources/includes/nvds_roi_meta.h.

◆ NvDsRoiMeta [1/2]

typedef struct NvDsRoiMeta NvDsRoiMeta

Holds Information about ROI Metadata.

◆ NvDsRoiMeta [2/2]

typedef struct NvDsRoiMeta NvDsRoiMeta

Holds Information about ROI Metadata.

◆ NvDsUserMetaList [1/2]

typedef GList NvDsUserMetaList

user meta list

Definition at line 49 of file sources/includes/nvds_roi_meta.h.

◆ NvDsUserMetaList [2/2]

typedef GList NvDsUserMetaList

user meta list

Definition at line 49 of file 9.0/sources/includes/nvds_roi_meta.h.

Enumeration Type Documentation

◆ NvDsDataType [1/2]

Data type used for model in infer.

Enumerator
NvDsDataType_FP32 

FP32 data type.

NvDsDataType_UINT8 

UINT8 data type.

NvDsDataType_INT8 

INT8 data type.

NvDsDataType_UINT32 

UINT32 data type.

NvDsDataType_INT32 

INT32 data type.

NvDsDataType_INT64 

INT64 data type.

NvDsDataType_UINT64 

UINT64 data type.

NvDsDataType_FP16 

FP16 data type.

NvDsDataType_FP32 

FP32 data type.

NvDsDataType_UINT8 

UINT8 data type.

NvDsDataType_INT8 

INT8 data type.

NvDsDataType_UINT32 

UINT32 data type.

NvDsDataType_INT32 

INT32 data type.

NvDsDataType_INT64 

INT64 data type.

NvDsDataType_UINT64 

UINT64 data type.

NvDsDataType_FP16 

FP16 data type.

Definition at line 54 of file sources/includes/nvds_roi_meta.h.

◆ NvDsDataType [2/2]

Data type used for model in infer.

Enumerator
NvDsDataType_FP32 

FP32 data type.

NvDsDataType_UINT8 

UINT8 data type.

NvDsDataType_INT8 

INT8 data type.

NvDsDataType_UINT32 

UINT32 data type.

NvDsDataType_INT32 

INT32 data type.

NvDsDataType_INT64 

INT64 data type.

NvDsDataType_UINT64 

UINT64 data type.

NvDsDataType_FP16 

FP16 data type.

NvDsDataType_FP32 

FP32 data type.

NvDsDataType_UINT8 

UINT8 data type.

NvDsDataType_INT8 

INT8 data type.

NvDsDataType_UINT32 

UINT32 data type.

NvDsDataType_INT32 

INT32 data type.

NvDsDataType_INT64 

INT64 data type.

NvDsDataType_UINT64 

UINT64 data type.

NvDsDataType_FP16 

FP16 data type.

Definition at line 54 of file 9.0/sources/includes/nvds_roi_meta.h.

◆ NvDsUnitType [1/2]

Unit Type Fullframe/ROI/Crop Objects.

Enumerator
NvDsUnitType_FullFrame 

Full frames.

NvDsUnitType_ROI 

Region of Interests (ROIs)

NvDsUnitType_Object 

object mode

NvDsUnitType_FullFrame 

Full frames.

NvDsUnitType_ROI 

Region of Interests (ROIs)

NvDsUnitType_Object 

object mode

Definition at line 77 of file 9.0/sources/includes/nvds_roi_meta.h.

◆ NvDsUnitType [2/2]

Unit Type Fullframe/ROI/Crop Objects.

Enumerator
NvDsUnitType_FullFrame 

Full frames.

NvDsUnitType_ROI 

Region of Interests (ROIs)

NvDsUnitType_Object 

object mode

NvDsUnitType_FullFrame 

Full frames.

NvDsUnitType_ROI 

Region of Interests (ROIs)

NvDsUnitType_Object 

object mode

Definition at line 77 of file sources/includes/nvds_roi_meta.h.

Variable Documentation

◆ classifier_meta_list

NvDsClassifierMetaList * NvDsRoiMeta::classifier_meta_list

Holds a pointer to a list of pointers of type NvDsClassifierMeta.

Definition at line 121 of file sources/includes/nvds_roi_meta.h.

◆ converted_buffer

NvBufSurfaceParams * NvDsRoiMeta::converted_buffer

Definition at line 99 of file sources/includes/nvds_roi_meta.h.

◆ frame_meta

NvDsFrameMeta * NvDsRoiMeta::frame_meta

Definition at line 102 of file sources/includes/nvds_roi_meta.h.

◆ object_meta

NvDsObjectMeta * NvDsRoiMeta::object_meta

Definition at line 127 of file sources/includes/nvds_roi_meta.h.

◆ offset_left

gdouble NvDsRoiMeta::offset_left

offsets in horizontal direction while scaling

Definition at line 115 of file sources/includes/nvds_roi_meta.h.

◆ offset_top

gdouble NvDsRoiMeta::offset_top

offsets in vertical direction while scaling

Definition at line 118 of file sources/includes/nvds_roi_meta.h.

◆ roi

NvOSD_RectParams NvDsRoiMeta::roi

Definition at line 93 of file sources/includes/nvds_roi_meta.h.

◆ roi_polygon

guint NvDsRoiMeta::roi_polygon

currently not being used

Definition at line 96 of file sources/includes/nvds_roi_meta.h.

◆ roi_user_meta_list

NvDsUserMetaList * NvDsRoiMeta::roi_user_meta_list

Holds a pointer to a list of pointers of type NvDsUserMeta.

Definition at line 124 of file sources/includes/nvds_roi_meta.h.

◆ scale_ratio_x

gdouble NvDsRoiMeta::scale_ratio_x

Ratio by which the frame/ROI crop was scaled in horizontal direction Required when scaling co-ordinates/sizes in metadata back to input resolution.

Definition at line 107 of file sources/includes/nvds_roi_meta.h.

◆ scale_ratio_y

gdouble NvDsRoiMeta::scale_ratio_y

Ratio by which the frame/ROI crop was scaled in vertical direction Required when scaling co-ordinates/sizes in metadata back to input resolution.

Definition at line 112 of file sources/includes/nvds_roi_meta.h.