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.

Nested Class Summary

static class	SobelFilter.SobelSpecifierPanel A FilterSpecifierPanel for a Sobel edge-detection filter.
static class	SobelFilter.SobelType An enumeration of the types of Sobel filters.

Nested classes/interfaces inherited from interface com.xinapse.filter.SpatialFilter

SpatialFilter.SpecifierPanel

Field Summary

Fields inherited from class com.xinapse.filter.FixedWeightsKernelFilter

weights

Fields inherited from interface com.xinapse.filter.SpatialFilter

N_DOTS

Method Summary

static java.lang.String	getName() Returns the human-readable name of this filter.
static java.lang.String	getOptionName() Returns the name of this type of filter when specifying it in program optional arguments.
static org.apache.commons.cli.Options	getOptions() Returns the options for this type of filter.
static SpatialFilter.SpecifierPanel	getSpecifierPanel(java.lang.String preferencesNodeName) Returns a SpatialFilter.SpecifierPanel that can be used to set the parameters for a SobelFilter.
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.
static SobelFilter	new2DXInstance(LoadableImage image) Creates a new 2-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the x-direction.
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.
static SobelFilter	new2DYInstance(LoadableImage image) Creates a new 2-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the y-direction.
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.
static SobelFilter	new3DXInstance(LoadableImage image) Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the x-direction.
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.
static SobelFilter	new3DYInstance(LoadableImage image) Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the y-direction.
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.
static SobelFilter	new3DZInstance(LoadableImage image) Creates a new 3-D SobelFilter suitable for filtering the supplied image to obtain the intensity gradient in the z-direction.
static SpatialFilter	newInstance(org.apache.commons.cli.CommandLine commandLine, LoadableImage image) Creates a new SobelFilter using the supplied command line arguments.

Methods inherited from class com.xinapse.filter.FixedWeightsKernelFilter

add, add, convolve, copyResize, filterInPlaceBinary, filterInPlaceByte, filterInPlaceDouble, filterInPlaceFloat, filterInPlaceInt, filterInPlaceLong, filterInPlaceShort, filterInPlaceUByte, filterInPlaceUInt, filterInPlaceUShort, getNKernelCols, getNKernelRows, getNKernelSlices, scale, sumWeights, toString

Methods inherited from class com.xinapse.filter.AbstractKernelFilter

filter, filter, filter, filterInPlace, filterInPlace, filterInPlace, filterInPlace, filterInPlace, filterInPlace, filterInPlace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xinapse.filter.SpatialFilter

filter, filter, filterInPlace, filterInPlace, filterInPlace, filterInPlace

Method Detail

newInstance

public static SpatialFilter newInstance(org.apache.commons.cli.CommandLine commandLine,
                                        LoadableImage image)
                                 throws com.xinapse.util.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.

Throws:

com.xinapse.util.InvalidArgumentException

new2DXInstance

public static SobelFilter new2DXInstance(LoadableImage 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.

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.

new2DYInstance

public static SobelFilter new2DYInstance(LoadableImage 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.

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.

new3DXInstance

public static SobelFilter new3DXInstance(LoadableImage 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.

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.

new3DYInstance

public static SobelFilter new3DYInstance(LoadableImage 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.

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.

new3DZInstance

public static SobelFilter new3DZInstance(LoadableImage 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.

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.

getOptionName

public static java.lang.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(java.lang.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 java.lang.String getName()

Returns the human-readable name of this filter.

Returns:

the human-readable name of this filter.