NVIDIA DeepStream SDK API Reference

9.0 Release
Surface properties

Detailed Description

Surface properties which can be different for every surface. These are specified under [surface<n>] group.

Macros

#define CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX   "surface"
 Identifier for [surface<n>] group. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_INDEX   "surface-index"
 An index that distinguishes surfaces of the same projection type. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE   "projection-type"
 Surface projection of type "NvDsSurfaceType". More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_WIDTH   "width"
 Dewarped surface width. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT   "height"
 Dewarped surface height. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE   "top-angle"
 Desired Top field of view angle, in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE   "bottom-angle"
 Desired Bottom field of view angle, in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_PITCH   "pitch"
 View selection parameter pitch in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_YAW   "yaw"
 View selection parameter yaw in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROLL   "roll"
 View selection parameter roll in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH   "focal-length"
 Array of 2 numbers. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE   "cuda-address-mode"
 Cuda Texture addressing mode. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES   "rot-axes"
 A four-element array of three-character C-strings terminated by \0 that represent the dequence of rotation axes about which the view gets rotated based on rotation angles specified. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_CONTROL   "control"
 Projection-specific controls for Panini, Stereographic and Pushbroom projections. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX   "rot-matrix"
 Conventional 9 element rotation matrix. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW   "src-fov"
 used to compute focal-length if the latter is not provided More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION   "distortion"
 distortion: up to 5 distortion parameters More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0   "src-x0"
 source principal point X More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0   "src-y0"
 source principal point Y More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH   "dst-focal-length"
 Destination focal length : Useful to introduce zoom-in and zoom-out effect. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT   "dst-principal-point"
 Destination principal point corresponding to ""dst-focal-length". More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX   "surface"
 Identifier for [surface<n>] group. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_INDEX   "surface-index"
 An index that distinguishes surfaces of the same projection type. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE   "projection-type"
 Surface projection of type "NvDsSurfaceType". More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_WIDTH   "width"
 Dewarped surface width. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT   "height"
 Dewarped surface height. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE   "top-angle"
 Desired Top field of view angle, in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE   "bottom-angle"
 Desired Bottom field of view angle, in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_PITCH   "pitch"
 View selection parameter pitch in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_YAW   "yaw"
 View selection parameter yaw in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROLL   "roll"
 View selection parameter roll in degrees. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH   "focal-length"
 Array of 2 numbers. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE   "cuda-address-mode"
 Cuda Texture addressing mode. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES   "rot-axes"
 A four-element array of three-character C-strings terminated by \0 that represent the dequence of rotation axes about which the view gets rotated based on rotation angles specified. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_CONTROL   "control"
 Projection-specific controls for Panini, Stereographic and Pushbroom projections. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX   "rot-matrix"
 Conventional 9 element rotation matrix. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW   "src-fov"
 used to compute focal-length if the latter is not provided More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION   "distortion"
 distortion: up to 5 distortion parameters More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0   "src-x0"
 source principal point X More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0   "src-y0"
 source principal point Y More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH   "dst-focal-length"
 Destination focal length : Useful to introduce zoom-in and zoom-out effect. More...
 
#define CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT   "dst-principal-point"
 Destination principal point corresponding to ""dst-focal-length". More...
 

Macro Definition Documentation

◆ CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE   "cuda-address-mode"

Cuda Texture addressing mode.

Definition at line 72 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ADDRESS_MODE   "cuda-address-mode"

Cuda Texture addressing mode.

Definition at line 72 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX   "surface"

Identifier for [surface<n>] group.

Definition at line 61 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ATTRS_PREFIX   "surface"

Identifier for [surface<n>] group.

Definition at line 61 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE   "bottom-angle"

Desired Bottom field of view angle, in degrees.

Definition at line 67 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_BOTTOM_ANGLE   "bottom-angle"

Desired Bottom field of view angle, in degrees.

