de.unihalle.informatik.MiToBo.filters.linear.anisotropic

Class OrientedFilter2D

java.lang.Object

de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.MiToBo.core.operator.MTBOperator

de.unihalle.informatik.MiToBo.filters.linear.anisotropic.OrientedFilter2D

All Implemented Interfaces:

de.unihalle.informatik.Alida.datatypes.ALDConfigurationValidator, de.unihalle.informatik.Alida.operator.events.ALDOperatorExecutionProgressEventListener, Cloneable, EventListener, loci.common.StatusReporter

Direct Known Subclasses:

ChaudhuriMatchedFilter2D, GaborFilter2D, GaussPDxFilter2D, GaussPDxxFilter2D

public abstract class OrientedFilter2D
extends MTBOperator
implements Cloneable, loci.common.StatusReporter

Base class for anisotropic linear filters in 2D.

This operator supports two modes how to compute the convolution. The first mode 'STANDARD' is based on the plain implementation of a convolution, i.e. relies on class LinearFilter. The second mode 'FFT' makes use of the fast implementations of convolutions available in ImgLib2. In particular, we apply FFT convolution which is almost two times faster than the implementation of linear filtering from scratch to be found in OrientedFilter2D.

Please note that the energy of the input image might be changed by the convolution if mode 'FFT' is applied since the masks of the anisotropic kernels are normalized to a sum of zero rather than 1 as usual.

The code for convolving the input image is leaned on example 6b to be found at the ImgLib2 web page.

Author:

Birgit Moeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrientedFilter2D.ApplicationMode Modes how to apply the filter to an image.

Nested classes/interfaces inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

de.unihalle.informatik.Alida.operator.ALDOperator.HidingMode, de.unihalle.informatik.Alida.operator.ALDOperator.HistoryConstructionMode

Field Summary

Fields

Modifier and Type	Field and Description
protected Double	angle Orientation of the filter.
protected MTBImage	inputImg Input image to process.
protected OrientedFilter2D.ApplicationMode	mode Mode of application.
protected MTBImageWindow.BoundaryPadding	paddingVariant Padding variant in standard convolutional mode.
protected MTBImageDouble	resultImg Filtered image.
protected Vector<loci.common.StatusListener>	statusListeners Vector of installed objects of type StatusListener.

Fields inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

completeDAG, name, operatorExecutionEventlistenerList, portHashAccess, verbose, versionProvider

Constructor Summary

Constructors

Constructor and Description
OrientedFilter2D() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addStatusListener(loci.common.StatusListener statuslistener)
abstract OrientedFilter2D	clone()
OrientedFilter2D.ApplicationMode	getApplicationMode() Get application mode.
abstract MTBImageDouble	getKernel(double _angle) Calculates kernel for the given orientation.
MTBImageDouble	getResultImage() Get result image.
void	notifyListeners(loci.common.StatusEvent e)
protected void	operate()
protected Object	readResolve() Init function for deserialized objects.
void	removeStatusListener(loci.common.StatusListener statuslistener)
void	setAngle(double _angle) Set orientation of filter.
void	setApplicationMode(OrientedFilter2D.ApplicationMode m) Set application mode for the filter.
void	setInputImage(MTBImage img) Set input image to analyze.
void	setPaddingVariant(MTBImageWindow.BoundaryPadding bp) Set padding variant to be used in standard convolutional mode.

Methods inherited from class de.unihalle.informatik.Alida.operator.ALDOperator

addOperatorExecutionProgressEventListener, addParameter, addParameter, addParameterUnconditioned, fieldContained, fireOperatorExecutionProgressEvent, getALDPortHashAccessKey, getConstructionMode, getDocumentation, getHidingMode, getInactiveParameterNames, getInInoutNames, getInInoutNames, getInNames, getInOutNames, getMissingRequiredInputs, getName, getNumParameters, getOutInoutNames, getOutNames, getParameter, getParameterDescriptor, getParameterDescriptorUnconditioned, getParameterNames, getParameterUnconditioned, getSupplementalNames, getVerbose, getVersion, handleOperatorExecutionProgressEvent, hasInOutParameters, hasParameter, isAnnotatedParameter, isConfigured, print, print, print, printInterface, printInterface, readHistory, reinitializeParameterDescriptors, removeOperatorExecutionProgressEventListener, removeParameter, runOp, runOp, runOp, setConstructionMode, setConstructionMode, setConstructionMode, setHidingMode, setName, setParameter, setParameterUnconditioned, setVerbose, toStringVerbose, unconfiguredItems, validate, validateCustom, validateGeneric, writeHistory, writeHistory, writeHistory

