Bilateral Filter

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

Functions
VPIStatus	vpiSubmitBilateralFilter (VPIStream stream, uint64_t backend, VPIImage input, VPIImage output, int32_t kernelSize, float sigmaRange, float sigmaSpace, VPIBorderExtension border)
	Runs a 2D bilateral filter over an image. More...

Detailed Description

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

Refer to Bilateral Filter for more details and usage examples.

Function Documentation

vpiSubmitBilateralFilter()

VPIStatus vpiSubmitBilateralFilter	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage	input,
		VPIImage	output,
		int32_t	kernelSize,
		float	sigmaRange,
		float	sigmaSpace,
		VPIBorderExtension	border
	)

#include <vpi/algo/BilateralFilter.h>

Runs a 2D bilateral filter over an image.

Parameters

[in]	stream	A stream handle where the operation will be queued into. 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]	input	Input image to be filtered. Must not be NULL. Image must have enabled the backends that will execute the algorithm. The accepted image formats are: Formats CPU CUDA VPI_IMAGE_FORMAT_U8 * * VPI_IMAGE_FORMAT_S8 * * VPI_IMAGE_FORMAT_U16 * * VPI_IMAGE_FORMAT_S16 * * VPI_IMAGE_FORMAT_Y8 * * VPI_IMAGE_FORMAT_Y8_ER * * VPI_IMAGE_FORMAT_Y16 * * VPI_IMAGE_FORMAT_Y16_ER * * VPI_IMAGE_FORMAT_F32 * * VPI_IMAGE_FORMAT_NV12 * VPI_IMAGE_FORMAT_NV12_ER * VPI_IMAGE_FORMAT_U8_BL * VPI_IMAGE_FORMAT_U8_BL16 * VPI_IMAGE_FORMAT_Y8_BL * VPI_IMAGE_FORMAT_Y8_BL16 * VPI_IMAGE_FORMAT_Y8_ER_BL * VPI_IMAGE_FORMAT_Y8_ER_BL16 * VPI_IMAGE_FORMAT_NV12_BL * VPI_IMAGE_FORMAT_NV12_BL16 * VPI_IMAGE_FORMAT_NV12_ER_BL * VPI_IMAGE_FORMAT_NV12_ER_BL16 *
[out]	output	Output image where the result will be written to. Must not be NULL. It must have the same dimensions as input. Its format must be one of the valid formats accept as input. If output format can differ from input format only regarding its memory layout (pitch- or block-linear), but only if the input is block-linear. Image must have enabled the backends that will execute the algorithm.
[in]	kernelSize	Kernel support dimensions, in pixels. Must be >= 1 and <= 11. Must be odd.
[in]	sigmaRange	Standard deviation in color space. Must be > 0.
[in]	sigmaSpace	Standard deviation in the coordinate space. Must be > 0.
[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	input and output image dimensions or formats don't match.
VPI_ERROR_INVALID_ARGUMENT	input or output image dimensions outside valid range.
VPI_ERROR_INVALID_ARGUMENT	kernelSize outside valid range.
VPI_ERROR_INVALID_ARGUMENT	sigmaRange or sigmaSpace outside valid range.
VPI_ERROR_INVALID_ARGUMENT	backend is invalid or unknown.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_IMAGE_FORMAT	input or output format is not supported.
VPI_ERROR_NOT_IMPLEMENTED	Bilateral Filter algorithm is not supported by given backend.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or output.
VPI_SUCCESS	Operation executed successfully.