NVIDIA DeepStream SDK API Reference

9.1 Release
sources/includes/nvds_roi_meta.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2021-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
33 #ifndef __NVDS_ROI_META_H__
34 #define __NVDS_ROI_META_H__
35 
36 #include "nvdsmeta.h"
37 
39 #define DS_MAX_POLYGON_POINTS 8
40 
43 
46 
49 
51 typedef GList NvDsClassifierMetaList;
52 
54 typedef GList NvDsUserMetaList;
55 
59 typedef enum
60 {
77 } NvDsDataType;
78 
82 typedef enum
83 {
90 } NvDsUnitType;
91 
95 typedef struct NvDsRoiMeta
96 {
97  /* per roi information */
99 
102 
103  /* Scaled & converted buffer to processing width/height */
105 
106  /* Deepstream frame meta */
108 
112  gdouble scale_ratio_x;
113 
117  gdouble scale_ratio_y;
118 
120  gdouble offset_left;
121 
123  gdouble offset_top;
124 
127 
130 
131  /* Deepstream object meta */
133 
134 } NvDsRoiMeta;
135 
136 #endif
_NvOSD_RectParams
Holds the box parameters of the box to be overlayed.
Definition: sources/includes/nvll_osd_struct.h:145
NvDsRoiMeta
struct NvDsRoiMeta NvDsRoiMeta
Holds Information about ROI Metadata.
NvDsUnitType_Object
@ NvDsUnitType_Object
object mode
Definition: sources/includes/nvds_roi_meta.h:89
NvDsUnitType_ROI
@ NvDsUnitType_ROI
Region of Interests (ROIs)
Definition: sources/includes/nvds_roi_meta.h:87
NvDsDataType_INT32
@ NvDsDataType_INT32
INT32 data type.
Definition: sources/includes/nvds_roi_meta.h:70
NvDsRoiMeta::offset_left
gdouble offset_left
offsets in horizontal direction while scaling
Definition: sources/includes/nvds_roi_meta.h:120
NvDsDataType_INT8
@ NvDsDataType_INT8
INT8 data type.
Definition: sources/includes/nvds_roi_meta.h:66
NvDsDataType_FP16
@ NvDsDataType_FP16
FP16 data type.
Definition: sources/includes/nvds_roi_meta.h:76
NvDsDataType_UINT32
@ NvDsDataType_UINT32
UINT32 data type.
Definition: sources/includes/nvds_roi_meta.h:68
NvDsRoiMeta::converted_buffer
NvBufSurfaceParams * converted_buffer
Definition: sources/includes/nvds_roi_meta.h:104
NvDsDataType_INT64
@ NvDsDataType_INT64
INT64 data type.
Definition: sources/includes/nvds_roi_meta.h:72
NvDsDataType_UINT8
@ NvDsDataType_UINT8
UINT8 data type.
Definition: sources/includes/nvds_roi_meta.h:64
NvBufSurfaceParams
Hold the information of single buffer in the batch.
Definition: sources/includes/nvbufsurface.h:562
NvDsUnitType
NvDsUnitType
Unit Type Fullframe/ROI/Crop Objects.
Definition: sources/includes/nvds_roi_meta.h:82
NvDsClassifierMetaList
GList NvDsClassifierMetaList
classifier meta list
Definition: sources/includes/nvds_roi_meta.h:51
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: sources/includes/nvds_roi_meta.h:112
NvDsUserMetaList
GList NvDsUserMetaList
user meta list
Definition: sources/includes/nvds_roi_meta.h:54
NvDsDataType_UINT64
@ NvDsDataType_UINT64
UINT64 data type.
Definition: sources/includes/nvds_roi_meta.h:74
NvDsRoiMeta::classifier_meta_list
NvDsClassifierMetaList * classifier_meta_list
Holds a pointer to a list of pointers of type NvDsClassifierMeta.
Definition: sources/includes/nvds_roi_meta.h:126
NvDsRoiMeta::roi
NvOSD_RectParams roi
Definition: sources/includes/nvds_roi_meta.h:98
NvDsRoiMeta::offset_top
gdouble offset_top
offsets in vertical direction while scaling
Definition: sources/includes/nvds_roi_meta.h:123
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: sources/includes/nvds_roi_meta.h:117
NvDsRoiMeta::frame_meta
NvDsFrameMeta * frame_meta
Definition: sources/includes/nvds_roi_meta.h:107
NvDsUserMetaList
GList NvDsUserMetaList
Definition: sources/includes/nvdsmeta.h:62
DS_MAX_POLYGON_POINTS
#define DS_MAX_POLYGON_POINTS
max polygon points ; currently not being used
Definition: sources/includes/nvds_roi_meta.h:39
NvDsRoiMeta::roi_polygon
guint roi_polygon[DS_MAX_POLYGON_POINTS][2]
currently not being used
Definition: sources/includes/nvds_roi_meta.h:101
NvDsRoiMeta
Holds Information about ROI Metadata.
Definition: sources/includes/nvds_roi_meta.h:95
NvDsDataType_FP32
@ NvDsDataType_FP32
FP32 data type.
Definition: sources/includes/nvds_roi_meta.h:62
NvDsRoiMeta::roi_user_meta_list
NvDsUserMetaList * roi_user_meta_list
Holds a pointer to a list of pointers of type NvDsUserMeta.
Definition: sources/includes/nvds_roi_meta.h:129
_NvDsFrameMeta
Holds metadata for a frame in a batch.
Definition: sources/includes/nvdsmeta.h:306
nvdsmeta.h
NvDsRoiMeta::object_meta
NvDsObjectMeta * object_meta
Definition: sources/includes/nvds_roi_meta.h:132
NvDsUnitType_FullFrame
@ NvDsUnitType_FullFrame
Full frames.
Definition: sources/includes/nvds_roi_meta.h:85
NvDsClassifierMetaList
GList NvDsClassifierMetaList
Definition: sources/includes/nvdsmeta.h:65
NvDsDataType
NvDsDataType
Data type used for model in infer.
Definition: sources/includes/nvds_roi_meta.h:59
_NvDsObjectMeta
Holds metadata for an object in the frame.
Definition: sources/includes/nvdsmeta.h:365