com.luciad.imaging.operator

LuciadFusionClass TLcdConvolveOp

java.lang.Object

com.luciad.imaging.operator.ALcdImageOperator

com.luciad.imaging.operator.TLcdConvolveOp

public final class TLcdConvolveOp
extends ALcdImageOperator

Applies a convolution filter to an image.

Convolution of an image with a kernel is an operation that computes for each pixel a weighted sum of that pixel and its surrounding pixels. A convolution filter differs from the straight weighting in such a way that in convolution the weight for a pixel at offset (dx, dy) from the center pixel is weighted by the weight at index (-dx,-dy) in the kernel. In other words if the kernel is rotated by 180 degrees and placed on top of the central pixel then each pixel lines up with it kernel weight. Note that the rotation has no effect in case of a symmetric kernel.

For example the 2D convolution of a pixel with a kernel of 3x3:

  double[] kernel = {+1, -2, +3,
                    -4, +5, -6,
                    +7, -8, +9};

  // Each pixel is computed as follows:
  out(column, row) = 0;
  for (int dy=-1; dy<=1; dy++) {
    for (int dx=-1; dx<=1; dx++) {
      int index = 1-dx + (1-dy)*3; // where 3 is the width of the kernel (number of columns)
      out(column, row)+=kernel[index]*in(column+dx, row+dy);
    }
  }
 

Note the use of -dx and -dy in the index computation, needed to perform the 180 degree rotation.

If one of the input pixels of the convolution kernel has a "no data" value, the result of the kernel for the current pixel is also "no data".

This operator expects kernels with odd dimensions (e.g., 3x3). Otherwise an IllegalArgumentException will be thrown.

Example

 // Using the static method:
 ALcdImage inputImage = ...;
 double[] kernel = new double[] {
     -1.0f, -1.0f, -1.0f,
     -1.0f,  9.0f, -1.0f,
     -1.0f, -1.0f, -1.0f
 };
 ALcdImage outputImage = TLcdConvolveOp.convolve(inputImage, kernel, 3, 3);

 // Using a data object:
 ALcdImage inputImage = ...;
 double[] kernel = new double[] {
     -1.0f, -1.0f, -1.0f,
     -1.0f,  9.0f, -1.0f,
     -1.0f, -1.0f, -1.0f
 };
 TLcdConvolveOp op = new TLcdConvolveOp();
 ILcdDataObject params = op.getParameterDataType().newInstance();
 params.setValue(TLcdConvolveOp.INPUT_IMAGE, inputImage);
 params.setValue(TLcdConvolveOp.KERNEL, kernel);
 params.setValue(TLcdConvolveOp.KERNEL_WIDTH, 3);
 params.setValue(TLcdConvolveOp.KERNEL_HEIGHT, 3);
 outputImage = op.apply(params);
 

Input

Output

Since:

2014.0

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.imaging.operator.ALcdImageOperator

ALcdImageOperator.ImageOperatorTypeBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDataType	CONVOLVE_FILTER_TYPE Input data type of the operator.
static TLcdDataProperty	INPUT_IMAGE The input image.
static TLcdDataProperty	KERNEL The convolution kernel in row-major order.
static TLcdDataProperty	KERNEL_HEIGHT Height of the convolution kernel.
static TLcdDataProperty	KERNEL_WIDTH Width of the convolution kernel.
static String	NAME Name of the operator.

Fields inherited from class com.luciad.imaging.operator.ALcdImageOperator

INPUT_IMAGE_NAME

Constructor Summary

Constructors

Constructor and Description
TLcdConvolveOp() Default constructor.

Method Summary

Modifier and Type	Method and Description
ALcdImage	apply(ILcdDataObject aParameters) Applies this operator to the given input parameters.
static ALcdImage	convolve(ALcdImage aImage, double[] aKernel, int aKernelWidth, int aKernelHeight) Applies a convolution kernel to the given image.

Methods inherited from class com.luciad.imaging.operator.ALcdImageOperator

createTypeBuilder, createTypeBuilder, equals, getParameterDataType, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final String NAME

Name of the operator.

See Also:

Constant Field Values

INPUT_IMAGE

public static final TLcdDataProperty INPUT_IMAGE

The input image.

KERNEL

public static final TLcdDataProperty KERNEL

The convolution kernel in row-major order.

KERNEL_WIDTH

public static final TLcdDataProperty KERNEL_WIDTH

Width of the convolution kernel.

KERNEL_HEIGHT

public static final TLcdDataProperty KERNEL_HEIGHT

Height of the convolution kernel.

CONVOLVE_FILTER_TYPE

public static final TLcdDataType CONVOLVE_FILTER_TYPE

Input data type of the operator.

Constructor Detail

TLcdConvolveOp

public TLcdConvolveOp()

Default constructor.

Method Detail

apply

public ALcdImage apply(ILcdDataObject aParameters)

Description copied from class: ALcdImageOperator

Applies this operator to the given input parameters. The parameters are stored in a data object which must be of the type given by ALcdImageOperator.getParameterDataType().

Specified by:

apply in class ALcdImageOperator

Parameters:

aParameters - the parameters for the operator

Returns:

the image produced by the operator

convolve

public static ALcdImage convolve(ALcdImage aImage,
                                 double[] aKernel,
                                 int aKernelWidth,
                                 int aKernelHeight)

Applies a convolution kernel to the given image. The convolution kernel is supplied as an array of doubles in row-major order. The length of the array must equal aKernelWidth x aKernelHeight.

Parameters:

aImage - the image to be convolved

aKernel - the convolution kernel, in row-major order

aKernelWidth - the width of the kernel

aKernelHeight - the height of the kernel

Returns:

the convolved image