com.xinapse.filter
Class SharpenFilter

java.lang.Object
  com.xinapse.filter.AbstractKernelFilter
      com.xinapse.filter.FixedWeightsKernelFilter
          com.xinapse.filter.LaplacianFilter
              com.xinapse.filter.SharpenFilter

All Implemented Interfaces:

SpatialFilter

public final class SharpenFilter
extends LaplacianFilter
implements SpatialFilter

A FixedWeightsKernelFilter for performing a sharpen filtering operation on an image.

Nested Class Summary

static class

SharpenFilter.SharpenSpecifierPanel A FilterSpecifierPanel for a sharpening filter.

Nested classes/interfaces inherited from class com.xinapse.filter.LaplacianFilter

LaplacianFilter.LaplacianSpecifierPanel

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 SpatialFilter.SpecifierPanel	getSpecifierPanel(java.lang.String preferencesNodeName) Returns a SpatialFilter.SpecifierPanel that can be used to set the parameters for a SharpenFilter.
static void	main(java.lang.String[] args) Runs a self-test of this class.
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.
static SharpenFilter	new2DInstance(LoadableImage image, int kernelSize) Creates a new 2-D SharpenFilter suitable for filtering the supplied image.
static SharpenFilter	new3DInstance(float pixelXSize, float pixelYSize, float pixelZSize, int kernelSize) Creates a new 3-D SharpenFilter suitable for sharpening an image.
static SharpenFilter	new3DInstance(LoadableImage image, int kernelSize) Creates a new 3-D SharpenFilter suitable for sharpening the supplied image.
static SharpenFilter	newInstance(org.apache.commons.cli.CommandLine commandLine, LoadableImage image) Creates a new SharpenFilter using the supplied command line arguments.

Methods inherited from class com.xinapse.filter.LaplacianFilter

getOptions

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

Throws:

com.xinapse.util.InvalidArgumentException

new2DInstance

public static SharpenFilter new2DInstance(LoadableImage 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:

a 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:

a SharpenFilter.

new3DInstance

public static SharpenFilter new3DInstance(LoadableImage 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.

Returns:

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

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.

getSpecifierPanel

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

Returns the human-readable name of this filter.

Returns:

the human-readable name of this filter.

main

public static void main(java.lang.String[] args)

Runs a self-test of this class.

Parameters:

args - the program aguments (ignored).