Definition at line 67 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_CONTROL [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_CONTROL   "control"

Projection-specific controls for Panini, Stereographic and Pushbroom projections.

Definition at line 76 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_CONTROL [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_CONTROL   "control"

Projection-specific controls for Panini, Stereographic and Pushbroom projections.

Definition at line 76 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION   "distortion"

distortion: up to 5 distortion parameters

Definition at line 80 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DISTORTION   "distortion"

distortion: up to 5 distortion parameters

Definition at line 80 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH   "dst-focal-length"

Destination focal length : Useful to introduce zoom-in and zoom-out effect.

Definition at line 85 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DST_FOCAL_LENGTH   "dst-focal-length"

Destination focal length : Useful to introduce zoom-in and zoom-out effect.

Definition at line 85 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT   "dst-principal-point"

Destination principal point corresponding to ""dst-focal-length".

Definition at line 87 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_DST_PRINCIPAL_POINT   "dst-principal-point"

Destination principal point corresponding to ""dst-focal-length".

Definition at line 87 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW   "src-fov"

used to compute focal-length if the latter is not provided

Definition at line 79 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_FIELD_OF_VIEW   "src-fov"

used to compute focal-length if the latter is not provided

Definition at line 79 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH   "focal-length"

Array of 2 numbers.

X & Y focal length of camera lens

Definition at line 71 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_FOCAL_LENGTH   "focal-length"

Array of 2 numbers.

X & Y focal length of camera lens

Definition at line 71 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT   "height"

Dewarped surface height.

Definition at line 65 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_HEIGHT   "height"

Dewarped surface height.

Definition at line 65 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_INDEX [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_INDEX   "surface-index"

An index that distinguishes surfaces of the same projection type.

Definition at line 62 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_INDEX [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_INDEX   "surface-index"

An index that distinguishes surfaces of the same projection type.

Definition at line 62 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_PITCH [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_PITCH   "pitch"

View selection parameter pitch in degrees.

Corresponds to X axis

Definition at line 68 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_PITCH [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_PITCH   "pitch"

View selection parameter pitch in degrees.

Corresponds to X axis

Definition at line 68 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE   "projection-type"

Surface projection of type "NvDsSurfaceType".

Definition at line 63 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_PROJECTION_TYPE   "projection-type"

Surface projection of type "NvDsSurfaceType".

Definition at line 63 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROLL [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROLL   "roll"

View selection parameter roll in degrees.

Corresponds to Z axis

Definition at line 70 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROLL [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROLL   "roll"

View selection parameter roll in degrees.

Corresponds to Z axis

Definition at line 70 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES   "rot-axes"

A four-element array of three-character C-strings terminated by \0 that represent the dequence of rotation axes about which the view gets rotated based on rotation angles specified.

Definition at line 75 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_AXES   "rot-axes"

A four-element array of three-character C-strings terminated by \0 that represent the dequence of rotation axes about which the view gets rotated based on rotation angles specified.

Definition at line 75 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX   "rot-matrix"

Conventional 9 element rotation matrix.

Definition at line 77 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_ROTATION_MATRIX   "rot-matrix"

Conventional 9 element rotation matrix.

Definition at line 77 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0 [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0   "src-x0"

source principal point X

Definition at line 81 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0 [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_X0   "src-x0"

source principal point X

Definition at line 81 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0 [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0   "src-y0"

source principal point Y

Definition at line 82 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0 [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_SRC_Y0   "src-y0"

source principal point Y

Definition at line 82 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE   "top-angle"

Desired Top field of view angle, in degrees.

Definition at line 66 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_TOP_ANGLE   "top-angle"

Desired Top field of view angle, in degrees.

Definition at line 66 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_WIDTH [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_WIDTH   "width"

Dewarped surface width.

Definition at line 64 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_WIDTH [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_WIDTH   "width"

Dewarped surface width.

Definition at line 64 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_YAW [1/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_YAW   "yaw"

View selection parameter yaw in degrees.

Corresponds to Y axis

Definition at line 69 of file 9.0/sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.

◆ CONFIG_GROUP_DEWARPER_SURFACE_YAW [2/2]

#define CONFIG_GROUP_DEWARPER_SURFACE_YAW   "yaw"

View selection parameter yaw in degrees.

Corresponds to Y axis

Definition at line 69 of file sources/gst-plugins/gst-nvdewarper/nvdewarper_property_parser.h.