Class SobelFilter.MagnitudeFilter

java.lang.Object

com.xinapse.filter.SobelFilter.MagnitudeFilter

All Implemented Interfaces:

SpatialFilter

Enclosing class:

SobelFilter

public static final class SobelFilter.MagnitudeFilter
extends Object
implements SpatialFilter

A {SpatialFilter for producing the magnitude of the gradient of an image. This filter combines the x, y an z Sobel filters to calculate the magnitude of the gradient.

Nested Class Summary

Nested classes/interfaces inherited from interface SpatialFilter

SpatialFilter.SpecifierPanel

Field Summary

Fields inherited from interface SpatialFilter

FILTERING_STRING

Method Summary

Modifier and Type	Method	Description
WritableImage	filter(ReadableImage image, MonitorWorker worker, Logger logger)	Filter a ReadableImage, returning a new image which is a filtered version of the supplied image.
WritableImage	filter(ReadableImage image, Logger logger)	Filter a ReadableImage, returning a new image which is a filtered version of the supplied image.
void	filterInPlace(WritableImage image, MonitorWorker worker, Logger logger)	Filter a WritableImage "in place".
void	filterInPlace(WritableImage image, Logger logger)	Filter a WritableImage "in place".
void	filterInPlace(Object pixels, PixelDataType dataType, int nCols, int nRows, int nSlices, MonitorWorker worker, Logger logger)	Filter an array of pixel values "in place".
void	filterInPlace(Object pixels, PixelDataType dataType, int nCols, int nRows, int nSlices, Logger logger)	Filter an array of pixel values "in place".
static SobelFilter.MagnitudeFilter	new2DInstance(float pixelXSize, float pixelYSize)	Creates a new 2-D SobelFilter.MagnitudeFilter suitable for filtering images with the given pixel sizes, to obtain the magnitude of the intensity gradient.
static SobelFilter.MagnitudeFilter	new2DInstance(ReadableImage image)	Creates a new 2-D SobelFilter.MagnitudeFilter suitable for filtering the supplied image to obtain the magnitude of the intensity gradient.
static SobelFilter.MagnitudeFilter	new3DInstance(float pixelXSize, float pixelYSize, float pixelZSize)	Creates a new 3-D SobelFilter.MagnitudeFilter suitable for filtering images with the given pixel sizes, to obtain the magnitude of the intensity gradient.
static SobelFilter.MagnitudeFilter	new3DInstance(ReadableImage image)	Creates a new 3-D SobelFilter.MagnitudeFilter suitable for filtering the supplied image to obtain the magnitude of the intensity gradient.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

new2DInstance

public static SobelFilter.MagnitudeFilter new2DInstance(ReadableImage image)

Creates a new 2-D SobelFilter.MagnitudeFilter suitable for filtering the supplied image to obtain the magnitude of the intensity gradient.

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.MagnitudeFilter to obtain the magnitude of the intensity gradient.

new2DInstance

public static SobelFilter.MagnitudeFilter new2DInstance(float pixelXSize,
 float pixelYSize)

Creates a new 2-D SobelFilter.MagnitudeFilter suitable for filtering images with the given pixel sizes, to obtain the magnitude of the intensity gradient.

Parameters:

pixelXSize - the pixel width.

pixelYSize - the pixel height.

Returns:

new 2-D SobelFilter.MagnitudeFilter to obtain the magnitude of the intensity gradient.

new3DInstance

public static SobelFilter.MagnitudeFilter new3DInstance(ReadableImage image)

Creates a new 3-D SobelFilter.MagnitudeFilter suitable for filtering the supplied image to obtain the magnitude of the intensity gradient.

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.MagnitudeFilter to obtain the magnitude of the intensity gradient.

new3DInstance

public static SobelFilter.MagnitudeFilter new3DInstance(float pixelXSize,
 float pixelYSize,
 float pixelZSize)

Creates a new 3-D SobelFilter.MagnitudeFilter suitable for filtering images with the given pixel sizes, to obtain the magnitude of the intensity gradient.

Parameters:

pixelXSize - the pixel width.

pixelYSize - the pixel height.

pixelZSize - the slice thickness.

Returns:

new 3-D SobelFilter.MagnitudeFilter to obtain the magnitude of the intensity gradient.

filter

public WritableImage filter(ReadableImage image,
 Logger logger)
                     throws InvalidImageException,
IOException

Description copied from interface: SpatialFilter

Filter a ReadableImage, returning a new image which is a filtered version of the supplied image.

Specified by:

filter in interface SpatialFilter

Parameters:

image - the image to be filtered.

logger - the Logger for verbose reporting and error messages.

Returns:

a filtered version of the supplied image.

Throws:

InvalidImageException - if the supplied image cannot be filtered with this filter.

IOException - if an I/O error occurs.

filter

public WritableImage filter(ReadableImage image,
 MonitorWorker worker,
 Logger logger)
                     throws InvalidImageException,
IOException,
CancelledException

Description copied from interface: SpatialFilter

Filter a ReadableImage, returning a new image which is a filtered version of the supplied image.

Specified by:

filter in interface SpatialFilter

Parameters:

image - the image to be filtered.

worker - the MonitorWorker that may be used to cancel the filter operation.

logger - the Logger for verbose reporting and error messages.

Returns:

a filtered version of the supplied image.

Throws:

InvalidImageException - if the supplied image cannot be filtered with this filter.

IOException - if an I/O error occurs.

CancelledException - if the filter operation is cancelled by the user or programmatically.

filterInPlace

public void filterInPlace(WritableImage image,
 Logger logger)
                   throws InvalidImageException,
IOException

Description copied from interface: SpatialFilter

Filter a WritableImage "in place".

Specified by:

filterInPlace in interface SpatialFilter

Parameters:

image - the image to be filtered.

logger - the Logger for verbose reporting and error messages.

Throws:

InvalidImageException - if the supplied image cannot be filtered with this filter.

IOException - if an I/O error occurs.

filterInPlace

public void filterInPlace(WritableImage image,
 MonitorWorker worker,
 Logger logger)
                   throws InvalidImageException,
IOException,
CancelledException

Description copied from interface: SpatialFilter

Filter a WritableImage "in place".

Specified by:

filterInPlace in interface SpatialFilter

Parameters:

image - the image to be filtered.

worker - the MonitorWorker that may be used to cancel the filter operation.

logger - the Logger for verbose reporting and error messages.

Throws:

InvalidImageException - if the supplied image cannot be filtered with this filter.

IOException - if an I/O error occurs.

CancelledException - if the filter operation is cancelled by the user or programmatically.

filterInPlace

public void filterInPlace(Object pixels,
 PixelDataType dataType,
 int nCols,
 int nRows,
 int nSlices,
 Logger logger)

Description copied from interface: SpatialFilter

Filter an array of pixel values "in place".

Specified by:

filterInPlace in interface SpatialFilter

Parameters:

pixels - the array of image pixel values.

dataType - the PixelDataType of the pixels.

nCols - the number of image columns.

nRows - the number of image rows.

nSlices - the number of image slices.

logger - the Logger for verbose reporting and error messages.

filterInPlace

public void filterInPlace(Object pixels,
 PixelDataType dataType,
 int nCols,
 int nRows,
 int nSlices,
 MonitorWorker worker,
 Logger logger)
                   throws CancelledException

Description copied from interface: SpatialFilter

Filter an array of pixel values "in place".

Specified by:

filterInPlace in interface SpatialFilter

Parameters:

pixels - the array of image pixel values.

dataType - the PixelDataType of the pixels.

nCols - the number of image columns.

nRows - the number of image rows.

nSlices - the number of image slices.

worker - the MonitorWorker that may be used to cancel the filter operation.

logger - the Logger for verbose reporting and error messages.

Throws:

CancelledException - if the filter operation is cancelled by the user or programmatically.