VisionWorks Toolkit Reference

April 8, 2016 | 1.4 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NVX CUDA Data Types API

Detailed Description

This section includes the CUDA data types.

Note
This is CUDA API for VisionWorks documentation. For Core CUDA API documentation, see here.

Data Structures

struct  nvxcu_array_t
 Base structure for array object. More...
 
struct  nvxcu_border_t
 Defines a border extrapolation behavior. More...
 
struct  nvxcu_coordinates2d_t
 Defines a 2D coordinates data structure. More...
 
struct  nvxcu_coordinates3d_t
 Defines a 3D coordinates data structure. More...
 
struct  nvxcu_exec_target_t
 Base structure for execution target. More...
 
struct  nvxcu_image_t
 Base structure for image object. More...
 
struct  nvxcu_keypoint_t
 Defines a keypoint data structure with integer coordinates. More...
 
struct  nvxcu_keypointf_t
 Defines a keypoint data structure with float coordinates. More...
 
struct  nvxcu_pitch_linear_image_t
 Image object represented as pitch linear CUDA buffer. More...
 
struct  nvxcu_pitch_linear_image_t.planes
 
struct  nvxcu_pitch_linear_pyramid_t
 Pitch linear pyramid object. More...
 
union  nvxcu_pixel_value_t
 Defines the value of a pixel for any image format. More...
 
struct  nvxcu_plain_array_t
 Array object represented as plain CUDA device memory. More...
 
struct  nvxcu_point2f_t
 Defines a 2D point data structure (float coordinates). More...
 
struct  nvxcu_point3f_t
 Defines a 3D point data structure (float coordinates). More...
 
struct  nvxcu_point4f_t
 Defines a 4D point data structure (float coordinates). More...
 
struct  nvxcu_pyramid_t
 Base structure for pyramid object. More...
 
struct  nvxcu_rectangle_t
 Defines a rectangle data structure. More...
 
struct  nvxcu_stream_exec_target_t
 CUDA stream execution target. More...
 
struct  nvxcu_tmp_buf_size_t
 Defines the size of temporary buffers. More...
 
struct  nvxcu_tmp_buf_t
 Defines a pointers to temporary buffers. More...
 
struct  nvxcu_uniform_image_t
 Image object filled with uniform value. More...
 

Macros

#define NVXCU_DF_IMAGE(a, b, c, d)   ((a) | (b << 8) | (c << 16) | (d << 24))
 Converts a set of four chars into a single uint32_t value. More...
 
#define NVXCU_ENUM_BASE(v, id)   (((v) << 20) | (id << 12))
 Calculates the base value for a specific enumeration type. More...
 
#define NVXCU_NB_MAX_PLANES   (4u)
 Defines the maximum number of planes in an image object. More...
 
#define NVXCU_SCALE_PYRAMID_HALF   (0.5f)
 Half-scale pyramid. More...
 
#define NVXCU_SCALE_PYRAMID_ORB   (0.8408964f)
 ORB scaled pyramid whose scaling factor is \( \frac{1}{\root 4 \of {2}} \). More...
 

Enumerations

enum  nvxcu_array_item_type_e {
  NVXCU_TYPE_CHAR = 0x001,
  NVXCU_TYPE_INT8 = 0x002,
  NVXCU_TYPE_UINT8 = 0x003,
  NVXCU_TYPE_INT16 = 0x004,
  NVXCU_TYPE_UINT16 = 0x005,
  NVXCU_TYPE_INT32 = 0x006,
  NVXCU_TYPE_UINT32 = 0x007,
  NVXCU_TYPE_INT64 = 0x008,
  NVXCU_TYPE_UINT64 = 0x009,
  NVXCU_TYPE_FLOAT32 = 0x00A,
  NVXCU_TYPE_FLOAT64 = 0x00B,
  NVXCU_TYPE_RECTANGLE = 0x020,
  NVXCU_TYPE_KEYPOINT = 0x021,
  NVXCU_TYPE_COORDINATES2D = 0x022,
  NVXCU_TYPE_COORDINATES3D = 0x023,
  NVXCU_TYPE_POINT2F = 0x400,
  NVXCU_TYPE_POINT3F = 0x401,
  NVXCU_TYPE_POINT4F = 0x402,
  NVXCU_TYPE_KEYPOINTF = 0x403
}
 Defines an array item type enumeration. More...
 
