Detailed Description

Defines OpenRoadNet module, i.e., OpenRoadNet configuration and loading.

Note: SW Release Applicability: These APIs are available in NVIDIA DRIVE Software releases.

Data Structures
struct	dwOpenRoadNetParams

Typedefs
typedef struct dwOpenRoadNetObject *	dwOpenRoadNetHandle_t
	Handle to a OpenRoadNet object. More...

Enumerations
enum	dwFreespaceBoundaryType { DW_BOUNDARY_TYPE_OTHER = 0, DW_BOUNDARY_TYPE_CURB = 1, DW_BOUNDARY_TYPE_VEHICLE = 2, DW_BOUNDARY_TYPE_PERSON = 3, DW_BOUNDARY_TYPE_UNDEFINED = 4, DW_BOUNDARY_NUM_TYPES }
	Category of free space boundary. More...

enum	dwOpenRoadNetBatchSize { DW_OPENROADNET_BATCH_SIZE_1 = 1, DW_OPENROADNET_BATCH_SIZE_2 = 2, DW_OPENROADNET_BATCH_SIZE_4 = 4, DW_OPENROADNET_BATCH_SIZE_6 = 6 }
	OpenRoadNet network batch size options. More...

enum	dwOpenRoadNetModel { DW_OPENROADNET_MODEL_FRONT = 0, DW_OPENROADNET_MODEL_SIDE = 1, DW_OPENROADNET_NUM_MODELS, DW_OPENROADNET_MODEL_CUSTOM = -1 }
	OpenRoadNet network models to be loaded by OpenRoadNet module. More...

Functions
DW_API_PUBLIC dwStatus	dwOpenRoadNet_getClassLabel (const char **classLabel, uint32_t classIdx, dwOpenRoadNetHandle_t obj)
	Returns the class label for a given class index. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_getDNNMetaData (dwDNNMetaData *metaData, dwOpenRoadNetHandle_t obj)
	Returns the DNN metadata. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_getInputBlobsize (dwBlobSize *inputBlobsize, dwOpenRoadNetHandle_t obj)
	Returns input blob size that OpenRoadNet expects. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_initDefaultParams (dwOpenRoadNetParams *params, dwContextHandle_t ctx)
	Initializes OpenRoadNet parameters with default values. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_initialize (dwOpenRoadNetHandle_t openRoadNetHandle, dwContextHandle_t ctx, const dwOpenRoadNetParams openRoadNetParams)
	Initializes OpenRoadNet module. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_release (dwOpenRoadNetHandle_t obj)
	Releases the OpenRoadNet module. More...

DW_API_PUBLIC dwStatus	dwOpenRoadNet_reset (dwOpenRoadNetHandle_t obj)
	Resets OpenRoadNet. More...

Data Structure Documentation

◆ dwOpenRoadNetParams

struct dwOpenRoadNetParams

Data Fields
dwOpenRoadNetBatchSize	batchSize
const void *	networkCustomData	Custom network data. Must be set if custom model is selected and available.
dwOpenRoadNetModel	networkModel	OpenRoadNet network model. Default is DW_OPENROADNET_MODEL_FRONT.
dwPrecision	networkPrecision	OpenRoadNet network precision. Default is DW_PRECISION_FP32.

Typedef Documentation

◆ dwOpenRoadNetHandle_t

typedef struct dwOpenRoadNetObject* dwOpenRoadNetHandle_t

Handle to a OpenRoadNet object.

Definition at line 62 of file OpenRoadNet.h.

Enumeration Type Documentation

◆ dwFreespaceBoundaryType

enum dwFreespaceBoundaryType

Category of free space boundary.

Enumerator
DW_BOUNDARY_TYPE_OTHER	boundary with other objects
DW_BOUNDARY_TYPE_CURB	boundary with curb
DW_BOUNDARY_TYPE_VEHICLE	boundary with vehicle
DW_BOUNDARY_TYPE_PERSON	boundary with person
DW_BOUNDARY_TYPE_UNDEFINED	undefined boundary
DW_BOUNDARY_NUM_TYPES

Definition at line 65 of file OpenRoadNet.h.

◆ dwOpenRoadNetBatchSize

enum dwOpenRoadNetBatchSize

OpenRoadNet network batch size options.

Enumerator
DW_OPENROADNET_BATCH_SIZE_1	OpenRoadNet network is loaded with batch size = 1 if available.
DW_OPENROADNET_BATCH_SIZE_2	OpenRoadNet network is loaded with batch size = 2 if available.
DW_OPENROADNET_BATCH_SIZE_4	OpenRoadNet network is loaded with batch size = 4 if available.
DW_OPENROADNET_BATCH_SIZE_6	OpenRoadNet network is loaded with batch size = 6 if available.

Definition at line 87 of file OpenRoadNet.h.

◆ dwOpenRoadNetModel

enum dwOpenRoadNetModel

OpenRoadNet network models to be loaded by OpenRoadNet module.

