java.awt.image
Class Kernel
- java.lang.Object
-
- java.awt.image.Kernel
-
- All Implemented Interfaces:
- Cloneable
public class Kernel extends Object implements Cloneable
TheKernelclass 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:
-
ConvolveOp
-
-
Constructor Summary
Constructors Constructor and Description Kernel(int width, int height, float[] data)Constructs aKernelobject from an array of floats.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Objectclone()Clones this object.intgetHeight()Returns the height of thisKernel.float[]getKernelData(float[] data)Returns the kernel data in row major order.intgetWidth()Returns the width of thisKernel.intgetXOrigin()Returns the X origin of thisKernel.intgetYOrigin()Returns the Y origin of thisKernel.
-
-
-
Constructor Detail
Kernel
public Kernel(int width, int height, float[] data)Constructs aKernelobject from an array of floats. The firstwidth*heightelements of thedataarray are copied. If the length of thedataarray is less than width*height, anIllegalArgumentExceptionis 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 ofdatais less than the product ofwidthandheight
-
Method Detail
getXOrigin
public final int getXOrigin()
Returns the X origin of thisKernel.- Returns:
- the X origin.
getYOrigin
public final int getYOrigin()
Returns the Y origin of thisKernel.- Returns:
- the Y origin.
getWidth
public final int getWidth()
Returns the width of thisKernel.- Returns:
-
the width of this
Kernel.
getHeight
public final int getHeight()
Returns the height of thisKernel.- Returns:
-
the height of this
Kernel.
getKernelData
public final float[] getKernelData(float[] data)
Returns the kernel data in row major order. Thedataarray is returned. Ifdataisnull, a new array is allocated.- Parameters:
-
data- if non-null, contains the returned kernel data - Returns:
-
the
dataarray containing the kernel data in row major order or, ifdataisnull, a newly allocated array containing the kernel data in row major order - Throws:
-
IllegalArgumentException- ifdatais less than the size of thisKernel
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