enum  nvxcu_array_type_e { NVXCU_PLAIN_ARRAY }
 Defines the array object type ID. More...
 
enum  nvxcu_border_mode_e {
  NVXCU_BORDER_MODE_UNDEFINED = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_BORDER_MODE) + 0x0,
  NVXCU_BORDER_MODE_CONSTANT = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_BORDER_MODE) + 0x1,
  NVXCU_BORDER_MODE_REPLICATE = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_BORDER_MODE) + 0x2
}
 Defines a border mode enumeration. More...
 
enum  nvxcu_channel_e {
  NVXCU_CHANNEL_0 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x0,
  NVXCU_CHANNEL_1 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x1,
  NVXCU_CHANNEL_2 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x2,
  NVXCU_CHANNEL_3 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x3,
  NVXCU_CHANNEL_R = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x10,
  NVXCU_CHANNEL_G = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x11,
  NVXCU_CHANNEL_B = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x12,
  NVXCU_CHANNEL_A = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x13,
  NVXCU_CHANNEL_Y = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x14,
  NVXCU_CHANNEL_U = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x15,
  NVXCU_CHANNEL_V = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CHANNEL) + 0x16
}
 Defines a channel enumeration for channel extract operation. More...
 
enum  nvxcu_channel_range_e {
  NVXCU_CHANNEL_RANGE_FULL = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_RANGE) + 0x0,
  NVXCU_CHANNEL_RANGE_RESTRICTED = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_RANGE) + 0x1
}
 Defines an image channel range enumeration. More...
 
enum  nvxcu_color_space_e {
  NVXCU_COLOR_SPACE_NONE = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_SPACE) + 0x0,
  NVXCU_COLOR_SPACE_BT601_525 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_SPACE) + 0x1,
  NVXCU_COLOR_SPACE_BT601_625 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_SPACE) + 0x2,
  NVXCU_COLOR_SPACE_BT709 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_COLOR_SPACE) + 0x3,
  NVXCU_COLOR_SPACE_DEFAULT = NVXCU_COLOR_SPACE_BT709
}
 Defines an image color space enumeration. More...
 
enum  nvxcu_convert_policy_e {
  NVXCU_CONVERT_POLICY_WRAP = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CONVERT_POLICY) + 0x0,
  NVXCU_CONVERT_POLICY_SATURATE = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_CONVERT_POLICY) + 0x1
}
 Defines a convertion policy enumeration. More...
 
enum  nvxcu_df_image_e {
  NVXCU_DF_IMAGE_RGB = NVXCU_DF_IMAGE('R','G','B','2'),
  NVXCU_DF_IMAGE_RGBX = NVXCU_DF_IMAGE('R','G','B','A'),
  NVXCU_DF_IMAGE_NV12 = NVXCU_DF_IMAGE('N','V','1','2'),
  NVXCU_DF_IMAGE_NV21 = NVXCU_DF_IMAGE('N','V','2','1'),
  NVXCU_DF_IMAGE_UYVY = NVXCU_DF_IMAGE('U','Y','V','Y'),
  NVXCU_DF_IMAGE_YUYV = NVXCU_DF_IMAGE('Y','U','Y','V'),
  NVXCU_DF_IMAGE_IYUV = NVXCU_DF_IMAGE('I','Y','U','V'),
  NVXCU_DF_IMAGE_YUV4 = NVXCU_DF_IMAGE('Y','U','V','4'),
  NVXCU_DF_IMAGE_U8 = NVXCU_DF_IMAGE('U','0','0','8'),
  NVXCU_DF_IMAGE_U16 = NVXCU_DF_IMAGE('U','0','1','6'),
  NVXCU_DF_IMAGE_S16 = NVXCU_DF_IMAGE('S','0','1','6'),
  NVXCU_DF_IMAGE_U32 = NVXCU_DF_IMAGE('U','0','3','2'),
  NVXCU_DF_IMAGE_S32 = NVXCU_DF_IMAGE('S','0','3','2'),
  NVXCU_DF_IMAGE_F32 = NVXCU_DF_IMAGE('F','0','3','2'),
  NVXCU_DF_IMAGE_2F32 = NVXCU_DF_IMAGE('2','F','3','2'),
  NVXCU_DF_IMAGE_2S16 = NVXCU_DF_IMAGE('2','S','1','6'),
  NVXCU_DF_IMAGE_RGB16 = NVXCU_DF_IMAGE('S','3','1','6')
}
 Defines an image format enumeration. More...
 
