Package adams.data.spreadsheet.rowscore

Class DistanceFromConstant

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowscore.AbstractRowScore

adams.data.spreadsheet.rowscore.DistanceFromConstant

All Implemented Interfaces:

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

public class DistanceFromConstant
extends AbstractRowScore

Calculates the Euclidean distance to a timeseries that is basically a 'flat-liner' with a constant value.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-constant <double> (property: constant)
    The constant to use for calculating the distance.
    default: 0.0
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Constant	the 'flat liner' value.

Fields inherited from class adams.data.spreadsheet.rowscore.AbstractRowScore

m_LastError

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

Method Summary

Modifier and Type	Method	Description
String	constantTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Double[]	doCalculateScore(SpreadSheet sheet, int rowIndex)	Performs the actual calculation of the row score.
double	getConstant()	Returns the constant in use.
int	getNumScores()	Returns how many score values will get generated.
String	globalInfo()	Returns a string describing the object.
void	setConstant(double value)	Sets the constant to use.

Methods inherited from class adams.data.spreadsheet.rowscore.AbstractRowScore

calculateScore, check, getLastError, hasLastError

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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_Constant

protected double m_Constant

the 'flat liner' value.

Constructor Detail

DistanceFromConstant

public DistanceFromConstant()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

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 interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setConstant

public void setConstant(double value)

Sets the constant to use.

Parameters:

value - the constant

getConstant

public double getConstant()

Returns the constant in use.

Returns:

the constant

constantTipText

public String constantTipText()

Returns the tip text for this property.

Returns:

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

getNumScores

public int getNumScores()

Returns how many score values will get generated.

Specified by:

getNumScores in class AbstractRowScore

Returns:

the number of scores

doCalculateScore

protected Double[] doCalculateScore(SpreadSheet sheet,
                                    int rowIndex)

Performs the actual calculation of the row score.

Specified by:

doCalculateScore in class AbstractRowScore

Parameters:

sheet - the spreadsheet to generate the score for

rowIndex - the row index

Returns:

the generated score, null in case of an error