java.awt.image

Class Kernel

Implemented Interfaces:
Cloneable

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.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Kernel

public Kernel(int width,
              int height,
              float[] data)
            throws IllegalArgumentException
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 Details

clone

public Object clone()
Returns a clone of this kernel.
Overrides:
clone in interface Object
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)
            throws IllegalArgumentException
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.

Kernel.java -- Java class for an image processing kernel Copyright (C) 2004, 2005, 2006, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.