enum  nvxcu_enum_e {
  NVXCU_ENUM_INTERPOLATION = 0x04,
  NVXCU_ENUM_COLOR_SPACE = 0x06,
  NVXCU_ENUM_COLOR_RANGE = 0x07,
  NVXCU_ENUM_CHANNEL = 0x09,
  NVXCU_ENUM_CONVERT_POLICY = 0x0A,
  NVXCU_ENUM_BORDER_MODE = 0x0C,
  NVXCU_ENUM_TERM_CRITERIA = 0x0F,
  NVXCU_ENUM_NORM_TYPE = 0x10,
  NVXCU_ENUM_ROUND_POLICY = 0x12
}
 Defines an enumeration type code. More...
 
enum  nvxcu_error_status_e {
  NVXCU_ERROR_CUDA_FAILURE = -1002,
  NVXCU_ERROR_INVALID_PARAMETERS = -10,
  NVXCU_ERROR_NOT_SUPPORTED = -3,
  NVXCU_ERROR_NOT_IMPLEMENTED = -2,
  NVXCU_FAILURE = -1,
  NVXCU_SUCCESS = 0
}
 Defines an error status code. More...
 
enum  nvxcu_exec_target_type_e { NVXCU_STREAM_EXEC_TARGET }
 Defines the execution target object type ID. More...
 
enum  nvxcu_flip_mode_e {
  NVXCU_FLIP_HORIZONTAL,
  NVXCU_FLIP_VERTICAL,
  NVXCU_FLIP_BOTH
}
 Defines modes for flip image operation. More...
 
enum  nvxcu_image_type_e {
  NVXCU_PITCH_LINEAR_IMAGE,
  NVXCU_UNIFORM_IMAGE
}
 Defines the image object type ID. More...
 
enum  nvxcu_interpolation_type_e {
  NVXCU_INTERPOLATION_TYPE_NEAREST_NEIGHBOR = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_INTERPOLATION) + 0x0,
  NVXCU_INTERPOLATION_TYPE_BILINEAR = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_INTERPOLATION) + 0x1,
  NVXCU_INTERPOLATION_TYPE_AREA = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_INTERPOLATION) + 0x2
}
 Defines an interpolation type enumeration. More...
 
enum  nvxcu_norm_type_e {
  NVXCU_NORM_L1 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_NORM_TYPE) + 0x0,
  NVXCU_NORM_L2 = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_NORM_TYPE) + 0x1
}
 Defines a normalization type enumeration. More...
 
enum  nvxcu_pyramid_type_e { NVXCU_PITCH_LINEAR_PYRAMID }
 Defines the pyramid object type ID. More...
 
enum  nvxcu_round_policy_e {
  NVXCU_ROUND_POLICY_TO_ZERO = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_ROUND_POLICY) + 0x1,
  NVXCU_ROUND_POLICY_TO_NEAREST_EVEN = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_ROUND_POLICY) + 0x2
}
 Defines a round policy enumeration. More...
 
