java.awt.image

Class Kernel

public class Kernel extends Object implements Cloneable

Kernel represents an image processing kernel. It gets used to hold convolution filters among other purposes. It stores an array of float values representing a 2-dimensional array in row-major order.

Constructor Summary
	Kernel(int width, int height, float[] data) Creates a new `Kernel` instance with the specified dimensions and values.

Method Summary
Object	clone() Returns a clone of this kernel.
int	getHeight() Returns the kernel height (as supplied to the constructor).
float[]	getKernelData(float[] data) Returns an array containing a copy of the kernel data.
int	getWidth() Returns the kernel width (as supplied to the constructor).
int	getXOrigin() Returns the x-origin for the kernel, which is calculated as `(width - 1) / 2`.
int	getYOrigin() Returns the y-origin for the kernel, which is calculated as `(height - 1) / 2`.

Constructor Detail

Kernel

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

Creates a new Kernel instance with the specified dimensions and values. The first width * height values in the specified data array are copied to internal storage.

Parameters: width the kernel width. height the kernel height. data the source data array (null not permitted).

Throws: IllegalArgumentException if data.length is less than width * height. IllegalArgumentException if width or height is less than zero. NullPointerException if data is null.

Method Detail

clone

public Object clone()

Returns a clone of this kernel.

Returns: a clone of this Kernel.

getHeight

public final int getHeight()

Returns the kernel height (as supplied to the constructor).

Returns: The kernel height.

getKernelData

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

Returns an array containing a copy of the kernel data. If the data argument is non-null, the kernel values are copied into it and then data is returned as the result. If the data argument is null, this method allocates a new array then populates and returns it.

Parameters: data an array to copy the return values into (if null, a new array is allocated).

Returns: The array with copied values.

Throws: IllegalArgumentException if data.length is less than the kernel's width * height.

getWidth

public final int getWidth()

Returns the kernel width (as supplied to the constructor).

Returns: The kernel width.

getXOrigin

public final int getXOrigin()

Returns the x-origin for the kernel, which is calculated as (width - 1) / 2.

Returns: The x-origin for the kernel.

getYOrigin

public final int getYOrigin()

Returns the y-origin for the kernel, which is calculated as (height - 1) / 2.

Returns: The y-origin for the kernel.