DriveWorks SDK Reference
3.5.78 Release
For Test and Development only

Data Structures | Typedefs | Enumerations | Functions
LightNet Interface

Detailed Description

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

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

Data Structures

struct  dwLightNetParams
 

Typedefs

typedef struct dwLightNetObject * dwLightNetHandle_t
 Handle to a LightNet object. More...
 

Enumerations

enum  dwLightNetBatchSize {
  DW_LIGHTNET_BATCH_SIZE_1 = 0,
  DW_LIGHTNET_BATCH_SIZE_16 = 1,
  DW_LIGHTNET_BATCH_SIZE_32 = 2,
  DW_LIGHTNET_BATCH_SIZE_64 = 3
}
 LightNet network batch size options. More...
 
enum  dwLightNetModel {
  DW_LIGHTNET_MODEL_FRONT_V5 = 0,
  DW_LIGHTNET_MODEL_FRONT_V6 = 1,
  DW_LIGHTNET_MODEL_FRONT_V7 = 2,
  DW_LIGHTNET_MODEL_FRONT_V8 = 3,
  DW_LIGHTNET_MODEL_COUNT,
  DW_LIGHTNET_MODEL_CUSTOM = -1
}
 LightNet network models to be loaded by LightNet module. More...
 

Functions

DW_API_PUBLIC dwStatus dwLightNet_getDNNMetaData (dwDNNMetaData *metaData, dwLightNetHandle_t obj)
 Returns the DNN metadata. More...
 
DW_API_PUBLIC dwStatus dwLightNet_getInputBlobsize (dwBlobSize *inputBlobsize, dwLightNetHandle_t obj)
 Returns input blob size that LightNet expects. More...
 
DW_API_PUBLIC dwStatus dwLightNet_getNumberOutputs (uint32_t *numLightOutputs, dwLightNetHandle_t obj)
 Returns the number of raw lightnet outputs its DNN produces. More...
 
DW_API_PUBLIC dwStatus dwLightNet_getTypeLabel (const char **classLabel, uint32_t classIdx, dwLightNetHandle_t obj)
 Returns the class label for a given class index. More...
 
DW_API_PUBLIC dwStatus dwLightNet_initDefaultParams (dwLightNetParams *params, dwContextHandle_t ctx)
 Initializes LightNet parameters with default values. More...
 
DW_API_PUBLIC dwStatus dwLightNet_initialize (dwLightNetHandle_t *lightNetHandle, const dwLightNetParams *lightNetParams, dwContextHandle_t ctx)
 Initializes LightNet module. More...
 
DW_API_PUBLIC dwStatus dwLightNet_release (dwLightNetHandle_t obj)
 Releases the LightNet module. More...
 
DW_API_PUBLIC dwStatus dwLightNet_reset (dwLightNetHandle_t obj)
 Resets LightNet. More...
 

Data Structure Documentation

◆ dwLightNetParams

struct dwLightNetParams
Data Fields
dwLightNetBatchSize batchSize LightNet network batch size. Default is DW_LIGHTNET_BATCH_SIZE_1.
const void * networkCustomData Custom network data. Must be set if custom model is selected and available.
dwLightNetModel networkModel LightNet network model. Default is DW_LIGHTNET_MODEL_FRONT_V7.
dwPrecision networkPrecision LightNet network precision. Default is DW_PRECISION_FP32.
dwProcessorType processorType Processor type. Supported processors: GPU, DLA (only on DDPX)

Typedef Documentation

◆ dwLightNetHandle_t

typedef struct dwLightNetObject* dwLightNetHandle_t

Handle to a LightNet object.

Definition at line 63 of file LightNet.h.

Enumeration Type Documentation

◆ dwLightNetBatchSize

enum dwLightNetBatchSize

LightNet network batch size options.

Enumerator
DW_LIGHTNET_BATCH_SIZE_1 

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

DW_LIGHTNET_BATCH_SIZE_16 

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

DW_LIGHTNET_BATCH_SIZE_32 

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

