edu.stanford.rsl.konrad.filtering
Class ImageFilteringTool

java.lang.Object
  extended by edu.stanford.rsl.konrad.filtering.ImageFilteringTool
All Implemented Interfaces:
Citeable, GUIConfigurable, SafeSerializable, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
IndividualImageFilteringTool, MultiProjectionFilter

public abstract class ImageFilteringTool
extends java.lang.Object
implements java.lang.Cloneable, SafeSerializable, GUIConfigurable, Citeable

Abstract class to describe the blue print of an ImageFilteringTool. In order to be executed in a parallel manner it needs to be Cloneable.

Author:
Andreas Maier
See Also:
Serialized Form

Constructor Summary
ImageFilteringTool()
           
 
Method Summary
abstract  ImageFilteringTool clone()
          Creates a clone of the filter with the same configuration as the original.
static ImageFilteringTool[] getFilterTools()
          Gives an Array with default instances of all known image filters.
abstract  java.lang.String getToolName()
          returns the name of the actual tool which was used.
 boolean isConfigured()
          Is true if the object was successfully configured
abstract  boolean isDeviceDependent()
          returns true, if the filter models or compensates device dependent, i.e.
abstract  void prepareForSerialization()
          Sets all data objects in the serialized object to null which do not implement the Serializable interface.
 void setConfigured(boolean configured)
           
 java.lang.String toString()
          returns getToolName();
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface edu.stanford.rsl.apps.gui.GUIConfigurable
configure
 
Methods inherited from interface edu.stanford.rsl.apps.gui.Citeable
getBibtexCitation, getMedlineCitation
 

Constructor Detail

ImageFilteringTool

public ImageFilteringTool()
Method Detail

isDeviceDependent

public abstract boolean isDeviceDependent()
returns true, if the filter models or compensates device dependent, i.e. physical characteristics.

Returns:
true if the method is device dependent.

getToolName

public abstract java.lang.String getToolName()
returns the name of the actual tool which was used.

Returns:
the name of the tool as string.

toString

public java.lang.String toString()
returns getToolName();

Overrides:
toString in class java.lang.Object

getFilterTools

public static ImageFilteringTool[] getFilterTools()
Gives an Array with default instances of all known image filters.

Returns:
the array of known ImageFilteringTools

prepareForSerialization

public abstract void prepareForSerialization()
Description copied from interface: SafeSerializable
Sets all data objects in the serialized object to null which do not implement the Serializable interface. It can also be used to save space in the serialized form. Configuration parameters are preserved. Processing data is discarded.

Specified by:
prepareForSerialization in interface SafeSerializable

clone

public abstract ImageFilteringTool clone()
Creates a clone of the filter with the same configuration as the original.

Overrides:
clone in class java.lang.Object

isConfigured

public boolean isConfigured()
Description copied from interface: GUIConfigurable
Is true if the object was successfully configured

Specified by:
isConfigured in interface GUIConfigurable
Returns:
the configured

setConfigured

public void setConfigured(boolean configured)
Parameters:
configured - the configured to set