Methods inherited from class java.lang.Object

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

Field Detail

inputImg

@Parameter(label="Input Image",
           required=true,
           dataIOOrder=-10,
           direction=IN,
           mode=STANDARD,
           description="Input image.")
protected transient MTBImage inputImg

Input image to process.

angle

@Parameter(label="Orientation",
           required=true,
           dataIOOrder=-9,
           direction=IN,
           mode=STANDARD,
           description="Orientation of the filter to apply (in degrees).")
protected Double angle

Orientation of the filter.

mode

@Parameter(label="Application Mode",
           required=true,
           dataIOOrder=-8,
           direction=IN,
           mode=ADVANCED,
           description="Computation mode.")
protected OrientedFilter2D.ApplicationMode mode

Mode of application.

paddingVariant

@Parameter(label="Image padding variant",
           required=true,
           dataIOOrder=-7,
           direction=IN,
           mode=ADVANCED,
           description="Image padding variant in standard mode.")
protected MTBImageWindow.BoundaryPadding paddingVariant

Padding variant in standard convolutional mode.

The default value is set to zero padding for compatibility reasons. Note that ImgLib2 in FFT mode uses mirroring.

resultImg

@Parameter(label="Result Image",
           dataIOOrder=-10,
           direction=OUT,
           description="Result image.")
protected transient MTBImageDouble resultImg

Filtered image.

statusListeners

protected transient Vector<loci.common.StatusListener> statusListeners

Vector of installed objects of type StatusListener.

Constructor Detail

OrientedFilter2D

public OrientedFilter2D()
                 throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException

Default constructor.

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException - Thrown in case of failure.

Method Detail

readResolve

protected Object readResolve()

Description copied from class: MTBOperator

Init function for deserialized objects.

This function is called on an instance of this class being deserialized from file, prior to handing the instance over to the user. It takes care of a proper initialization of transient member variables as they are not initialized to the default values during deserialization.

Overrides:

readResolve in class MTBOperator

Returns:

Updated deserialized object.

clone

public abstract OrientedFilter2D clone()

Overrides:

clone in class Object

getKernel

public abstract MTBImageDouble getKernel(double _angle)

Calculates kernel for the given orientation.

Parameters:

_angle - Orientation of filter (in degrees).

Returns:

Kernel image.

operate

protected void operate()
                throws de.unihalle.informatik.Alida.exceptions.ALDOperatorException,
                       de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException

Specified by:

operate in class de.unihalle.informatik.Alida.operator.ALDOperator

Throws:

de.unihalle.informatik.Alida.exceptions.ALDOperatorException

de.unihalle.informatik.Alida.exceptions.ALDProcessingDAGException

setInputImage

public void setInputImage(MTBImage img)

Set input image to analyze.

Parameters:

img - Input image.

setAngle

public void setAngle(double _angle)

Set orientation of filter.

Parameters:

_angle - Orientation to use.

setApplicationMode

public void setApplicationMode(OrientedFilter2D.ApplicationMode m)

Set application mode for the filter.

Parameters:

m - Mode in which the filter should run.

setPaddingVariant

public void setPaddingVariant(MTBImageWindow.BoundaryPadding bp)

Set padding variant to be used in standard convolutional mode.

Note that in FFT mode always mirroring along the image edges is applied.

Parameters:

bp - Padding variant to be applied.

getApplicationMode

public OrientedFilter2D.ApplicationMode getApplicationMode()

Get application mode.

Returns:

Application mode.

getResultImage

public MTBImageDouble getResultImage()

Get result image.

Returns:

Filtered image.

addStatusListener

public void addStatusListener(loci.common.StatusListener statuslistener)

Specified by:

addStatusListener in interface loci.common.StatusReporter

notifyListeners

public void notifyListeners(loci.common.StatusEvent e)

Specified by:

notifyListeners in interface loci.common.StatusReporter

removeStatusListener

public void removeStatusListener(loci.common.StatusListener statuslistener)

Specified by:

removeStatusListener in interface loci.common.StatusReporter