Package adams.data.spreadsheet.rowscore

Class SAXDistanceFromBaseline

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spreadsheet.rowscore.AbstractRowScore

adams.data.spreadsheet.rowscore.SAXDistanceFromBaseline

All Implemented Interfaces:

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

public class SAXDistanceFromBaseline
extends AbstractRowScore

Applies adams.data.filter.RowNorm to the timeseries before calculating the SAX distance of the timeseries to the baseline.

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

-num-windows <int> (property: numWindows)
    The number of windows to use for Piecewise Aggregate Approximation (PAA).
    default: 10
    minimum: 1
 

-num-bins <int> (property: numBins)
    The number of bins to use for the Gaussian.
    default: 10
    minimum: 1
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_NumBins	the number of breakpoints to use (for the Gaussian).
protected int	m_NumWindows	the number of windows to use for PAA.

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

Method Summary

Modifier and Type	Method	Description
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.
int	getNumBins()	Returns the number of bins to use for the Gaussian.
int	getNumScores()	Returns how many score values will get generated.
int	getNumWindows()	Returns the number of windows to use for PAA.
String	globalInfo()	Returns a string describing the object.
String	numBinsTipText()	Returns the tip text for this property.
String	numWindowsTipText()	Returns the tip text for this property.
void	setNumBins(int value)	Sets the number of bins to use for the Gaussian.
void	setNumWindows(int value)	Sets the number of windows to use for PAA.

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_NumWindows

protected int m_NumWindows

the number of windows to use for PAA.

m_NumBins

protected int m_NumBins

the number of breakpoints to use (for the Gaussian).

Constructor Detail

SAXDistanceFromBaseline

public SAXDistanceFromBaseline()

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

setNumWindows

public void setNumWindows(int value)

Sets the number of windows to use for PAA.

Parameters:

value - the number

getNumWindows

public int getNumWindows()

Returns the number of windows to use for PAA.

Returns:

the number

numWindowsTipText

public String numWindowsTipText()

Returns the tip text for this property.

Returns:

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

setNumBins

public void setNumBins(int value)

Sets the number of bins to use for the Gaussian.

Parameters:

value - the number

getNumBins

public int getNumBins()

Returns the number of bins to use for the Gaussian.

Returns:

the number

numBinsTipText

public String numBinsTipText()

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