Recursive Gaussian Filter

Runs a generic 2D Gaussian filter over the input image. More...

Functions
VPIStatus	vpiCreateRecursiveGaussianFilter (uint64_t backends, int32_t maxWidth, int32_t maxHeight, VPIPayload *payload)
	Creates payload for vpiSubmitRecursiveGaussianFilter. More...
VPIStatus	vpiSubmitRecursiveGaussianFilter (VPIStream stream, uint64_t backend, VPIPayload payload, VPIImage input, VPIImage output, float sigmaX, float sigmaY, VPIBorderExtension border)
	Runs a Recursive Gaussian Filter over an image. More...

Detailed Description

Runs a generic 2D Gaussian filter over the input image.

It allows bigger sigma values than the ones available in direct-convolution-based Gaussian filter. Refer to Recursive Gaussian Filter for more details and usage examples.

Function Documentation

vpiCreateRecursiveGaussianFilter()

VPIStatus vpiCreateRecursiveGaussianFilter	(	uint64_t	backends,
		int32_t	maxWidth,
		int32_t	maxHeight,
		VPIPayload *	payload
	)

#include <vpi/algo/RecursiveGaussianFilter.h>

Creates payload for vpiSubmitRecursiveGaussianFilter.

This function allocates all temporary memory needed by the algorithm.

Parameters

[in]	backends	VPI backends that are eligible to execute the algorithm. Supported backends: VPI_BACKEND_CPU VPI_BACKEND_CUDA Backend must be enabled in current context.
[in]	maxWidth	Maximum width in the input and output images provided for the algorithm. It must be >= 1.
[in]	maxHeight	Maximum height in the input and output images provided for the algorithm. It must be >= 1.
[out]	payload	Pointer to the payload variable that receives the created handle. It must not be NULL.

Return values

VPI_ERROR_INVALID_ARGUMENT	payload is NULL.
VPI_ERROR_INVALID_ARGUMENT	backends refers to an invalid backend.
VPI_ERROR_INVALID_ARGUMENT	maxWidth or maxHeight outside valid range.
VPI_ERROR_INVALID_OPERATION	Backend hardware not available.
VPI_ERROR_NOT_IMPLEMENTED	Algorithm does not support the given backend.
VPI_ERROR_INVALID_CONTEXT	Current context is destroyed.
VPI_ERROR_OUT_OF_MEMORY	Cannot allocate required resources.
VPI_ERROR_INVALID_OPERATION	Backend isn't enabled in current context.
VPI_SUCCESS	Operation executed successfully.

vpiSubmitRecursiveGaussianFilter()

VPIStatus vpiSubmitRecursiveGaussianFilter	(	VPIStream	stream,
		uint64_t	backend,
		VPIPayload	payload,
		VPIImage	input,
		VPIImage	output,
		float	sigmaX,
		float	sigmaY,
		VPIBorderExtension	border
	)

#include <vpi/algo/RecursiveGaussianFilter.h>

Runs a Recursive Gaussian Filter over an image.

Parameters

[in]	stream	The stream where the operation will be queued in. It must not be NULL. Stream must have enabled the backends that will execute the algorithm.
[in]	backend	Backend that will execute the algorithm. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA
[in]	payload	Payload created by vpiCreateRecursiveGaussianFilter. It must not be NULL.
[in]	input	Input image to be filtered. It must not be NULL. Image must have enabled the backends that will execute the algorithm. It must have dimensions less or equal maximum dimensions set in payload. The accepted image formats are: VPI_IMAGE_FORMAT_Y8 VPI_IMAGE_FORMAT_Y16 VPI_IMAGE_FORMAT_Y8_ER VPI_IMAGE_FORMAT_Y16_ER VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_S8 VPI_IMAGE_FORMAT_U16 VPI_IMAGE_FORMAT_S16 VPI_IMAGE_FORMAT_F32
[out]	output	Image where the result will be written to. Must not be NULL. Image must have enabled the backends that will execute the algorithm. Must have same dimensions and format as input image.
[in]	sigmaX	Standard deviation for the Gaussian filter in the X direction. It must be > 0.
[in]	sigmaY	Standard deviation for the Gaussian filter in the Y direction. It must be > 0. It must be equal to sigmaX.
[in]	border	How to handle pixels outside image boundaries. The accepted border extensions are: VPI_BORDER_ZERO VPI_BORDER_CLAMP VPI_BORDER_REFLECT

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or output are NULL.
VPI_ERROR_INVALID_ARGUMENT	payload is not generated using vpiCreateRecursiveGaussianFilter.
VPI_ERROR_INVALID_ARGUMENT	input or output image dimensions outside valid range.
VPI_ERROR_INVALID_ARGUMENT	input and output image dimensions and format must be the same.
VPI_ERROR_INVALID_ARGUMENT	input and output dimensions are bigger than the one defined in the payload.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_ARGUMENT	backend is invalid or unknown.
VPI_ERROR_INVALID_IMAGE_FORMAT	input or output image format not supported.
VPI_ERROR_INVALID_PAYLOAD_TYPE	payload is invalid.
VPI_ERROR_NOT_IMPLEMENTED	Algorithm does not support the given backend.
VPI_ERROR_INVALID_OPERATION	Backend hardware not available.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or output.
VPI_SUCCESS	Operation executed successfully.