Pyramid Module Interface

Detailed Description

Defines the Pyramid module.

Note

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

Enumerations
enum	dwPyramidPVAState {   DW_PYRAMID_PVA_ASYNC_PREPARE_DATA = 0,   DW_PYRAMID_PVA_ASYNC_PROCESS_DATA = 1,   DW_PYRAMID_PVA_CPU_ASYNC_PROCESS = 2 }
	The dwPyramidPVAState enum represents the current state the module is in. More...

Functions
DW_API_PUBLIC dwStatus	dwPyramidPVA_bindInput (const dwImageHandle_t input, dwPyramidPVAHandle_t obj)
	Binds the input image to class member. More...
DW_API_PUBLIC dwStatus	dwPyramidPVA_bindOutput (dwPyramidImage *output, dwPyramidPVAHandle_t obj)
	Binds the initialized output pyramid to class. More...
DW_API_PUBLIC dwStatus	dwPyramidPVA_process (dwPyramidPVAState stageToExecute, dwPyramidPVAHandle_t obj)
	Calls process functions based on the current state of execution. More...

Enumeration Type Documentation

dwPyramidPVAState

enum dwPyramidPVAState

The dwPyramidPVAState enum represents the current state the module is in.

Enumerator
DW_PYRAMID_PVA_ASYNC_PREPARE_DATA
DW_PYRAMID_PVA_ASYNC_PROCESS_DATA
DW_PYRAMID_PVA_CPU_ASYNC_PROCESS

Definition at line 60 of file PyramidPVA_processpipeline.h.

Function Documentation

dwPyramidPVA_bindInput()

DW_API_PUBLIC dwStatus dwPyramidPVA_bindInput	(	const dwImageHandle_t	input,
		dwPyramidPVAHandle_t	obj
	)

Binds the input image to class member.

Parameters

[in]	input	input image of type dwImageHandle_t(Generic CUDA image) Currently the supported image type is DW_IMAGE_CUDA, the supported image formats are DW_IMAGE_FORMAT_R_UINT8, DW_IMAGE_FORMAT_R_FLOAT16 and DW_IMAGE_FORMAT_R_FLOAT32.
[in]	obj	dyramid module object

Returns

DW_INVALID_ARGUMENT, DW_INVALID_HANDLE or DW_SUCCESS

dwPyramidPVA_bindOutput()

DW_API_PUBLIC dwStatus dwPyramidPVA_bindOutput	(	dwPyramidImage *	output,
		dwPyramidPVAHandle_t	obj
	)

Binds the initialized output pyramid to class.

Parameters

[in]	output	image pyramid(CUDA Images)
[in]	obj	dyramid module object

Returns

DW_INVALID_ARGUMENT, DW_INVALID_HANDLE or DW_SUCCESS

dwPyramidPVA_process()

DW_API_PUBLIC dwStatus dwPyramidPVA_process	(	dwPyramidPVAState	stageToExecute,
		dwPyramidPVAHandle_t	obj
	)

Calls process functions based on the current state of execution.

Parameters

[in]	stageToExecute	current execution state
[in]	obj	dyramid module object

Returns

DW_INVALID_ARGUMENT, DW_INVALID_HANDLE or DW_SUCCESS