Package com.xinapse.filter

Class SobelFilter

java.lang.Object
com.xinapse.filter.AbstractKernelFilter
com.xinapse.filter.FixedWeightsKernelFilter
com.xinapse.filter.SobelFilter
All Implemented Interfaces:
SpatialFilter
public class SobelFilter extends FixedWeightsKernelFilter implements SpatialFilter
A FixedWeightsKernelFilter for performing a Sobel filtering of an image.

  • Method Details

    • newInstance

      public static SpatialFilter newInstance(org.apache.commons.cli.CommandLine commandLine, ReadableImage image) throws InvalidArgumentException
      Creates a new SobelFilter 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 SobelFilter.
      Throws:
      InvalidArgumentException - if the filter cannot be created from the arguments.

    • new2DXInstance

      public static SobelFilter new2DXInstance(ReadableImage image)
      Creates a new 2-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the x-direction.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 2-D SobelFilter to obtain the intensity gradient in the x-direction.

    • new2DXInstance

      public static SobelFilter new2DXInstance(float pixelXSize)
      Creates a new 2-D SobelFilter suitable for filtering an image to obtain the intensity gradient in the x-direction.
      Parameters:
      pixelXSize - the pixel width of the image image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 2-D SobelFilter to obtain the intensity gradient in the x-direction.

    • new2DYInstance

      public static SobelFilter new2DYInstance(ReadableImage image)
      Creates a new 2-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the y-direction.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 2-D SobelFilter to obtain the intensity gradient in the y-direction.

    • new2DYInstance

      public static SobelFilter new2DYInstance(float pixelYSize)
      Creates a new 2-D SobelFilter suitable for filtering an image to obtain the intensity gradient in the y-direction.
      Parameters:
      pixelYSize - the pixel height of the image image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 2-D SobelFilter to obtain the intensity gradient in the y-direction.

    • new3DXInstance

      public static SobelFilter new3DXInstance(ReadableImage image)
      Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the x-direction.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the x-direction.

    • new3DXInstance

      public static SobelFilter new3DXInstance(float pixelXSize)
      Creates a new 3-D SobelFilter suitable for filtering an image to obtain the intensity gradient in the x-direction.
      Parameters:
      pixelXSize - the image horizontal pixel size used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the X-direction.

    • new3DYInstance

      public static SobelFilter new3DYInstance(ReadableImage image)
      Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the y-direction.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the y-direction.

    • new3DYInstance

      public static SobelFilter new3DYInstance(float pixelYSize)
      Creates a new 3-D SobelFilter suitable for filtering an image to obtain the intensity gradient in the y-direction.
      Parameters:
      pixelYSize - the image vertical pixel size used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the y-direction.

    • new3DZInstance

      public static SobelFilter new3DZInstance(ReadableImage image)
      Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the z-direction.
      Parameters:
      image - the image to which this filter is designed to apply. The image pixel size is used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the z-direction.

    • new3DZInstance

      public static SobelFilter new3DZInstance(float pixelZSize)
      Creates a new 3-D SobelFilter suitable for filtering an image to obtain the intensity gradient in the z-direction.
      Parameters:
      pixelZSize - the image slice thickness used to determine the kernel weights.
      Returns:
      new 3-D SobelFilter to obtain the intensity gradient in the z-direction.

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

    • getOptions

      public static org.apache.commons.cli.Options getOptions()
      Returns the options for this type of filter.
      Returns:
      the options for this type of filter.

    • getSpecifierPanel

      public static SpatialFilter.SpecifierPanel getSpecifierPanel(String preferencesNodeName)
      Returns a SpatialFilter.SpecifierPanel that can be used to set the parameters for a SobelFilter.
      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.