NVIDIA DeepStream SDK API Reference

6.3 Release
nvds_roi_meta.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
38 #ifndef __NVDS_ROI_META_H__
39 #define __NVDS_ROI_META_H__
40 
41 #include "nvdsmeta.h"
42 
44 #define DS_MAX_POLYGON_POINTS 8
45 
48 
51 
54 
56 typedef GList NvDsClassifierMetaList;
57 
59 typedef GList NvDsUserMetaList;
60 
64 typedef enum
65 {
78 } NvDsDataType;
79 
83 typedef enum
84 {
91 } NvDsUnitType;
92 
96 typedef struct NvDsRoiMeta
97 {
98  /* per roi information */
100 
103 
104  /* Scaled & converted buffer to processing width/height */
106 
107  /* Deepstream frame meta */
109 
113  gdouble scale_ratio_x;
114 
118  gdouble scale_ratio_y;
119 
121  gdouble offset_left;
122 
124  gdouble offset_top;
125 
128 
131 
132  /* Deepstream object meta */
134 
135 } NvDsRoiMeta;
136 
137 #endif
_NvOSD_RectParams
Holds the box parameters of the box to be overlayed.
Definition: nvll_osd_struct.h:139
NvDsRoiMeta
struct NvDsRoiMeta NvDsRoiMeta
Holds Information about ROI Metadata.
NvDsRoiMeta::object_meta
NvDsObjectMeta * object_meta
Definition: nvds_roi_meta.h:133
NvDsUnitType_Object
@ NvDsUnitType_Object
object mode
Definition: nvds_roi_meta.h:90
NvDsUnitType_ROI
@ NvDsUnitType_ROI
Region of Interests (ROIs)
Definition: nvds_roi_meta.h:88
NvDsDataType_INT32
@ NvDsDataType_INT32
INT32 data type.
Definition: nvds_roi_meta.h:75
NvDsRoiMeta::offset_left
gdouble offset_left
offsets in horizontal direction while scaling
Definition: nvds_roi_meta.h:121
NvDsDataType_INT8
@ NvDsDataType_INT8
INT8 data type.
Definition: nvds_roi_meta.h:71
NvDsDataType_FP16
@ NvDsDataType_FP16
FP16 data type.
Definition: nvds_roi_meta.h:77
NvDsDataType_UINT32
@ NvDsDataType_UINT32
UINT32 data type.
Definition: nvds_roi_meta.h:73
NvDsDataType_UINT8
@ NvDsDataType_UINT8
UINT8 data type.
Definition: nvds_roi_meta.h:69
NvDsRoiMeta::roi_user_meta_list
NvDsUserMetaList * roi_user_meta_list
Holds a pointer to a list of pointers of type NvDsUserMeta.
Definition: nvds_roi_meta.h:130
NvDsRoiMeta::classifier_meta_list
NvDsClassifierMetaList * classifier_meta_list
Holds a pointer to a list of pointers of type NvDsClassifierMeta.
Definition: nvds_roi_meta.h:127
NvBufSurfaceParams
Hold the information of single buffer in the batch.
Definition: nvbufsurface.h:468
NvDsUnitType
NvDsUnitType
Unit Type Fullframe/ROI/Crop Objects.
Definition: nvds_roi_meta.h:83
NvDsClassifierMetaList
GList NvDsClassifierMetaList
classifier meta list
Definition: nvds_roi_meta.h:56
NvDsRoiMeta::scale_ratio_x
gdouble scale_ratio_x
Ratio by which the frame/ROI crop was scaled in horizontal direction Required when scaling co-ordinat...
Definition: nvds_roi_meta.h:113
NvDsUserMetaList
GList NvDsUserMetaList
user meta list
Definition: nvds_roi_meta.h:59
NvDsRoiMeta::frame_meta
NvDsFrameMeta * frame_meta
Definition: nvds_roi_meta.h:108
NvDsRoiMeta::roi
NvOSD_RectParams roi
Definition: nvds_roi_meta.h:99
NvDsRoiMeta::offset_top
gdouble offset_top
offsets in vertical direction while scaling
Definition: nvds_roi_meta.h:124
NvDsRoiMeta::scale_ratio_y
gdouble scale_ratio_y
Ratio by which the frame/ROI crop was scaled in vertical direction Required when scaling co-ordinates...
Definition: nvds_roi_meta.h:118
NvDsRoiMeta::roi_polygon
guint roi_polygon[DS_MAX_POLYGON_POINTS][2]
currently not being used
Definition: nvds_roi_meta.h:102
DS_MAX_POLYGON_POINTS
#define DS_MAX_POLYGON_POINTS
max polygon points ; currently not being used
Definition: nvds_roi_meta.h:44
NvDsRoiMeta::converted_buffer
NvBufSurfaceParams * converted_buffer
Definition: nvds_roi_meta.h:105
NvDsRoiMeta
Holds Information about ROI Metadata.
Definition: nvds_roi_meta.h:96
NvDsDataType_FP32
@ NvDsDataType_FP32
FP32 data type.
Definition: nvds_roi_meta.h:67
_NvDsFrameMeta
Holds metadata for a frame in a batch.
Definition: nvdsmeta.h:269
nvdsmeta.h
NvDsUnitType_FullFrame
@ NvDsUnitType_FullFrame
Full frames.
Definition: nvds_roi_meta.h:86
NvDsDataType
NvDsDataType
Data type used for model in infer.
Definition: nvds_roi_meta.h:64
_NvDsObjectMeta
Holds metadata for an object in the frame.
Definition: nvdsmeta.h:327