Package adams.gui.visualization.sequence.pointpreprocessor

Class AbstractPointPreprocessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.sequence.pointpreprocessor.AbstractPointPreprocessor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, PointPreprocessor, Serializable

Direct Known Subclasses:

Jitter, PassThrough

public abstract class AbstractPointPreprocessor
extends AbstractOptionHandler
implements PointPreprocessor

Ancestor for classes that perform preprocessing on sequence points.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Enabled	whether the preprocessor is enabled.

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
AbstractPointPreprocessor()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected abstract XYSequencePoint	doPreprocess(XYSequencePoint point, AxisPanel axisX, AxisPanel axisY)	Preprocesses the point.
String	enabledTipText()	Returns the tip text for this property.
boolean	isEnabled()	Returns whether the preprocessor is enabled.
XYSequencePoint	preprocess(XYSequencePoint point, AxisPanel axisX, AxisPanel axisY)	Preprocesses the point.
void	resetPreprocessor()	Resets the processor for another sequence.
void	setEnabled(boolean value)	Sets whether the preprocessor is enabled.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, 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_Enabled

protected boolean m_Enabled

whether the preprocessor is enabled.

Constructor Detail

AbstractPointPreprocessor

public AbstractPointPreprocessor()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEnabled

public void setEnabled(boolean value)

Sets whether the preprocessor is enabled.

Parameters:

value - true if enabled

isEnabled

public boolean isEnabled()

Returns whether the preprocessor is enabled.

Returns:

true if enabled

enabledTipText

public String enabledTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

resetPreprocessor

public void resetPreprocessor()

Resets the processor for another sequence.
Default implementation does nothing.

Specified by:

resetPreprocessor in interface PointPreprocessor

doPreprocess

protected abstract XYSequencePoint doPreprocess(XYSequencePoint point,
                                                AxisPanel axisX,
                                                AxisPanel axisY)

Preprocesses the point.

Parameters:

point - the point to process

axisX - the X axis to use

axisY - the Y axis to use

Returns:

the new point

preprocess

public XYSequencePoint preprocess(XYSequencePoint point,
                                  AxisPanel axisX,
                                  AxisPanel axisY)

Preprocesses the point.

Specified by:

preprocess in interface PointPreprocessor

Parameters:

point - the point to process

axisX - the X axis to use

axisY - the Y axis to use

Returns:

the new point