Class SharpenFilter

All Implemented Interfaces:
SpatialFilter

public final class SharpenFilter extends LaplacianFilter implements SpatialFilter
A FixedWeightsKernelFilter for performing a sharpen filtering operation on an image.
  • Method Details

    • newInstance

      public static SharpenFilter newInstance(org.apache.commons.cli.CommandLine commandLine, ReadableImage image) throws InvalidArgumentException
      Creates a new SharpenFilter using the supplied command line arguments.
      Parameters:
      commandLine - the command line from which a program is invoked.
      image - the image to which this filter is designed to apply.
      Returns:
      a new SharpenFilter.
      Throws:
      InvalidArgumentException - if the filter cannot be created from the arguments.
    • new2DInstance

      public static SharpenFilter new2DInstance(ReadableImage image, int kernelSize)
      Creates a new 2-D SharpenFilter suitable for filtering the supplied image.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to scale the kernel weights.
      kernelSize - the (odd) kernel size for the filter.
      Returns:
      new 2-D SharpenFilter.
    • new2DInstance

      public static SharpenFilter new2DInstance(float pixelXSize, float pixelYSize, int kernelSize)
      Creates a new 2-D SharpenFilter suitable for filtering an image with the given pixel sizes.
      Parameters:
      pixelXSize - the pixel width.
      pixelYSize - the pixel height.
      kernelSize - the (odd) kernel size for the filter.
      Returns:
      new 2-D SharpenFilter.
    • new3DInstance

      public static SharpenFilter new3DInstance(ReadableImage image, int kernelSize) throws InvalidImageException
      Creates a new 3-D SharpenFilter suitable for sharpening the supplied image.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel sizes are used to determine the kernel weights.
      kernelSize - the (odd) kernel size for the filter.
      Returns:
      new 3-D SharpenFilter.
      Throws:
      InvalidImageException - if the supplied image is invalid.
    • new3DInstance

      public static SharpenFilter new3DInstance(float pixelXSize, float pixelYSize, float pixelZSize, int kernelSize)
      Creates a new 3-D SharpenFilter suitable for sharpening an image.
      Parameters:
      pixelXSize - the image horizontal pixel size used to determine the kernel weights.
      pixelYSize - the image vertical pixel size used to determine the kernel weights.
      pixelZSize - the image slice thickness used to determine the kernel weights.
      kernelSize - the (odd) kernel size for the filter.
      Returns:
      new 3-D SharpenFilter.
    • getOptionName

      public static String getOptionName()
      Returns the name of this type of filter when specifying it in program optional arguments.
      Returns:
      the name of the filter for selection in program arguments.
    • getSpecifierPanel

      public static SpatialFilter.SpecifierPanel getSpecifierPanel(String preferencesNodeName)
      Returns a SpatialFilter.SpecifierPanel that can be used to set the parameters for a SharpenFilter.
      Parameters:
      preferencesNodeName - the preferences node name from which the initial settings will be taken.
      Returns:
      a SpatialFilter.SpecifierPanel to set the parameters for this type of filter.
    • getName

      public static String getName()
      Returns the human-readable name of this filter.
      Returns:
      the human-readable name of this filter.
    • main

      public static void main(String[] args)
      Runs a self-test of this class.
      Parameters:
      args - the program aguments (ignored).