edu.stanford.rsl.konrad.filtering
Class ImageMathFilter

java.lang.Object
  extended by edu.stanford.rsl.konrad.filtering.ImageFilteringTool
      extended by edu.stanford.rsl.konrad.filtering.IndividualImageFilteringTool
          extended by edu.stanford.rsl.konrad.filtering.ImageMathFilter
All Implemented Interfaces:
Citeable, GUIConfigurable, SafeSerializable, NamedParallelizableRunnable, ParallelizableRunnable, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable

public class ImageMathFilter
extends IndividualImageFilteringTool

See Also:
Serialized Form

Field Summary
static java.lang.String ADD
           
static java.lang.String DIVIDE
           
static java.lang.String MULTIPLY
           
static java.lang.String SUBTRACT
           
 
Constructor Summary
ImageMathFilter()
           
 
Method Summary
 ij.process.ImageProcessor applyToolToProcessor(ij.process.ImageProcessor imageProcessor)
          Is called in every thread to apply the tool to an individual ImageProcessor
 IndividualImageFilteringTool clone()
          All ImageFilteringTools need to be Cloneable in order to enable multiple processor usage.
 void configure()
          Configures the object before execution
 java.lang.String getBibtexCitation()
          Returns the citation in bibTex format
 java.lang.String getMedlineCitation()
          Returns the citation in Medline format
 java.lang.String getOperation()
           
 java.lang.String getToolName()
          returns the name of the actual tool which was used.
 boolean isDeviceDependent()
          The use may differ.
 void prepareForSerialization()
          Sets all data objects in the serialized object to null which do not implement the Serializable interface.
 void setOperation(java.lang.String operation)
           
 
Methods inherited from class edu.stanford.rsl.konrad.filtering.IndividualImageFilteringTool
applyToolToProcessor, getFilteredImageProcessor, getImageIndex, getProcessName, run, setImageIndex, setImageProcessor, setLatch
 
Methods inherited from class edu.stanford.rsl.konrad.filtering.ImageFilteringTool
getFilterTools, isConfigured, setConfigured, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ADD

public static final java.lang.String ADD
See Also:
Constant Field Values

SUBTRACT

public static final java.lang.String SUBTRACT
See Also:
Constant Field Values

MULTIPLY

public static final java.lang.String MULTIPLY
See Also:
Constant Field Values

DIVIDE

public static final java.lang.String DIVIDE
See Also:
Constant Field Values
Constructor Detail

ImageMathFilter

public ImageMathFilter()
Method Detail

prepareForSerialization

public 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
Overrides:
prepareForSerialization in class IndividualImageFilteringTool

applyToolToProcessor

public ij.process.ImageProcessor applyToolToProcessor(ij.process.ImageProcessor imageProcessor)
                                               throws java.lang.Exception
Description copied from class: IndividualImageFilteringTool
Is called in every thread to apply the tool to an individual ImageProcessor

Specified by:
applyToolToProcessor in class IndividualImageFilteringTool
Parameters:
imageProcessor - the ImageProcessor
Returns:
the filtered instance of the ImageProcessor
Throws:
java.lang.Exception

clone

public IndividualImageFilteringTool clone()
Description copied from class: IndividualImageFilteringTool
All ImageFilteringTools need to be Cloneable in order to enable multiple processor usage.

Specified by:
clone in class IndividualImageFilteringTool

getToolName

public java.lang.String getToolName()
Description copied from class: ImageFilteringTool
returns the name of the actual tool which was used.

Specified by:
getToolName in class ImageFilteringTool
Returns:
the name of the tool as string.

getBibtexCitation

public java.lang.String getBibtexCitation()
Description copied from interface: Citeable
Returns the citation in bibTex format

Returns:
citation as String

getMedlineCitation

public java.lang.String getMedlineCitation()
Description copied from interface: Citeable
Returns the citation in Medline format

Returns:
citation as String

getOperation

public java.lang.String getOperation()

setOperation

public void setOperation(java.lang.String operation)

configure

public void configure()
               throws java.lang.Exception
Description copied from interface: GUIConfigurable
Configures the object before execution

Throws:
java.lang.Exception - may happen

isDeviceDependent

public boolean isDeviceDependent()
The use may differ. Hence device dependency can be set. Is set during configuration.

Specified by:
isDeviceDependent in class ImageFilteringTool
Returns:
true if the method is device dependent.