Box Filter

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

Functions
VPIStatus	vpiSubmitBoxFilter (VPIStream stream, uint64_t backend, VPIImage input, VPIImage output, int32_t kernelWidth, int32_t kernelHeight, VPIBorderExtension border)
	Runs a 2D box filter over an image. More...

Detailed Description

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

Refer to Box Filter for more details and usage examples.

Function Documentation

vpiSubmitBoxFilter()

VPIStatus vpiSubmitBoxFilter	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage	input,
		VPIImage	output,
		int32_t	kernelWidth,
		int32_t	kernelHeight,
		VPIBorderExtension	border
	)

#include <vpi/algo/BoxFilter.h>

Runs a 2D box 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 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	Output image where the result is written to. Must not be NULL. It must have same dimensions and format as input. Image must have enabled the backends that will execute the algorithm.
[in]	kernelWidth,kernelHeight	Box kernel dimensions. Can be non-square. Both must be between 1x1 and 11x11, and odd.
[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	kernelWidth or kernelHeight outside valid range.
VPI_ERROR_INVALID_ARGUMENT	input or output image dimensions ouside valid range.
VPI_ERROR_INVALID_ARGUMENT	input and output image dimensions or format do not match.
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_OPERATION	Backend hardware is not available.
VPI_ERROR_INVALID_OPERATION	The needed backends aren't enabled in stream, input or output.
VPI_ERROR_NOT_IMPLEMENTED	Box Filter algorithm is not supported by given backend.
VPI_SUCCESS	Operation executed successfully.