edu.stanford.rsl.konrad.filtering
Class MeanFilteringTool

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.MeanFilteringTool
All Implemented Interfaces:
Citeable, GUIConfigurable, SafeSerializable, NamedParallelizableRunnable, ParallelizableRunnable, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable

public class MeanFilteringTool
extends IndividualImageFilteringTool

See Also:
Serialized Form

Constructor Summary
MeanFilteringTool()
           
 
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
 void configure(int kernelWidth, int kernelHeight)
           
static float[] createKernel(int kernelWidth, int kernelHeight)
           
 java.lang.String getBibtexCitation()
          Returns the citation in bibTex format
 float[] getKernel()
           
 int getKernelHeight()
           
 int getKernelWidth()
           
 java.lang.String getMedlineCitation()
          Returns the citation in Medline format
 java.lang.String getToolName()
          returns the name of the actual tool which was used.
 boolean isDeviceDependent()
          is an image filter for noise reduction and hence not device dependent.
 void setKernel(float[] kernel)
           
 void setKernelHeight(int kernelHeight)
           
 void setKernelWidth(int kernelWidth)
           
 
Methods inherited from class edu.stanford.rsl.konrad.filtering.IndividualImageFilteringTool
applyToolToProcessor, getFilteredImageProcessor, getImageIndex, getProcessName, prepareForSerialization, 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
 

Constructor Detail

MeanFilteringTool

public MeanFilteringTool()
Method Detail

applyToolToProcessor

public ij.process.ImageProcessor applyToolToProcessor(ij.process.ImageProcessor imageProcessor)
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

createKernel

public static float[] createKernel(int kernelWidth,
                                   int kernelHeight)

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

getKernel

public float[] getKernel()

setKernel

public void setKernel(float[] kernel)

getKernelWidth

public int getKernelWidth()

setKernelWidth

public void setKernelWidth(int kernelWidth)

getKernelHeight

public int getKernelHeight()

setKernelHeight

public void setKernelHeight(int kernelHeight)

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.

configure

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

Throws:
java.lang.Exception - may happen

configure

public void configure(int kernelWidth,
                      int kernelHeight)

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

isDeviceDependent

public boolean isDeviceDependent()
is an image filter for noise reduction and hence not device dependent.

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