VPI - Vision Programming Interface

2.0 Release - Developer Preview

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]streamA 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]backendBackend that will execute the algorithm.
[in]inputInput image to be filtered.
[out]outputOutput image where the result will be written to.
  • Must not be NULL.
  • It must have the same format and dimensions as input.
  • Image must have enabled the backends that will execute the algorithm.
[in]kernelSizeKernel support dimensions, in pixels.
  • Must be >= 1 and <= 11.
  • Must be odd.
[in]sigmaRangeStandard deviation in color space.
  • Must be > 0.
[in]sigmaSpaceStandard deviation in the coordinate space.
  • Must be > 0.
[in]borderHow to handle pixels outside image boundaries.
Return values
VPI_ERROR_INVALID_ARGUMENTstream is NULL.
VPI_ERROR_INVALID_ARGUMENTinput or output are NULL.
VPI_ERROR_INVALID_ARGUMENTinput and output image dimensions or formats don't match.
VPI_ERROR_INVALID_ARGUMENTinput or output image dimensions outside valid range.
VPI_ERROR_INVALID_ARGUMENTkernelSize outside valid range.
VPI_ERROR_INVALID_ARGUMENTsigmaRange or sigmaSpace outside valid range.
VPI_ERROR_INVALID_ARGUMENTbackend is invalid or unknown.
VPI_ERROR_INVALID_ARGUMENTborder not supported.
VPI_ERROR_INVALID_IMAGE_FORMATinput or output format is not supported.
VPI_ERROR_NOT_IMPLEMENTEDBilateral Filter algorithm is not supported by given backend.
VPI_ERROR_INVALID_OPERATIONThe needed backends aren't enabled in stream, input or output.
VPI_SUCCESSOperation executed successfully.