enum  nvxcu_scanline_e {
  NVXCU_SCANLINE_LEFT_RIGHT = 1 << 0,
  NVXCU_SCANLINE_TOP_LEFT_BOTTOM_RIGHT = 1 << 1,
  NVXCU_SCANLINE_TOP_BOTTOM = 1 << 2,
  NVXCU_SCANLINE_TOP_RIGHT_BOTTOM_LEFT = 1 << 3,
  NVXCU_SCANLINE_RIGHT_LEFT = 1 << 4,
  NVXCU_SCANLINE_BOTTOM_RIGHT_TOP_LEFT = 1 << 5,
  NVXCU_SCANLINE_BOTTOM_TOP = 1 << 6,
  NVXCU_SCANLINE_BOTTOM_LEFT_TOP_RIGHT = 1 << 7,
  NVXCU_SCANLINE_CROSS,
  NVXCU_SCANLINE_ALL = 0xFF
}
 Defines scan line's directions used during cost aggregation step. More...
 
enum  nvxcu_sgm_flags_e { NVXCU_SGM_FILTER_TOP_AREA = 1 << 0 }
 Defines extra flags for SGM algorithm. More...
 
enum  nvxcu_termination_criteria_e {
  NVXCU_TERM_CRITERIA_ITERATIONS = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_TERM_CRITERIA) + 0x0,
  NVXCU_TERM_CRITERIA_EPSILON = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_TERM_CRITERIA) + 0x1,
  NVXCU_TERM_CRITERIA_BOTH = NVXCU_ENUM_BASE(0x000, NVXCU_ENUM_TERM_CRITERIA) + 0x2
}
 Defines a termination criteria enumeration. More...
 

Data Structure Documentation

