Class GeneralFilterFunction

java.lang.Object
com.bc.ceres.jai.GeneralFilterFunction
Direct Known Subclasses:
GeneralFilterFunction.Dilation, GeneralFilterFunction.Erosion, GeneralFilterFunction.Max, GeneralFilterFunction.Mean, GeneralFilterFunction.Median, GeneralFilterFunction.Min, GeneralFilterFunction.StdDev

public abstract class GeneralFilterFunction extends Object
A general filter function. This class is used as parameter for the GeneralFilter operation.
  • Field Details

    • width

      protected final int width
    • height

      protected final int height
    • xOrigin

      protected final int xOrigin
    • yOrigin

      protected final int yOrigin
    • structuringElement

      protected final boolean[] structuringElement
  • Constructor Details

    • GeneralFilterFunction

      protected GeneralFilterFunction(int width, int height, int xOrigin, int yOrigin, boolean[] structuringElement)
      Constructs a GeneralFilterFunction.
      Parameters:
      width - the width of the kernel.
      height - the height of the kernel.
      xOrigin - the X coordinate of the key kernel element.
      yOrigin - the Y coordinate of the key kernel element.
      structuringElement - The structuring element with a length equal to width * height. May be null.
  • Method Details

    • getWidth

      public final int getWidth()
      Returns:
      the width of the kernel.
    • getHeight

      public final int getHeight()
      Returns:
      the height of the kernel.
    • getXOrigin

      public final int getXOrigin()
      Returns:
      the X coordinate of the key kernel element.
    • getYOrigin

      public final int getYOrigin()
      Returns:
      the Y coordinate of the key kernel element.
    • getLeftPadding

      public final int getLeftPadding()
      Returns:
      the number of pixels required to the left of the key element.
    • getRightPadding

      public final int getRightPadding()
      Returns:
      the number of pixels required to the right of the key element.
    • getTopPadding

      public final int getTopPadding()
      Returns:
      the number of pixels required above the key element.
    • getBottomPadding

      public final int getBottomPadding()
      Returns:
      the number of pixels required below the key element.
    • getStructuringElement

      public boolean[] getStructuringElement()
    • filter

      public abstract float filter(float[] fdata)