boofcv.alg.filter.convolve

Class ConvolveImageNoBorder

java.lang.Object

boofcv.alg.filter.convolve.ConvolveImageNoBorder

public class ConvolveImageNoBorder
extends Object

Provides functions for convolving 1D and 2D kernels across an image, excluding the image border. 1D kernels can either be convolved along each row or column in the image. No checks are done for overflow or underflow.

When convolving with division the convolution is computed as usual, but then the result is divided by the divisor. This is typically done when performing convolution inside of integer images to normalize it by the sum of all the elements in the convolution kernel.

Image Edges: There is no general purpose way for handling convolutions along the image edges. Therefor unless the whole kernel can be convolved image borders are skipped. In special cases where there is a clear way to handle image edges specialized functions are provided.

Author:

Peter Abeles

Constructor Summary

Constructors

Constructor and Description
ConvolveImageNoBorder()

Method Summary

Methods

Modifier and Type	Method and Description
static void	convolve(Kernel2D_F32 kernel, ImageFloat32 input, ImageFloat32 output) Performs a 2D convolution across the image.
static void	convolve(Kernel2D_I32 kernel, ImageSInt16 input, ImageInt16 output) Performs a 2D convolution across the image.
static void	convolve(Kernel2D_I32 kernel, ImageSInt16 input, ImageInt16 output, int divisor) Performs a 2D convolution across the image.
static void	convolve(Kernel2D_I32 kernel, ImageUInt8 input, ImageInt16 output) Performs a 2D convolution across the image.
static void	convolve(Kernel2D_I32 kernel, ImageUInt8 input, ImageInt8 output, int divisor) Performs a 2D convolution with division across the image.
static void	convolve(Kernel2D_I32 kernel, ImageUInt8 input, ImageSInt32 output) Performs a 2D convolution across the image.
static void	horizontal(Kernel1D_F32 kernel, ImageFloat32 input, ImageFloat32 output, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	horizontal(Kernel1D_I32 kernel, ImageSInt16 input, ImageInt16 output, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	horizontal(Kernel1D_I32 kernel, ImageSInt16 input, ImageInt16 output, int divisor, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	horizontal(Kernel1D_I32 kernel, ImageSInt32 input, ImageSInt32 output, int divisor, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	horizontal(Kernel1D_I32 kernel, ImageUInt8 input, ImageInt16 output, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	horizontal(Kernel1D_I32 kernel, ImageUInt8 input, ImageInt8 output, int divisor, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image with division.
static void	horizontal(Kernel1D_I32 kernel, ImageUInt8 input, ImageSInt32 output, boolean includeVerticalBorder) Performs a horizontal 1D convolution across the image.
static void	vertical(Kernel1D_F32 kernel, ImageFloat32 input, ImageFloat32 output, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.
static void	vertical(Kernel1D_I32 kernel, ImageSInt16 input, ImageInt16 output, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.
static void	vertical(Kernel1D_I32 kernel, ImageSInt16 input, ImageInt16 output, int divisor, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.
static void	vertical(Kernel1D_I32 kernel, ImageSInt32 input, ImageSInt32 output, int divisor, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.
static void	vertical(Kernel1D_I32 kernel, ImageUInt8 input, ImageInt16 output, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.
static void	vertical(Kernel1D_I32 kernel, ImageUInt8 input, ImageInt8 output, int divisor, boolean includeHorizontalBorder) Performs a vertical 1D convolution with division across the image.
static void	vertical(Kernel1D_I32 kernel, ImageUInt8 input, ImageSInt32 output, boolean includeHorizontalBorder) Performs a vertical 1D convolution across the image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConvolveImageNoBorder

public ConvolveImageNoBorder()

Method Detail

horizontal

public static void horizontal(Kernel1D_F32 kernel,
              ImageFloat32 input,
              ImageFloat32 output,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageUInt8 input,
              ImageInt8 output,
              int divisor,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image with division. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageUInt8 input,
              ImageInt16 output,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageUInt8 input,
              ImageSInt32 output,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageSInt16 input,
              ImageInt16 output,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageSInt16 input,
              ImageInt16 output,
              int divisor,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeVerticalBorder - Should the vertical border of the image be processed?

horizontal

public static void horizontal(Kernel1D_I32 kernel,
              ImageSInt32 input,
              ImageSInt32 output,
              int divisor,
              boolean includeVerticalBorder)

Performs a horizontal 1D convolution across the image. The horizontal border is not processed and the vertical border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeVerticalBorder - Should the vertical border of the image be processed?

vertical

public static void vertical(Kernel1D_F32 kernel,
            ImageFloat32 input,
            ImageFloat32 output,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageUInt8 input,
            ImageInt8 output,
            int divisor,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution with division across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageUInt8 input,
            ImageInt16 output,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageUInt8 input,
            ImageSInt32 output,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageSInt16 input,
            ImageInt16 output,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageSInt16 input,
            ImageInt16 output,
            int divisor,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeHorizontalBorder - Should the horizontal border of the image be processed?

vertical

public static void vertical(Kernel1D_I32 kernel,
            ImageSInt32 input,
            ImageSInt32 output,
            int divisor,
            boolean includeHorizontalBorder)

Performs a vertical 1D convolution across the image. The vertical border is not processed and the horizontal border is optionally processed. The border is as wide as the radius of the kernel.

Parameters:

input - The original image. Not modified.

output - Where the resulting image is written to. Modified.

kernel - The kernel that is being convolved. Not modified.

divisor - The value that the convolved image is divided by.

includeHorizontalBorder - Should the horizontal border of the image be processed?

convolve

public static void convolve(Kernel2D_F32 kernel,
            ImageFloat32 input,
            ImageFloat32 output)

Performs a 2D convolution across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

convolve

public static void convolve(Kernel2D_I32 kernel,
            ImageUInt8 input,
            ImageInt8 output,
            int divisor)

Performs a 2D convolution with division across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

divisor - The value that the convolved image is divided by.

convolve

public static void convolve(Kernel2D_I32 kernel,
            ImageUInt8 input,
            ImageInt16 output)

Performs a 2D convolution across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

convolve

public static void convolve(Kernel2D_I32 kernel,
            ImageUInt8 input,
            ImageSInt32 output)

Performs a 2D convolution across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

convolve

public static void convolve(Kernel2D_I32 kernel,
            ImageSInt16 input,
            ImageInt16 output)

Performs a 2D convolution across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

convolve

public static void convolve(Kernel2D_I32 kernel,
            ImageSInt16 input,
            ImageInt16 output,
            int divisor)

Performs a 2D convolution across the image. The image's borders are not processed.

Parameters:

kernel - A square kernel that will be convolved across the source image

input - The source image that is to be convolved

output - The results of the convolution

divisor - The value that the convolved image is divided by.