public class

Kernel

extends Object
implements Cloneable
java.lang.Object
   ↳ java.awt.image.Kernel

Class Overview

The Kernel class defines a matrix that describes how a specified pixel and its surrounding pixels affect the value computed for the pixel's position in the output image of a filtering operation. The X origin and Y origin indicate the kernel matrix element that corresponds to the pixel position for which an output value is being computed.

See Also

Summary

Public Constructors
Kernel(int width, int height, float[] data)
Constructs a Kernel object from an array of floats.
Public Methods
Object clone()
Clones this object.
final int getHeight()
Returns the height of this Kernel.
final float[] getKernelData(float[] data)
Returns the kernel data in row major order.
final int getWidth()
Returns the width of this Kernel.
final int getXOrigin()
Returns the X origin of this Kernel.
final int getYOrigin()
Returns the Y origin of this Kernel.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Kernel (int width, int height, float[] data)

Constructs a Kernel object from an array of floats. The first width*height elements of the data array are copied. If the length of the data array is less than width*height, an IllegalArgumentException is thrown. The X origin is (width-1)/2 and the Y origin is (height-1)/2.

Parameters
width width of the kernel
height height of the kernel
data kernel data in row major order
Throws
IllegalArgumentException if the length of data is less than the product of width and height

Public Methods

public Object clone ()

Clones this object.

Returns
  • a clone of this object.

public final int getHeight ()

Returns the height of this Kernel.

Returns
  • the height of this Kernel.

public final float[] getKernelData (float[] data)

Returns the kernel data in row major order. The data array is returned. If data is null, a new array is allocated.

Parameters
data if non-null, contains the returned kernel data
Returns
  • the data array containing the kernel data in row major order or, if data is null, a newly allocated array containing the kernel data in row major order
Throws
IllegalArgumentException if data is less than the size of this Kernel

public final int getWidth ()

Returns the width of this Kernel.

Returns
  • the width of this Kernel.

public final int getXOrigin ()

Returns the X origin of this Kernel.

Returns
  • the X origin.

public final int getYOrigin ()

Returns the Y origin of this Kernel.

Returns
  • the Y origin.