Module java.desktop
Package java.awt.image

Class Kernel

  • All Implemented Interfaces:
    Cloneable

    public classKernelextendsObjectimplementsCloneable
    TheKernel 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:
    ConvolveOp

    • Constructor Detail

      • Kernel

        public Kernel(int width,              int height,              float[] data)
        Constructs aKernel object from an array of floats. The firstwidth*height elements of thedata array are copied. If the length of thedata array is less than width*height, anIllegalArgumentException 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 ofdata is less than the product ofwidth andheight

    • 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 thisKernel.

      • getHeight

        public final int getHeight()
        Returns the height of thisKernel.
        Returns:
        the height of thisKernel.

      • getKernelData

        public final float[] getKernelData(float[] data)
        Returns the kernel data in row major order. Thedata array is returned. Ifdata isnull, a new array is allocated.
        Parameters:
        data - if non-null, contains the returned kernel data
        Returns:
        thedata array containing the kernel data in row major order or, ifdata isnull, a newly allocated array containing the kernel data in row major order
        Throws:
        IllegalArgumentException - ifdata is less than the size of thisKernel