com.xinapse.filter
Interface SpatialFilter

All Known Implementing Classes:

AbstractKernelFilter, FixedWeightsKernelFilter, GaussianBlurFilter, LaplacianFilter, MedianFilter, MorphologicalOperator, SharpenFilter, SobelFilter

public interface SpatialFilter

Interface implemented by classes that can spatially filter images.

Nested Class Summary

static class

SpatialFilter.SpecifierPanel A JPanel that can be used to specify spatial filter parameters.

Field Summary

static int

N_DOTS The number of dots to show as the filter progresses.

Method Summary

MultiSliceImage	filter(MultiSliceImage image) Filter a MultiSliceImage, returning a new image which is a filtered version of the supplied image.
MultiSliceImage	filter(MultiSliceImage image, MonitorWorker worker, boolean verbose) Filter a MultiSliceImage, returning a new image which is a filtered version of the supplied image.
void	filterInPlace(MultiSliceImage image) Filter a MultiSliceImage "in place".
void	filterInPlace(MultiSliceImage image, MonitorWorker worker, boolean verbose) Filter a MultiSliceImage "in place".
void	filterInPlace(java.lang.Object pixels, PixelDataType dataType, int nCols, int nRows, int nSlices) Filter an array of pixel values "in place".
void	filterInPlace(java.lang.Object pixels, PixelDataType dataType, int nCols, int nRows, int nSlices, MonitorWorker worker, boolean verbose) Filter an array of pixel values "in place".

Field Detail

N_DOTS

static final int N_DOTS

The number of dots to show as the filter progresses.

See Also:

Constant Field Values

Method Detail

filter

MultiSliceImage filter(MultiSliceImage image)
                       throws InvalidImageException

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

Parameters:

image - the image to be filtered.

Returns:

a filtered version of the supplied image.

Throws:

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

filter

MultiSliceImage filter(MultiSliceImage image,
                       MonitorWorker worker,
                       boolean verbose)
                       throws InvalidImageException,
                              CancelledException

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

Parameters:

image - the image to be filtered.

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

verbose - whether verbose reporting to System.out is turned on.

Throws:

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

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

filterInPlace

void filterInPlace(MultiSliceImage image)
                   throws InvalidImageException

Filter a MultiSliceImage "in place".

Parameters:

image - the image to be filtered.

Throws:

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

filterInPlace

void filterInPlace(MultiSliceImage image,
                   MonitorWorker worker,
                   boolean verbose)
                   throws InvalidImageException,
                          CancelledException

Filter a MultiSliceImage "in place".

Parameters:

image - the image to be filtered.

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

verbose - whether verbose reporting to System.out is turned on.

Throws:

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

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

filterInPlace

void filterInPlace(java.lang.Object pixels,
                   PixelDataType dataType,
                   int nCols,
                   int nRows,
                   int nSlices)

Filter an array of pixel values "in place".

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.

filterInPlace

void filterInPlace(java.lang.Object pixels,
                   PixelDataType dataType,
                   int nCols,
                   int nRows,
                   int nSlices,
                   MonitorWorker worker,
                   boolean verbose)
                   throws CancelledException

Filter an array of pixel values "in place".

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.

verbose - whether verbose reporting to System.out is turned on.

Throws:

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