Package adams.flow.control.plotprocessor
Class Expression
-
- All Implemented Interfaces:
CleanUpHandler
,Destroyable
,ErrorProvider
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,SizeOfHandler
,Serializable
public class Expression extends AbstractPlotProcessorWithBuffer<Point2D>
Applies a mathematical function to the data (separately for X and Y).
Values can be accessed using 'xN' and 'yN' with 'N' being the 1-based index in the current window.
-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. default: 1 minimum: 1
-x-expression <adams.parser.MathematicalExpressionText> (property: XExpression) The expression to apply to the X data. default: x1
-y-expression <adams.parser.MathematicalExpressionText> (property: YExpression) The expression to apply to the Y data. default: y1
- 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.protected MathematicalExpressionText
m_XExpression
the expression for X.protected MathematicalExpressionText
m_YExpression
the expression for Y.-
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 Expression()
-
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.int
getWindowSize()
Returns the polynominal order.MathematicalExpressionText
getXExpression()
Returns the expression for the X values.MathematicalExpressionText
getYExpression()
Returns the expression for the Y values.String
globalInfo()
Returns a string describing the object.void
setWindowSize(int value)
Sets the polynomial order.void
setXExpression(MathematicalExpressionText value)
Sets the expression for the X values.void
setYExpression(MathematicalExpressionText value)
Sets the expression for the Y values.String
windowSizeTipText()
Returns the tip text for this property.String
XExpressionTipText()
Returns the tip text for this property.String
YExpressionTipText()
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
-
-
-
-
Field Detail
-
m_WindowSize
protected int m_WindowSize
Size of window size for calculating lowess.
-
m_XExpression
protected MathematicalExpressionText m_XExpression
the expression for X.
-
m_YExpression
protected MathematicalExpressionText m_YExpression
the expression for Y.
-
-
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
-
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.
-
setXExpression
public void setXExpression(MathematicalExpressionText value)
Sets the expression for the X values.- Parameters:
value
- the expression
-
getXExpression
public MathematicalExpressionText getXExpression()
Returns the expression for the X values.- Returns:
- the expression
-
XExpressionTipText
public String XExpressionTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setYExpression
public void setYExpression(MathematicalExpressionText value)
Sets the expression for the Y values.- Parameters:
value
- the expression
-
getYExpression
public MathematicalExpressionText getYExpression()
Returns the expression for the Y values.- Returns:
- the expression
-
YExpressionTipText
public String YExpressionTipText()
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
-
-