VPI - Vision Programming Interface

0.4.4 Release

Gaussian Filter

Overview

Gaussian Filter is a low-pass discrete Gaussian filter that smooths out the image by doing a Gaussian-weighted averaging of neighbor pixels of a given input pixel. It produces images with less artifacts than Box Filter, but could potentially be more costly to compute.

It supports two modes of operation:

  • Kernel support size is automatically calculated based on the filter standard deviation (sigma).
  • Use both user-provided kernel support size and filter standard deviation.
Input Gaussian kernel Output
7x7 support,

\[ \sigma=1.7 \]

Implementation

Gaussian filter is implemented as a convolution operation on the input image where the kernel has the following weights:

\[ w_g[x,y] = \frac{1}{2\pi\sigma^2} \cdot e^{-\frac{x^2+y^2}{2\sigma^2}} \]

When the input kernel support size is 0 for a given dimension (or both), it is calculated from the given standard deviation by assuming that the weights outside \(\pm3\sigma\) window are zero.

In this case, the following formula is used:

\[ w = \max\{3,2 \times \lceil 3\sigma\rceil-1\} \]

Note
We clamp the minimum kernel size to 3 because a kernel with size 1 doesn't have enough samples to properly characterize a Gaussian function.

Usage

  1. Initialization phase
    1. Include the header that defines the Gaussian filter function.
    2. Define the input image object.
      VPIImage input = /*...*/;
    3. Create the output image. It gets its dimensions and format from the input image.
      uint32_t w, h;
      vpiImageGetSize(input, &w, &h);
      vpiImageGetType(input, &type);
      VPIImage output;
      vpiImageCreate(w, h, type, 0, &output);
    4. Create the stream where the algorithm will be submitted for execution.
      VPIStream stream;
      vpiStreamCreate(0, &stream);
  2. Processing phase
    1. Submit the algorithm to the stream along with other parameters. It'll be executed by the CPU backend. It defines a Gaussian filter with 7x7 support and \(\sigma=1.7\) in both horizontal and vertical directions, along with a zero boundary condition.
      vpiSubmitGaussianFilter(stream, VPI_BACKEND_CPU, input, output, 7, 7, 1.7, 1.7, VPI_BOUNDARY_COND_ZERO);
    2. Optionally, wait until the processing is done.
      vpiStreamSync(stream);
  3. Cleanup phase
    1. Free resources held by the stream and the input and output images.

For more details, consult the Gaussian Filter API reference.

Limitations and Constraints

Constraints for specific backends supersede the ones specified for all backends.

All Backends

PVA

  • Only available on Jetson Xavier devices.
  • Minimum kernel size is 2x2.
  • Accepted boundary conditions:

VIC

  • Not implemented.

Performance

For information on how to use the performance table below, see Algorithm Performance Tables.
Before comparing measurements, consult Comparing Algorithm Elapsed Times.
For further information on how performance was benchmarked, see Performance Measurement.

 - 
vpiStreamCreate
VPIStatus vpiStreamCreate(uint32_t flags, VPIStream *stream)
Create a stream instance.
BoxFilter.h
Declares functions that implement the Box Filter algorithm.
vpiSubmitGaussianFilter
VPIStatus vpiSubmitGaussianFilter(VPIStream stream, VPIBackend backend, VPIImage input, VPIImage output, uint32_t kernelSizeX, uint32_t kernelSizeY, float sigmaX, float sigmaY, VPIBoundaryCond boundary)
Runs a 2D Gaussian filter over an image.
vpiStreamSync
VPIStatus vpiStreamSync(VPIStream stream)
Blocks the calling thread until all submitted commands in this stream queue are done (queue is empty)...
VPIStream
struct VPIStreamImpl * VPIStream
A handle to a stream.
Definition: Types.h:190
vpiStreamDestroy
void vpiStreamDestroy(VPIStream stream)
Destroy a stream instance and deallocate all HW resources.
vpiImageCreate
VPIStatus vpiImageCreate(uint32_t width, uint32_t height, VPIImageFormat fmt, uint32_t flags, VPIImage *img)
Create an empty image instance with the specified flags.
vpiImageDestroy
void vpiImageDestroy(VPIImage img)
Destroy an image instance.
VPIImage
struct VPIImageImpl * VPIImage
A handle to an image.
Definition: Types.h:196
vpiImageGetSize
VPIStatus vpiImageGetSize(VPIImage img, uint32_t *width, uint32_t *height)
Get the image size in pixels.
VPI_BOUNDARY_COND_ZERO
@ VPI_BOUNDARY_COND_ZERO
All pixels outside the image are considered to be zero.
Definition: Types.h:218
VPI_BACKEND_CPU
@ VPI_BACKEND_CPU
CPU backend.
Definition: Types.h:90
VPIImageFormat
VPIImageFormat
Pre-defined image formats.
Definition: ImageFormat.h:94
vpiImageGetType
VPIStatus vpiImageGetType(VPIImage img, VPIImageFormat *type)
Get the image format.