struct nvxcu_array_t
Data Fields
nvxcu_array_type_e array_type Object type ID.
uint32_t capacity Capacity of the array buffer (in elements).
nvxcu_array_item_type_e item_type Array items type.
struct nvxcu_border_t
Collaboration diagram for nvxcu_border_t:
Data Fields
nvxcu_pixel_value_t constant_value Border constant value for NVXCU_BORDER_MODE_CONSTANT mode.
nvxcu_border_mode_e mode Border mode.
struct nvxcu_coordinates2d_t
Data Fields
uint32_t x The X coordinate.
uint32_t y The Y coordinate.
struct nvxcu_coordinates3d_t
Data Fields
uint32_t x The X coordinate.
uint32_t y The Y coordinate.
uint32_t z The Z coordinate.
struct nvxcu_exec_target_t
Data Fields
nvxcu_exec_target_type_e exec_target_type Object type ID.
struct nvxcu_image_t
Data Fields
nvxcu_df_image_e format Image format.
uint32_t height Image height.
nvxcu_image_type_e image_type Object type ID.
uint32_t width Image width.
struct nvxcu_keypoint_t
Data Fields
float error The tracking method specific error.
float orientation The orientation of the keypoint.
float scale The scale of the keypoint.
float strength The strength of the keypoint.
int32_t tracking_status The tracking status of the keypoint.
int32_t x The x coordinate.
int32_t y The y coordinate.
struct nvxcu_keypointf_t
Data Fields
float error The tracking method specific error.
float orientation The orientation of the keypoint.
float scale The scale of the keypoint.
float strength The strength of the keypoint.
int32_t tracking_status The tracking status of the keypoint.
float x The x coordinate.
float y The y coordinate.
struct nvxcu_pitch_linear_image_t
Collaboration diagram for nvxcu_pitch_linear_image_t:
Data Fields
nvxcu_image_t base Base image structure.
struct nvxcu_pitch_linear_image_t planes[NVXCU_NB_MAX_PLANES] Image planes.
struct nvxcu_pitch_linear_image_t.planes
Data Fields
void * dev_ptr CUDA device pointer.
int32_t pitch_in_bytes Pitch in bytes between two consequent rows.
struct nvxcu_pitch_linear_pyramid_t
Collaboration diagram for nvxcu_pitch_linear_pyramid_t:
Data Fields
nvxcu_pyramid_t base Base pyramid structure.
nvxcu_pitch_linear_image_t * levels The pyramid levels.
union nvxcu_pixel_value_t
Data Fields
float F32 NVXCU_DF_IMAGE_F32.
float F32n[4] NVXCU_DF_IMAGE_2F32.
uint8_t reserved[16] Reserved for future.
uint8_t RGB[3] NVXCU_DF_IMAGE_RGB format in the R,G,B order.
uint16_t RGB16[3] NVXCU_DF_IMAGE_RGB16 format in the R,G,B order.
uint8_t RGBX[4] NVXCU_DF_IMAGE_RGBX format in the R,G,B,X order.
int16_t S16 NVXCU_DF_IMAGE_S16.
int16_t S16n[4] NVXCU_DF_IMAGE_2S16.
int32_t S32 NVXCU_DF_IMAGE_S32.
uint16_t U16 NVXCU_DF_IMAGE_U16.
uint32_t U32 NVXCU_DF_IMAGE_U32.
uint8_t U8 NVXCU_DF_IMAGE_U8.
uint8_t YUV[3] All YUV formats in the Y,U,V order.
struct nvxcu_plain_array_t
Collaboration diagram for nvxcu_plain_array_t:
Data Fields
nvxcu_array_t base Base array structure.
void * dev_ptr CUDA device pointer to the items.
uint32_t * num_items_dev_ptr CUDA device pointer to the number of items.
struct nvxcu_point2f_t
Data Fields
float x The X coordinate.
float y The Y coordinate.
struct nvxcu_point3f_t
Data Fields
float x The X coordinate.
float y The Y coordinate.
float z The Z coordinate.
struct nvxcu_point4f_t
Data Fields
float w The W coordinate.
float x The X coordinate.
float y The Y coordinate.
float z The Z coordinate.
struct nvxcu_pyramid_t
Data Fields
uint32_t num_levels The number of pyramid levels.
nvxcu_pyramid_type_e pyramid_type Object type ID.
float scale The pyramid scale factor.
struct nvxcu_rectangle_t
Data Fields
uint32_t end_x The End X coordinate.
uint32_t end_y The End Y coordinate.
uint32_t start_x The Start X coordinate.
uint32_t start_y The Start Y coordinate.
struct nvxcu_stream_exec_target_t
Collaboration diagram for nvxcu_stream_exec_target_t:
Data Fields
nvxcu_exec_target_t base Base execution target structure.
struct cudaDeviceProp dev_prop CUDA device properties for current active device.
cudaStream_t stream CUDA stream to launch primitive in.
struct nvxcu_tmp_buf_size_t
Data Fields
size_t dev_buf_size The size of DEVICE temporary buffer.
size_t host_buf_size The size of HOST temporary buffer.
struct nvxcu_tmp_buf_t
Data Fields
void * dev_ptr CUDA Device memory buffer.
void * host_ptr HOST memory buffer.
struct nvxcu_uniform_image_t
Collaboration diagram for nvxcu_uniform_image_t:
Data Fields
nvxcu_image_t base Base image structure.
nvxcu_pixel_value_t uniform_value Uniform value.

Macro Definition Documentation

#define NVXCU_DF_IMAGE (   a,
  b,
  c,
  d 
)    ((a) | (b << 8) | (c << 16) | (d << 24))

Converts a set of four chars into a single uint32_t value.

See also
nvxcu_df_image_e

Definition at line 73 of file nvxcu.h.

#define NVXCU_ENUM_BASE (   v,
  id 
)    (((v) << 20) | (id << 12))

Calculates the base value for a specific enumeration type.

See also
nvxcu_enum_e

Definition at line 80 of file nvxcu.h.

#define NVXCU_NB_MAX_PLANES   (4u)

Defines the maximum number of planes in an image object.

Definition at line 550 of file nvxcu.h.

#define NVXCU_SCALE_PYRAMID_HALF   (0.5f)

Half-scale pyramid.

Definition at line 379 of file nvxcu.h.

#define NVXCU_SCALE_PYRAMID_ORB   (0.8408964f)

ORB scaled pyramid whose scaling factor is \( \frac{1}{\root 4 \of {2}} \).

Definition at line 385 of file nvxcu.h.

Enumeration Type Documentation

Defines an array item type enumeration.

