Median Filter

Runs a 2D median filter over the input image. More...

Functions
VPIStatus	vpiSubmitMedianFilter (VPIStream stream, uint64_t backend, VPIImage input, VPIImage output, int32_t kernelWidth, int32_t kernelHeight, const int8_t *kernelData, VPIBorderExtension border)
	Runs a 2D median filter over an image. More...

Detailed Description

Runs a 2D median filter over the input image.

Refer to Median Filter for more details and usage examples regarding Median Filter.

Function Documentation

vpiSubmitMedianFilter()

VPIStatus vpiSubmitMedianFilter	(	VPIStream	stream,
		uint64_t	backend,
		VPIImage	input,
		VPIImage	output,
		int32_t	kernelWidth,
		int32_t	kernelHeight,
		const int8_t *	kernelData,
		VPIBorderExtension	border
	)

#include <vpi/algo/MedianFilter.h>

Runs a 2D median filter over an image.

Parameters

[in]	stream	A stream handle where the operation will be queued into.
[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 denoised. Valid Image formats: Formats CPU CUDA PVA 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_U32 * * * VPI_IMAGE_FORMAT_S32 * * * VPI_IMAGE_FORMAT_RGB8p * * VPI_IMAGE_FORMAT_RGBA8p * * VPI_IMAGE_FORMAT_BGR8p * * VPI_IMAGE_FORMAT_BGRA8p * * VPI_IMAGE_FORMAT_2S16 * For PVA backend, Image size must be at least 128x64.
[out]	output	Output image where the result is written to. Must not be NULL. Must have same format and dimensions as input image. Image must have enabled the backends that will execute the algorithm.
[in]	kernelWidth,kernelHeight	Kernel dimensions. The coordinate of the kernel weight that is aligned with the source pixel is given by the following formula: \begin{align*} k_x &= \mathit{kernelWidth}/2 \\ k_y &= \mathit{kernelHeight}/2 \end{align*} Must be between 1x1 and 11x11, can be non square. Must be 3x3 for PVA backend.
[in]	kernelData	Median kernel binary mask. It defines the structuring element, or median calculation mask, in row-major layout. Input pixels corresponding to an element of value 0 will be excluded from the median calculation. The contents of kernelData will be copied, so the buffer is safe to destroy on return from vpiSubmitMedianFilter. NULL may be used as a shortcut to mean all elements are non-zero. If not NULL, it must point to a buffer with kernelWidth * kernelHeight elements. For PVA backend, kernelData must be NULL or contain only non-zero elements.
[in]	border	How to handle pixels outside image boundaries. The accepted border extensions are: VPI_BORDER_ZERO VPI_BORDER_CLAMP VPI_BORDER_REFLECT VPI_BORDER_MIRROR VPI_BORDER_LIMITED (ignores pixels outside image boundaries) For PVA backend, only VPI_BORDER_ZERO and VPI_BORDER_CLAMP are supported.

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 and formats do not match.
VPI_ERROR_INVALID_ARGUMENT	Image dimensions aren't supported for given format.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_ARGUMENT	backend is invalid or unknown.
VPI_ERROR_INVALID_IMAGE_FORMAT	input and output formats aren't supported
VPI_ERROR_NOT_IMPLEMENTED	Median 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.