DW_LIGHTNET_BATCH_SIZE_64 

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

Definition at line 79 of file LightNet.h.

◆ dwLightNetModel

enum dwLightNetModel

LightNet network models to be loaded by LightNet module.

Enumerator
DW_LIGHTNET_MODEL_FRONT_V5 

LightNet model on front camera.

DW_LIGHTNET_MODEL_FRONT_V6 
DW_LIGHTNET_MODEL_FRONT_V7 
DW_LIGHTNET_MODEL_FRONT_V8 
DW_LIGHTNET_MODEL_COUNT 
DW_LIGHTNET_MODEL_CUSTOM 

Loads custom LightNet model if available.

Network name must be provided in networkCustomData field in dwLightNetParams

Definition at line 66 of file LightNet.h.

Function Documentation

◆ dwLightNet_getDNNMetaData()

DW_API_PUBLIC dwStatus dwLightNet_getDNNMetaData ( dwDNNMetaData *  metaData,
dwLightNetHandle_t  obj 
)

Returns the DNN metadata.

Parameters
[out]metaDataPointer to metaData struct.
[in]objThe handle to LightNet.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT

◆ dwLightNet_getInputBlobsize()

DW_API_PUBLIC dwStatus dwLightNet_getInputBlobsize ( dwBlobSize *  inputBlobsize,
dwLightNetHandle_t  obj 
)

Returns input blob size that LightNet expects.

Parameters
[out]inputBlobsizeInput blob size.
[in]objSpecifies the LightNet handle.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT

◆ dwLightNet_getNumberOutputs()

DW_API_PUBLIC dwStatus dwLightNet_getNumberOutputs ( uint32_t *  numLightOutputs,
dwLightNetHandle_t  obj 
)

Returns the number of raw lightnet outputs its DNN produces.

Parameters
[out]numLightOutputsNumber of light object classes.
[in]objSpecifies the LightNet handle.
Returns
DW_SUCCESS, DW_INVALID_HANDLE, DW_BAD_CAST, DW_INVALID_ARGUMENT

◆ dwLightNet_getTypeLabel()

DW_API_PUBLIC dwStatus dwLightNet_getTypeLabel ( const char **  classLabel,
uint32_t  classIdx,
dwLightNetHandle_t  obj 
)

Returns the class label for a given class index.

Parameters
[out]classLabelPointer to class label.
[in]classIdxClass index, i.e. number in [0, numObjectClasses)
[in]objThe handle to LightNet.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT

◆ dwLightNet_initDefaultParams()

DW_API_PUBLIC dwStatus dwLightNet_initDefaultParams ( dwLightNetParams *  params,
dwContextHandle_t  ctx 
)

Initializes LightNet parameters with default values.

Parameters
[out]paramsLightNet default parameters.
[in]ctxThe handle to the context.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT
Note
Default precision depends on the current GPU.

◆ dwLightNet_initialize()

DW_API_PUBLIC dwStatus dwLightNet_initialize ( dwLightNetHandle_t *  lightNetHandle,
const dwLightNetParams *  lightNetParams,
dwContextHandle_t  ctx 
)

Initializes LightNet module.

Parameters
[out]lightNetHandleA pointer to LightNet handle to be initialized.
[in]lightNetParamsLightNet parameters
[in]ctxThe handle to the context.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT
Note
If LightNet module is to be loaded on a non-default GPU Device, the initialization must take place after dwContext_selectGPUDevice.

◆ dwLightNet_release()

DW_API_PUBLIC dwStatus dwLightNet_release ( dwLightNetHandle_t  obj)

Releases the LightNet module.

Parameters
[in]objThe handle to LightNet.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT
Note
This method renders the handle unusable.

◆ dwLightNet_reset()

DW_API_PUBLIC dwStatus dwLightNet_reset ( dwLightNetHandle_t  obj)

Resets LightNet.

Parameters
[in]objHandle to LightNet.
Returns
DW_SUCCESS, DW_INVALID_ARGUMENT