Enumerator
NVXCU_TYPE_CHAR 

A char.

NVXCU_TYPE_INT8 

A int8_t.

NVXCU_TYPE_UINT8 

A uint8_t.

NVXCU_TYPE_INT16 

A int16_t.

NVXCU_TYPE_UINT16 

A uint16_t.

NVXCU_TYPE_INT32 

A int32_t.

NVXCU_TYPE_UINT32 

A uint32_t.

NVXCU_TYPE_INT64 

A int64_t.

NVXCU_TYPE_UINT64 

A uint64_t.

NVXCU_TYPE_FLOAT32 

A float.

NVXCU_TYPE_FLOAT64 

A double.

NVXCU_TYPE_RECTANGLE 

A nvxcu_rectangle_t.

NVXCU_TYPE_KEYPOINT 

A nvxcu_keypoint_t.

NVXCU_TYPE_COORDINATES2D 

A nvxcu_coordinates2d_t.

NVXCU_TYPE_COORDINATES3D 

A nvxcu_coordinates3d_t.

NVXCU_TYPE_POINT2F 

A nvxcu_point2f_t.

NVXCU_TYPE_POINT3F 

A nvxcu_point3f_t.

NVXCU_TYPE_POINT4F 

A nvxcu_point4f_t.

NVXCU_TYPE_KEYPOINTF 

A nvxcu_keypointf_t.

Definition at line 44 of file nvxcu.h.

Defines the array object type ID.

Enumerator
NVXCU_PLAIN_ARRAY 

nvxcu_plain_array_t object.

Definition at line 606 of file nvxcu.h.

Defines a border mode enumeration.

See also
vx_border_mode_e
Enumerator
NVXCU_BORDER_MODE_UNDEFINED 

No defined border mode behavior.

NVXCU_BORDER_MODE_CONSTANT 

Out-of-bound pixels are filled with constant value.

NVXCU_BORDER_MODE_REPLICATE 

Out-of-bound pixels are replicated from the nearest edge pixels.

Definition at line 283 of file nvxcu.h.

Defines a channel enumeration for channel extract operation.

See also
vx_channel_e
Enumerator
NVXCU_CHANNEL_0 

Used to extract the channel #0.

NVXCU_CHANNEL_1 

Used to extract the channel #1.

NVXCU_CHANNEL_2 

Used to extract the channel #2.

NVXCU_CHANNEL_3 

Used to extract the channel #3.

NVXCU_CHANNEL_R 

Used to extract the RED channel.

NVXCU_CHANNEL_G 

Used to extract the GREEN channel.

NVXCU_CHANNEL_B 

Used to extract the BLUE channel.

NVXCU_CHANNEL_A 

Used to extract the ALPHA channel.

NVXCU_CHANNEL_Y 

Used to extract the LUMA channel.

NVXCU_CHANNEL_U 

Used to extract the Cb/U channel.

NVXCU_CHANNEL_V 

Used to extract the Cr/V/Value channel.

Definition at line 208 of file nvxcu.h.

Defines an image channel range enumeration.

See also
vx_channel_range_e
Enumerator
NVXCU_CHANNEL_RANGE_FULL 

Full range of the unit of the channel.

NVXCU_CHANNEL_RANGE_RESTRICTED 

Restricted range of the unit of the channel based on the space given.

Definition at line 271 of file nvxcu.h.

Defines an image color space enumeration.

See also
vx_color_space_e
Enumerator
NVXCU_COLOR_SPACE_NONE 

No color space is used.

NVXCU_COLOR_SPACE_BT601_525 

The BT.601 coefficients and SMPTE C primaries.

NVXCU_COLOR_SPACE_BT601_625 

The BT.601 coefficients and BTU primaries.

NVXCU_COLOR_SPACE_BT709 

The BT.709 coefficients.

NVXCU_COLOR_SPACE_DEFAULT 

Default color space (BT.709).

Definition at line 253 of file nvxcu.h.

Defines a convertion policy enumeration.

See also
vx_convert_policy_e
Enumerator
NVXCU_CONVERT_POLICY_WRAP 

