edu.stanford.rsl.konrad.filtering
Class PrimaryModulationScatterCorrectionTool

java.lang.Object
  extended by edu.stanford.rsl.konrad.filtering.ImageFilteringTool
      extended by edu.stanford.rsl.konrad.filtering.multiprojection.MultiProjectionFilter
          extended by edu.stanford.rsl.konrad.filtering.PrimaryModulationScatterCorrectionTool
All Implemented Interfaces:
Citeable, GUIConfigurable, SafeSerializable, ProjectionSink, java.io.Serializable, java.lang.Cloneable, java.lang.Runnable

public class PrimaryModulationScatterCorrectionTool
extends MultiProjectionFilter

This is the comment $\alpha$

Author:
Hewei
See Also:
Serialized Form

Constructor Summary
PrimaryModulationScatterCorrectionTool()
           
 
Method Summary
 ij.process.ImageProcessor applyToolToProcessorOld(ij.process.ImageProcessor imageProc)
           
 ImageFilteringTool clone()
          Creates a clone of the filter with the same configuration as the original.
 void configure()
          Configures the object before execution
 java.lang.String getBibtexCitation()
          Returns the citation in bibTex format
 double getGaincutfactor()
           
 double getLowPassFilterHeight()
           
 double getLowPassFilterWidth()
           
 int getMeanfilterLen()
           
 java.lang.String getMedlineCitation()
          Returns the citation in Medline format
static ij.ImagePlus getModulationFunction(java.lang.String filename)
          Loads the modulation function from disk if required.
 java.lang.String getModulationFunctionFilename()
           
 double getScatterEstScale()
           
 double getSoftcutfactor()
           
 java.lang.String getToolName()
          returns the name of the actual tool which was used.
 boolean isbUniformAlpha()
           
 boolean isDeviceDependent()
          Scatter correction is not device dependent.
 void prepareForSerialization()
          Sets all data objects in the serialized object to null which do not implement the Serializable interface.
 void setbUniformAlpha(boolean bUniformAlpha)
           
 void setGaincutfactor(double gaincutfactor)
           
 void setLowPassFilterHeight(double lowPassFilterHeight)
           
 void setLowPassFilterWidth(double lPassFilterWidth)
           
 void setMeanfilterLen(int meanfilterLen)
           
 void setModulationFunctionFilename(java.lang.String modulationFunctionFilename)
           
 void setScatterEstScale(double scatterEstScale)
           
 void setSoftcutfactor(double softcutfactor)
           
 
Methods inherited from class edu.stanford.rsl.konrad.filtering.multiprojection.MultiProjectionFilter
close, feedFilter, getContext, getName, process, run, setContext, setShowStatus, setSink, start
 
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

PrimaryModulationScatterCorrectionTool

public PrimaryModulationScatterCorrectionTool()
Method Detail

getLowPassFilterWidth

public double getLowPassFilterWidth()
Returns:
the lowPassFilterWidth

setLowPassFilterWidth

public void setLowPassFilterWidth(double lPassFilterWidth)
Parameters:
lowPassFilterWidth - the lowPassFilterWidth to set

getLowPassFilterHeight

public double getLowPassFilterHeight()
Returns:
the lowPassFilterHeight

setLowPassFilterHeight

public void setLowPassFilterHeight(double lowPassFilterHeight)
Parameters:
lowPassFilterHeight - the lowPassFilterHeight to set

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 MultiProjectionFilter

getModulationFunction

public static ij.ImagePlus getModulationFunction(java.lang.String filename)
Loads the modulation function from disk if required. Will buffer the image for later use.

Parameters:
filename - the filename
Returns:
the modulation function as ImagePlus

clone

public ImageFilteringTool clone()
Description copied from class: ImageFilteringTool
Creates a clone of the filter with the same configuration as the original.

Specified by:
clone in class ImageFilteringTool

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

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()
Scatter correction is not device dependent.

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

applyToolToProcessorOld

public ij.process.ImageProcessor applyToolToProcessorOld(ij.process.ImageProcessor imageProc)

getModulationFunctionFilename

public java.lang.String getModulationFunctionFilename()
Returns:
the modulationFunctionFilename

setModulationFunctionFilename

public void setModulationFunctionFilename(java.lang.String modulationFunctionFilename)
Parameters:
modulationFunctionFilename - the modulationFunctionFilename to set

getMeanfilterLen

public int getMeanfilterLen()
Returns:
the meanfilterLen

setMeanfilterLen

public void setMeanfilterLen(int meanfilterLen)
Parameters:
meanfilterLen - the meanfilterLen to set

getGaincutfactor

public double getGaincutfactor()
Returns:
the gaincutfactor

setGaincutfactor

public void setGaincutfactor(double gaincutfactor)
Parameters:
gaincutfactor - the gaincutfactor to set

getScatterEstScale

public double getScatterEstScale()
Returns:
the scatterEstScale

setScatterEstScale

public void setScatterEstScale(double scatterEstScale)
Parameters:
scatterEstScale - the scatterEstScale to set

isbUniformAlpha

public boolean isbUniformAlpha()
Returns:
the bUniformAlpha

setbUniformAlpha

public void setbUniformAlpha(boolean bUniformAlpha)
Parameters:
bUniformAlpha - the bUniformAlpha to set

getSoftcutfactor

public double getSoftcutfactor()
Returns:
the softcutfactor

setSoftcutfactor

public void setSoftcutfactor(double softcutfactor)
Parameters:
softcutfactor - the softcutfactor to set