DriveWorks SDK Reference
3.5.78 Release
For Test and Development only

RoadMarkNet Interface

Detailed Description

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

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

Data Structures

struct  dwRoadMarkNetParams
 RoadMarkNet model parameters. More...
 

Macros

#define DW_ROADMARK_MAX_OUTPUT_TYPES   64
 

Typedefs

typedef struct dwRoadMarkNetObject * dwRoadMarkNetHandle_t
 Handle to a RoadMarkNet object. More...
 

Enumerations

enum  dwRoadMarkNetBatchSize {
  DW_ROADMARKNET_BATCH_SIZE_1 = 0,
  DW_ROADMARKNET_BATCH_SIZE_16 = 1,
  DW_ROADMARKNET_BATCH_SIZE_32 = 2,
  DW_ROADMARKNET_BATCH_SIZE_64 = 3
}
 Network batch size options for RoadMarkNet. More...
 
enum  dwRoadMarkNetModel {
  DW_ROADMARKNET_MODEL_US_V0 = 0,
  DW_ROADMARKNET_MODEL_COUNT = 1,
  DW_ROADMARKNET_MODEL_CUSTOM = -1
}
 Network models to be loaded by RoadMarkNet module. More...
 

Functions

DW_API_PUBLIC dwStatus dwRoadMarkNet_getClassLabel (const char **classLabel, dwRoadmarkType roadmarkType, dwRoadMarkNetHandle_t obj)
 Returns the class label for a given class index. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_getDNNMetaData (dwDNNMetaData *metaData, dwRoadMarkNetHandle_t obj)
 Returns the DNN metadata. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_getInputBlobsize (dwBlobSize *inputBlobsize, dwRoadMarkNetHandle_t obj)
 Returns input blob size that RoadMarkNet expects. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_initDefaultParams (dwRoadMarkNetParams *roadMarkNetParams, dwContextHandle_t ctx)
 Initializes RoadMarkNet parameters with default values. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_initialize (dwRoadMarkNetHandle_t *roadMarkNetHandle, const dwRoadMarkNetParams *roadMarkNetParams, dwContextHandle_t ctx)
 Initializes RoadMarkNet module. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_release (dwRoadMarkNetHandle_t obj)
 Releases the RoadMarkNet module. More...
 
DW_API_PUBLIC dwStatus dwRoadMarkNet_reset (dwRoadMarkNetHandle_t obj)
 Resets RoadMarkNet. More...
 

Data Structure Documentation

◆ dwRoadMarkNetParams

struct dwRoadMarkNetParams
Data Fields
dwRoadMarkNetBatchSize batchSize RoadMarkNet network batch size. Default is DW_ROADMARKNET_BATCH_SIZE_32.
const void * networkCustomData Custom network data. Must be set if custom model is selected and available.
dwRoadMarkNetModel networkModel RoadMarkNet network model. Default is DW_ROADMARKNET_MODEL_US_V0.
dwPrecision networkPrecision RoadMarkNet network precision. Default is based on GPU type.
dwProcessorType processorType Processor type. Supported processors: GPU, DLA (only on DDPX). Default is GPU.

Macro Definition Documentation

◆ DW_ROADMARK_MAX_OUTPUT_TYPES

#define DW_ROADMARK_MAX_OUTPUT_TYPES   64

Definition at line 66 of file RoadMarkNet.h.

Typedef Documentation

◆ dwRoadMarkNetHandle_t

typedef struct dwRoadMarkNetObject* dwRoadMarkNetHandle_t

Handle to a RoadMarkNet object.

Definition at line 63 of file RoadMarkNet.h.

Enumeration Type Documentation

◆ dwRoadMarkNetBatchSize

Network batch size options for RoadMarkNet.

Enumerator
DW_ROADMARKNET_BATCH_SIZE_1 

RoadMarkNet network is loaded with batch size = 1 if available.

DW_ROADMARKNET_BATCH_SIZE_16 

RoadMarkNet network is loaded with batch size = 16 if available.

DW_ROADMARKNET_BATCH_SIZE_32 

RoadMarkNet network is loaded with batch size = 32 if available.

DW_ROADMARKNET_BATCH_SIZE_64 

RoadMarkNet network is loaded with batch size = 64 if available.