Enumerator
DW_OPENROADNET_MODEL_FRONT	OpenRoadNet model that performs best on front camera.
DW_OPENROADNET_MODEL_SIDE	OpenRoadNet model that performs best on side camera.
DW_OPENROADNET_NUM_MODELS
DW_OPENROADNET_MODEL_CUSTOM	Loads custom OpenRoadNet model if available. Network name must be provided in networkCustomData field in dwOpenRoadNetParams

Definition at line 75 of file OpenRoadNet.h.

Function Documentation

◆ dwOpenRoadNet_getClassLabel()

DW_API_PUBLIC dwStatus dwOpenRoadNet_getClassLabel	(	const char **	classLabel,
		uint32_t	classIdx,
		dwOpenRoadNetHandle_t	obj
	)

Returns the class label for a given class index.

Parameters

[out]	classLabel	Pointer to class label.
[in]	classIdx	Class index, i.e. number in [0, numObjectClasses)
[in]	obj	Specifies the OpenRoadNet handle.

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given handle is invalid,i.e. null or of wrong type
DW_BAD_CAST
DW_INVALID_ARGUMENT

◆ dwOpenRoadNet_getDNNMetaData()

DW_API_PUBLIC dwStatus dwOpenRoadNet_getDNNMetaData	(	dwDNNMetaData *	metaData,
		dwOpenRoadNetHandle_t	obj
	)

Returns the DNN metadata.

Parameters

[out]	metaData	Pointer to metaData struct.
[in]	obj	Specifies the OpenRoadNet handle.

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given handle is invalid,i.e. null or of wrong type
DW_BAD_CAST
DW_INVALID_ARGUMENT

◆ dwOpenRoadNet_getInputBlobsize()

DW_API_PUBLIC dwStatus dwOpenRoadNet_getInputBlobsize	(	dwBlobSize *	inputBlobsize,
		dwOpenRoadNetHandle_t	obj
	)

Returns input blob size that OpenRoadNet expects.

Parameters

[out]	inputBlobsize	Input blob size.
[in]	obj	Specifies the OpenRoadNet handle.

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given handle is invalid,i.e. null or of wrong type
DW_BAD_CAST
DW_INVALID_ARGUMENT

◆ dwOpenRoadNet_initDefaultParams()

DW_API_PUBLIC dwStatus dwOpenRoadNet_initDefaultParams	(	dwOpenRoadNetParams *	params,
		dwContextHandle_t	ctx
	)

Initializes OpenRoadNet parameters with default values.

Parameters

[out]	params	OpenRoadNet default parameters.
[in]	ctx	Specifies the handle to the context.

Returns: DW_SUCCESS, DW_INVALID_ARGUMENT

Note: Default precision depends on the current GPU.

◆ dwOpenRoadNet_initialize()

DW_API_PUBLIC dwStatus dwOpenRoadNet_initialize	(	dwOpenRoadNetHandle_t *	openRoadNetHandle,
		dwContextHandle_t	ctx,
		const dwOpenRoadNetParams *	openRoadNetParams
	)

Initializes OpenRoadNet module.

Parameters

[out]	openRoadNetHandle	A pointer to OpenRoadNet handle to be initialized.
[in]	ctx	Specifies the handle to the context.
[in]	openRoadNetParams	OpenRoadNet parameters

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given context handle is invalid,i.e. null or of wrong type
DW_BAD_CAST
DW_INVALID_ARGUMENT

Note: If OpenRoadNet module is to be loaded on a non-default GPU Device, the initialization must take place after dwContext_selectGPUDevice.

◆ dwOpenRoadNet_release()

DW_API_PUBLIC dwStatus dwOpenRoadNet_release ( dwOpenRoadNetHandle_t obj )

Releases the OpenRoadNet module.

Parameters

[in] obj The object handle to release.

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given context handle is invalid,i.e. null or of wrong type
DW_BAD_CAST

Note: This method renders the handle unusable.

◆ dwOpenRoadNet_reset()

DW_API_PUBLIC dwStatus dwOpenRoadNet_reset ( dwOpenRoadNetHandle_t obj )

Resets OpenRoadNet.

Parameters

[in] obj Handle to reset.

Returns: DW_SUCCESS
DW_INVALID_HANDLE - If the given context handle is invalid,i.e. null or of wrong type
DW_BAD_CAST

Detailed Description

Data Structures

Typedefs

Enumerations

Functions

Data Structure Documentation

◆ dwOpenRoadNetParams

Typedef Documentation

◆ dwOpenRoadNetHandle_t

Enumeration Type Documentation

◆ dwFreespaceBoundaryType

◆ dwOpenRoadNetBatchSize

◆ dwOpenRoadNetModel

Function Documentation

◆ dwOpenRoadNet_getClassLabel()

◆ dwOpenRoadNet_getDNNMetaData()

◆ dwOpenRoadNet_getInputBlobsize()

◆ dwOpenRoadNet_initDefaultParams()

◆ dwOpenRoadNet_initialize()

◆ dwOpenRoadNet_release()

◆ dwOpenRoadNet_reset()