edu.stanford.rsl.konrad.pipeline
Class IndividualImagePipelineFilteringTool

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.pipeline.IndividualImagePipelineFilteringTool
All Implemented Interfaces:
Citeable, GUIConfigurable, SafeSerializable, NamedParallelizableRunnable, ParallelizableRunnable, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable
Direct Known Subclasses:
ExtremeValueTruncationFilter

public class IndividualImagePipelineFilteringTool
extends IndividualImageFilteringTool

Class to describe the thread which runs in a parallel image pipeline. In the end data is written into the ProjectionDataSink

Author:
Andreas Maier
See Also:
Serialized Form

Constructor Summary
IndividualImagePipelineFilteringTool()
           
 
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
 ImageFilteringTool[] getPipeline()
           
 ProjectionSource getProjectionSource()
           
 ProjectionSink getSink()
           
 java.lang.String getToolName()
          returns the name of the actual tool which was used.
 boolean isDeviceDependent()
          returns true, if the filter models or compensates device dependent, i.e.
 void run()
          This method performs the filtering and the projection on one frame, i.e., one projection image.
 void setPipeline(IndividualImageFilteringTool[] tools)
           
 void setProjectionSource(ProjectionSource projectionSource)
           
 void setSink(ProjectionSink sink)
           
 
Methods inherited from class edu.stanford.rsl.konrad.filtering.IndividualImageFilteringTool
applyToolToProcessor, getFilteredImageProcessor, getImageIndex, getProcessName, prepareForSerialization, 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
 

Constructor Detail

IndividualImagePipelineFilteringTool

public IndividualImagePipelineFilteringTool()
Method Detail

getToolName

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

Specified by:
getToolName in class ImageFilteringTool
Returns:
the tool name

setPipeline

public void setPipeline(IndividualImageFilteringTool[] tools)

getPipeline

public ImageFilteringTool[] getPipeline()

setSink

public void setSink(ProjectionSink sink)

getSink

public ProjectionSink getSink()

setProjectionSource

public void setProjectionSource(ProjectionSource projectionSource)

getProjectionSource

public ProjectionSource getProjectionSource()

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

run

public void run()
This method performs the filtering and the projection on one frame, i.e., one projection image.

Specified by:
run in interface java.lang.Runnable
Overrides:
run in class IndividualImageFilteringTool

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()
Description copied from class: ImageFilteringTool
returns true, if the filter models or compensates device dependent, i.e. physical characteristics.

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

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