Wrap convertion policy.

NVXCU_CONVERT_POLICY_SATURATE 

Saturate conversion policy.

Definition at line 104 of file nvxcu.h.

Defines an image format enumeration.

See also
vx_df_image_e
Enumerator
NVXCU_DF_IMAGE_RGB 

A single 24-bit pixel plane of 3 interleaved 8-bit RGB units.

NVXCU_DF_IMAGE_RGBX 

A single 32-bit pixel plane of 4 interleaved 8-bit RGBX units.

NVXCU_DF_IMAGE_NV12 

A 2-plane YUV format of Luma (Y) and interleaved UV data at 4:2:0 sampling.

NVXCU_DF_IMAGE_NV21 

A 2-lane YUV format of Luma (Y) and interleaved VU data at 4:2:0 sampling.

NVXCU_DF_IMAGE_UYVY 

A single plane of 32-bit macro pixel of U0, Y0, V0, Y1 bytes.

NVXCU_DF_IMAGE_YUYV 

A single plane of 32-bit macro pixel of Y0, U0, Y1, V0 bytes.

NVXCU_DF_IMAGE_IYUV 

A 3 plane of 8-bit 4:2:0 sampled Y, U, V planes.

NVXCU_DF_IMAGE_YUV4 

A 3 plane of 8 bit 4:4:4 sampled Y, U, V planes.

NVXCU_DF_IMAGE_U8 

A single plane of 8-bit unsigned integer data.

NVXCU_DF_IMAGE_U16 

A single plane of 16-bit unsigned integer data.

NVXCU_DF_IMAGE_S16 

A single plane of 16-bit signed integer data.

NVXCU_DF_IMAGE_U32 

A single plane of 32-bit unsigned integer data.

NVXCU_DF_IMAGE_S32 

A single plane of 32-bit signed integer data.

NVXCU_DF_IMAGE_F32 

A single plane of 32-bit float data.

NVXCU_DF_IMAGE_2F32 

A single plane of float32_t[2] data (for example, motion fields).

NVXCU_DF_IMAGE_2S16 

A single plane of int16_t[2] data (for example, motion fields).

NVXCU_DF_IMAGE_RGB16 

A single 48-bit pixel plane of 3 interleaved 16-bit RGB units.

Definition at line 116 of file nvxcu.h.

Defines an enumeration type code.

These values are used to create a final value for specific enumeration constants.

Enumerator
NVXCU_ENUM_INTERPOLATION 

A nvxcu_interpolation_type_e.

NVXCU_ENUM_COLOR_SPACE 

A nvxcu_color_space_e.

NVXCU_ENUM_COLOR_RANGE 

A nvxcu_channel_range_e.

NVXCU_ENUM_CHANNEL 

A nvxcu_channel_e.

NVXCU_ENUM_CONVERT_POLICY 

A nvxcu_convert_policy_e.

NVXCU_ENUM_BORDER_MODE 

A nvxcu_border_mode_e.

NVXCU_ENUM_TERM_CRITERIA 

A nvxcu_termination_criteria_e.

NVXCU_ENUM_NORM_TYPE 

A nvxcu_norm_type_e.

NVXCU_ENUM_ROUND_POLICY 

A nvxcu_round_policy_e.

Definition at line 87 of file nvxcu.h.

Defines an error status code.

Enumerator
NVXCU_ERROR_CUDA_FAILURE 

Indicates internal CUDA failure.

NVXCU_ERROR_INVALID_PARAMETERS 

Indicates that current set of parameters is invalid.

NVXCU_ERROR_NOT_SUPPORTED 

Indicates that current set of parameters is not supported.

NVXCU_ERROR_NOT_IMPLEMENTED 

Indicates that requested operation is not implemented.

NVXCU_FAILURE 

Indicates a generic error code.

NVXCU_SUCCESS 

No error.

Definition at line 31 of file nvxcu.h.

Defines the execution target object type ID.

Enumerator
NVXCU_STREAM_EXEC_TARGET 

nvxcu_stream_exec_target_t object.

