ClearSightNet Interface

Detailed Description

Defines the ClearSightNet module.

Note

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

Data Structures
struct	dwClearSightNetParams

Typedefs
typedef struct dwClearSightNetObject *	dwClearSightNetHandle_t
	Handle to a ClearSightNet object. More...

Functions
DW_API_PUBLIC dwStatus	dwClearSightNet_getDNNMetaData (dwDNNMetaData *metaData, dwClearSightNetHandle_t clearSightNetHandle)
	Returns the DNN metadata. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_getInputBlobSize (dwBlobSize *inputBlobsize, dwClearSightNetHandle_t clearSightNetHandle)
	Returns input blob size that ClearSightNet expects. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_getOutputBlobSize (dwBlobSize *outputBlobsize, dwClearSightNetHandle_t clearSightNetHandle)
	Returns output blob size of first (only) ClearSightNet output. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_initDefaultParams (dwClearSightNetParams *clearSightNetParams, dwContextHandle_t ctx)
	Initializes ClearSightNet parameters with default values. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_initialize (dwClearSightNetHandle_t *clearSightNetHandle, const dwClearSightNetParams *clearSightNetParams, dwContextHandle_t ctx)
	Initializes ClearSightNet module. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_release (dwClearSightNetHandle_t clearSightNetHandle)
	Releases the ClearSightNet module. More...
DW_API_PUBLIC dwStatus	dwClearSightNet_reset (dwClearSightNetHandle_t clearSightNetHandle)
	Resets ClearSightNet. More...

---

Data Structure Documentation

dwClearSightNetParams

struct dwClearSightNetParams

Data Fields
const void *	networkCustomData	Custom network data. Must be set if custom model is selected and available.
dwPrecision	networkPrecision	ClearSightnet network precision. Default is DW_PRECISION_FP32.
dwProcessorType	processorType	Processor type. Supported processors: GPU (Default), DLA (only on DDPX)

Typedef Documentation

dwClearSightNetHandle_t

typedef struct dwClearSightNetObject* dwClearSightNetHandle_t

Handle to a ClearSightNet object.

Definition at line 62 of file ClearSightNet.h.

Function Documentation

dwClearSightNet_getDNNMetaData()

DW_API_PUBLIC dwStatus dwClearSightNet_getDNNMetaData	(	dwDNNMetaData *	metaData,
		dwClearSightNetHandle_t	clearSightNetHandle
	)

Returns the DNN metadata.

Parameters

[out]	metaData	Pointer to metaData struct.
[in]	clearSightNetHandle	Specifies the ClearSightNet 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

dwClearSightNet_getInputBlobSize()

DW_API_PUBLIC dwStatus dwClearSightNet_getInputBlobSize	(	dwBlobSize *	inputBlobsize,
		dwClearSightNetHandle_t	clearSightNetHandle
	)

Returns input blob size that ClearSightNet expects.

Parameters

[out]	inputBlobsize	Input blob size.
[in]	clearSightNetHandle	Specifies the ClearSightNet 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

dwClearSightNet_getOutputBlobSize()

DW_API_PUBLIC dwStatus dwClearSightNet_getOutputBlobSize	(	dwBlobSize *	outputBlobsize,
		dwClearSightNetHandle_t	clearSightNetHandle
	)

Returns output blob size of first (only) ClearSightNet output.

Parameters

[out]	outputBlobsize	Output blob size.
[in]	clearSightNetHandle	Specifies the ClearSightNet 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

dwClearSightNet_initDefaultParams()

DW_API_PUBLIC dwStatus dwClearSightNet_initDefaultParams	(	dwClearSightNetParams *	clearSightNetParams,
		dwContextHandle_t	ctx
	)

Initializes ClearSightNet parameters with default values.

Parameters

[out]	clearSightNetParams	ClearSightNet parameters.
[in]	ctx	Specifies the handle to the context.

Returns

DW_SUCCESS, DW_INVALID_ARGUMENT

Note

Default precision depends on the current GPU.

dwClearSightNet_initialize()

DW_API_PUBLIC dwStatus dwClearSightNet_initialize	(	dwClearSightNetHandle_t *	clearSightNetHandle,
		const dwClearSightNetParams *	clearSightNetParams,
		dwContextHandle_t	ctx
	)

Initializes ClearSightNet module.

Parameters

[out]	clearSightNetHandle	A pointer to ClearSightNet handle to be initialized.
[in]	clearSightNetParams	ClearSightnet parameters
[in]	ctx	Specifies the handle to the context.

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 ClearSightNet module is to be loaded on a non-default GPU Device, the initialization must take place after dwContext_selectGPUDevice().

dwClearSightNet_release()

DW_API_PUBLIC dwStatus dwClearSightNet_release

(

dwClearSightNetHandle_t

clearSightNetHandle

)

Releases the ClearSightNet module.

Parameters

[in]

clearSightNetHandle

The object handle to release.

Returns

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

Note

This method renders the handle unusable.

dwClearSightNet_reset()

DW_API_PUBLIC dwStatus dwClearSightNet_reset

(

dwClearSightNetHandle_t

clearSightNetHandle

)

Resets ClearSightNet.

Parameters

[in]

clearSightNetHandle

Handle to reset.

Returns

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