Erode

Filter an image with a 2D binary kernel composed with the erode morphological operation. More...

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

Detailed Description

Filter an image with a 2D binary kernel composed with the erode morphological operation.

Refer to Erode for more details and usage examples regarding Erode.

Function Documentation

vpiSubmitErode()

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

#include <vpi/algo/MorphologicalFilter.h>

Runs a 2D erode over an image.

Parameters

[in]	stream	The stream handle 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. Valid values: VPI_BACKEND_CPU VPI_BACKEND_CUDA VPI_BACKEND_PVA
[in]	input	Input image to be eroded with the kernel. Must not be NULL. Image must have enabled the backends that will execute the algorithm. Supported formats: VPI_IMAGE_FORMAT_U8 VPI_IMAGE_FORMAT_S8 VPI_IMAGE_FORMAT_U16 VPI_IMAGE_FORMAT_S16 For PVA backend, Image size must be greater than 128x128.
[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. Must be between 1x1 and 11x11, and can be non-square. (PVA only supports 3x3 and 5x5 square sizes)
[in]	kernelData	Erode kernel binary mask, i.e. structuring element or neighborhood definition, in row-major layout. The kernel elements are copied to an internal buffer. The buffers passed can be deallocated after the call. Use NULL for full neighborhood, all elements considered to be 1. If not NULL, it must point to a buffer with kernelWidth * kernelHeight elements. (PVA only supports 3x3, 5x5 square and 3x3 cross kernels)
[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 (ignore pixels outside image boundaries)

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 and output images must have same dimensions and format.
VPI_ERROR_INVALID_ARGUMENT	border not supported.
VPI_ERROR_INVALID_IMAGE_FORMAT	input format not supported.
VPI_ERROR_NOT_IMPLEMENTED	Erode 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.