Package adams.flow.control.plotprocessor
Class SimpleSavitzkyGolay
-
- All Implemented Interfaces:
CleanUpHandler
,Destroyable
,ErrorProvider
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,SizeOfHandler
,TechnicalInformationHandler
,Serializable
public class SimpleSavitzkyGolay extends AbstractPlotProcessorWithBuffer<Point2D> implements TechnicalInformationHandler
A processor that applies SimpleSavitzkyGolay smoothing.
For more information see:
A. Savitzky, Marcel J.E. Golay (1964). Smoothing and Differentiation of Data by Simplified Least Squares Procedures. Analytical Chemistry. 36:1627-1639.
@article{Savitzky1964, author = {A. Savitzky and Marcel J.E. Golay}, journal = {Analytical Chemistry}, pages = {1627-1639}, title = {Smoothing and Differentiation of Data by Simplified Least Squares Procedures}, volume = {36}, year = {1964}, HTTP = {http://dx.doi.org/10.1021/ac60214a047} }
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-plot-name-suffix <java.lang.String> (property: plotNameSuffix) The suffix for the plot name; if left empty, the plot container automatically becomes an OVERLAY. default:
-window-size <int> (property: windowSize) The window size to use, must be at least 20. default: 7 minimum: 3
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int
m_WindowSize
Size of window size for calculating lowess.-
Fields inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessorWithBuffer
m_Data, m_LastPlot, m_XIndex
-
Fields inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessor
m_LastError, m_PlotNameSuffix
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description SimpleSavitzkyGolay()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected List<SequencePlotterContainer>
doProcess(SequencePlotterContainer cont)
Processes the provided container.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.TechnicalInformation
getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.int
getWindowSize()
Returns the polynominal order.String
globalInfo()
Returns a string describing the object.void
setWindowSize(int value)
Sets the polynomial order.String
windowSizeTipText()
Returns the tip text for this property.-
Methods inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessorWithBuffer
cleanUp, initialize, postProcess, preProcess, reset
-
Methods inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessor
check, getLastError, getPlotName, getPlotNameSuffix, getPlotType, hasLastError, isValid, plotNameSuffixTipText, process, setPlotNameSuffix
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
getTechnicalInformation
public TechnicalInformation getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.- Specified by:
getTechnicalInformation
in interfaceTechnicalInformationHandler
- Returns:
- the technical information about this class
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractPlotProcessor
-
setWindowSize
public void setWindowSize(int value)
Sets the polynomial order.- Parameters:
value
- the order
-
getWindowSize
public int getWindowSize()
Returns the polynominal order.- Returns:
- the order
-
windowSizeTipText
public String windowSizeTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractPlotProcessor
- Returns:
- null if no info available, otherwise short string
-
doProcess
protected List<SequencePlotterContainer> doProcess(SequencePlotterContainer cont)
Processes the provided container. Generates new containers if applicable.- Specified by:
doProcess
in classAbstractPlotProcessor
- Parameters:
cont
- the container to process- Returns:
- null if no new containers were produced
-
-