Definition at line 84 of file RoadMarkNet.h.

◆ dwRoadMarkNetModel

Network models to be loaded by RoadMarkNet module.

Enumerator
DW_ROADMARKNET_MODEL_US_V0 
DW_ROADMARKNET_MODEL_COUNT 
DW_ROADMARKNET_MODEL_CUSTOM 

Definition at line 71 of file RoadMarkNet.h.

Function Documentation

◆ dwRoadMarkNet_getClassLabel()

DW_API_PUBLIC dwStatus dwRoadMarkNet_getClassLabel ( const char **  classLabel,
dwRoadmarkType  roadmarkType,
dwRoadMarkNetHandle_t  obj 
)

Returns the class label for a given class index.

Parameters
[out]classLabelPointer to class label.
[in]roadmarkTypeRoadmark class for which class label is requested.
[in]objThe handle to RoadMarkNet.
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 - If the given classLabel pointer is NULL

◆ dwRoadMarkNet_getDNNMetaData()

DW_API_PUBLIC dwStatus dwRoadMarkNet_getDNNMetaData ( dwDNNMetaData metaData,
dwRoadMarkNetHandle_t  obj 
)

Returns the DNN metadata.

Parameters
[out]metaDataPointer to metaData struct.
[in]objSpecifies the RoadMarkNet handle.
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 - If the given metadata pointer is NULL

◆ dwRoadMarkNet_getInputBlobsize()

DW_API_PUBLIC dwStatus dwRoadMarkNet_getInputBlobsize ( dwBlobSize inputBlobsize,
dwRoadMarkNetHandle_t  obj 
)

Returns input blob size that RoadMarkNet expects.

Parameters
[out]inputBlobsizeInput blob size.
[in]objSpecifies the RoadMarkNet handle.
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 - if the given input blobsize pointer is NULL

◆ dwRoadMarkNet_initDefaultParams()

DW_API_PUBLIC dwStatus dwRoadMarkNet_initDefaultParams ( dwRoadMarkNetParams roadMarkNetParams,
dwContextHandle_t  ctx 
)

Initializes RoadMarkNet parameters with default values.

Parameters
[out]roadMarkNetParamsRoadMarkNet parameters.
[in]ctxThe handle to the context.
Returns
DW_SUCCESS
DW_INVALID_ARGUMENT - If the given params pointer is NULL
Note
Default precision depends on the current GPU.

◆ dwRoadMarkNet_initialize()

DW_API_PUBLIC dwStatus dwRoadMarkNet_initialize ( dwRoadMarkNetHandle_t roadMarkNetHandle,
const dwRoadMarkNetParams roadMarkNetParams,
dwContextHandle_t  ctx 
)

Initializes RoadMarkNet module.

Parameters
[out]roadMarkNetHandleA pointer to RoadMarkNet handle to be initialized.
[in]roadMarkNetParamsRoadMarkNet parameters.
[in]ctxThe handle to the context.
Returns
DW_SUCCESS
DW_INVALID_ARGUMENT - If the given context handle is invalid, i.e null or of wrong type
DW_BAD_CAST
DW_INVALID_ARGUMENT - If the given roadMarkNet handle or roadMarkNetParams pointers are NULL
Note
If RoadMarkNet module is to be loaded on a non-default GPU Device, the initialization must take place after dwContext_selectGPUDevice.

◆ dwRoadMarkNet_release()

DW_API_PUBLIC dwStatus dwRoadMarkNet_release ( dwRoadMarkNetHandle_t  obj)

Releases the RoadMarkNet module.

Parameters
[in]objThe handle to RoadMarkNet.
Returns
DW_SUCCESS
DW_INVALID_ARGUMENT - If the given handle is invalid,i.e. null or of wrong type
DW_BAD_CAST
Note
This method renders the handle unusable.

◆ dwRoadMarkNet_reset()

DW_API_PUBLIC dwStatus dwRoadMarkNet_reset ( dwRoadMarkNetHandle_t  obj)

Resets RoadMarkNet.

Parameters
[in]objHandle to RoadMarkNet.
Returns
DW_SUCCESS
DW_INVALID_ARGUMENT - If the given handle is invalid, i.e null or of wrong type
DW_BAD_CAST