Gaussian Filter

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

Functions
VPIStatus	vpiSubmitGaussianFilter (VPIStream stream, uint64_t backend, VPIImage input, VPIImage output, int32_t kernelSizeX, int32_t kernelSizeY, float sigmaX, float sigmaY, VPIBorderExtension border)
	Runs a 2D Gaussian filter over an image. More...

Detailed Description

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

Refer to Gaussian Filter for more details and usage examples.

Function Documentation

vpiSubmitGaussianFilter()

VPIStatus vpiSubmitGaussianFilter	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage	input,
		VPIImage	output,
		int32_t	kernelSizeX,
		int32_t	kernelSizeY,
		float	sigmaX,
		float	sigmaY,
		VPIBorderExtension	border
	)

#include <vpi/algo/GaussianFilter.h>

Runs a 2D Gaussian filter over an image.

Parameters

[in]	stream	The stream where the operation will be queued in. Must not be NULL. Stream must have enabled the backends that will execute the algorithm.
[in]	backend	Backend that will execute the algorithm. Accepted values: VPI_BACKEND_CPU VPI_BACKEND_CUDA VPI_BACKEND_PVA
[in]	input	Input image to be filtered. Must not be NULL. Image must have enabled the backends that will execute the algorithm. On PVA, image dimensions must be at least 64x32. The accepted image formats are: Formats CPU CUDA PVA VPI_IMAGE_FORMAT_U8 * * * VPI_IMAGE_FORMAT_S8 * * * VPI_IMAGE_FORMAT_U16 * * * VPI_IMAGE_FORMAT_S16 * * * VPI_IMAGE_FORMAT_Y8 * 1 * VPI_IMAGE_FORMAT_Y8_ER * 1 * VPI_IMAGE_FORMAT_Y16 * 1 * VPI_IMAGE_FORMAT_Y16_ER * 1 * VPI_IMAGE_FORMAT_F32 * * VPI_IMAGE_FORMAT_RGB8p 2 VPI_IMAGE_FORMAT_RGBA8p 2 VPI_IMAGE_FORMAT_BGR8p 2 VPI_IMAGE_FORMAT_BGRA8p 2 (1) only for kernel dimensions <= 3x3 (2) only for kernel dimensions >= 3x3
[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 as input image.
[in]	kernelSizeX,kernelSizeY	Gaussian kernel size in X and Y directions respectively. If 0, it'll be 2*ceil(3*sigma) rounded to the next odd size. Limited between 1 and 11. Must be odd.
[in]	sigmaX,sigmaY	Standard deviation of the Gaussian kernel in the X and Y directions respectively. It must be a positive value. If kernelSize==0, sigma is limited to 2.
[in]	border	How to handle pixels outside image boundaries. The accepted border extensions are: VPI_BORDER_ZERO VPI_BORDER_CLAMP

Return values

VPI_ERROR_INVALID_ARGUMENT	stream is NULL.
VPI_ERROR_INVALID_ARGUMENT	input or output are NULL.
VPI_ERROR_INVALID_ARGUMENT	kernelSizeX or kernelSizeY outside valid range.
VPI_ERROR_INVALID_ARGUMENT	sigmaX or sigmaY outside valid range.
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	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_NOT_IMPLEMENTED	Gaussian Filter algorithm is not supported by 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.