Definition at line 673 of file nvxcu.h.

Defines modes for flip image operation.

See also
nvx_flip_mode_e
Enumerator
NVXCU_FLIP_HORIZONTAL 

Horizontal flipping of the image.

NVXCU_FLIP_VERTICAL 

Vertical flipping of the image.

NVXCU_FLIP_BOTH 

Simultaneous horizontal and vertical flipping of the image.

Definition at line 335 of file nvxcu.h.

Defines the image object type ID.

Enumerator
NVXCU_PITCH_LINEAR_IMAGE 

nvxcu_pitch_linear_image_t object.

NVXCU_UNIFORM_IMAGE 

nvxcu_uniform_image_t object.

Definition at line 556 of file nvxcu.h.

Defines an interpolation type enumeration.

See also
vx_interpolation_type_e
Enumerator
NVXCU_INTERPOLATION_TYPE_NEAREST_NEIGHBOR 

Nearest neighbor interpolation.

NVXCU_INTERPOLATION_TYPE_BILINEAR 

Bilinear interpolation.

NVXCU_INTERPOLATION_TYPE_AREA 

Area interpolation.

Definition at line 239 of file nvxcu.h.

Defines a normalization type enumeration.

See also
vx_norm_type_e
Enumerator
NVXCU_NORM_L1 

L1 normalization.

NVXCU_NORM_L2 

L2 normalization.

Definition at line 311 of file nvxcu.h.

Defines the pyramid object type ID.

Enumerator
NVXCU_PITCH_LINEAR_PYRAMID 

nvxcu_pitch_linear_pyramid_t object.

Definition at line 640 of file nvxcu.h.

Defines a round policy enumeration.

See also
vx_round_policy_e
Enumerator
NVXCU_ROUND_POLICY_TO_ZERO 

Truncates the least significant values.

NVXCU_ROUND_POLICY_TO_NEAREST_EVEN 

Rounds to nearest even output value.

Definition at line 323 of file nvxcu.h.

Defines scan line's directions used during cost aggregation step.

See also
nvx_scanline_e
Enumerator
NVXCU_SCANLINE_LEFT_RIGHT 

Aggregate cost from left to right horizontally.

NVXCU_SCANLINE_TOP_LEFT_BOTTOM_RIGHT 

Aggregate cost from left to right diagonally starting from the top.

NVXCU_SCANLINE_TOP_BOTTOM 

Aggregate cost from top to bottom vertically.

NVXCU_SCANLINE_TOP_RIGHT_BOTTOM_LEFT 

Aggregate cost from right to left diagonally starting from the top.

NVXCU_SCANLINE_RIGHT_LEFT 

Aggregate cost from right to left horizontally.

NVXCU_SCANLINE_BOTTOM_RIGHT_TOP_LEFT 

Aggregate cost from right to left diagonally starting from the bottom.

NVXCU_SCANLINE_BOTTOM_TOP 

Aggregate cost from bottom to top vertically.

NVXCU_SCANLINE_BOTTOM_LEFT_TOP_RIGHT 

Aggregate cost from left to right diagonally starting from the bottom.

NVXCU_SCANLINE_CROSS 

Aggregate cost from four directions forming a cross.

Recommended option for automotive use cases.

NVXCU_SCANLINE_ALL 

Aggregate cost over all scan lines.

Definition at line 346 of file nvxcu.h.

Defines extra flags for SGM algorithm.

See also
nvx_sgm_flags_e
Enumerator
NVXCU_SGM_FILTER_TOP_AREA 

filter cost at top image area with low gradients.

Definition at line 371 of file nvxcu.h.

Defines a termination criteria enumeration.

See also
vx_termination_criteria_e
Enumerator
NVXCU_TERM_CRITERIA_ITERATIONS 

Termination by the number of iterations.

NVXCU_TERM_CRITERIA_EPSILON 

Termination by matching the value against epsilon.

NVXCU_TERM_CRITERIA_BOTH 

A combination of iterations and epsilon.

First match causes termination.

Definition at line 297 of file nvxcu.h.