Package adams.data.outlier

Class TimeseriesRange

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.outlier.AbstractOutlierDetector<Timeseries>

adams.data.outlier.TimeseriesRange

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<OutlierDetector>, SizeOfHandler, OutlierDetector<Timeseries>, Serializable, Comparable

public class TimeseriesRange
extends AbstractOutlierDetector<Timeseries>

Ensures that timeseries values lie within the defined range.

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

-min <double> (property: min)
    The minimum value to accept.
    default: 4.9E-324
 

-max <double> (property: max)
    The maximum value accept.
    default: 1.7976931348623157E308
 

Version:

$Revision: 995 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.outlier.AbstractOutlierDetector

AbstractOutlierDetector.DetectorJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Max	the maximum acceptable value (incl).
protected double	m_Min	the minimum acceptable value (incl).

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

Method Summary

Modifier and Type	Method	Description
protected void	checkData(Timeseries data)	The default implementation only checks whether there is any data set.
void	defineOptions()	Adds options to the internal list of options.
double	getMax()	Returns the maximum value accept.
double	getMin()	Returns the minimum value accept.
String	globalInfo()	Returns a string describing the object.
String	maxTipText()	Returns the tip text for this property.
String	minTipText()	Returns the tip text for this property.
protected List<String>	processData(Timeseries data)	Performs the actual detection.
void	setMax(double value)	Sets the maximum value accept.
void	setMin(double value)	Sets the minimum value to accept.

Methods inherited from class adams.data.outlier.AbstractOutlierDetector

cleanUp, compareTo, destroy, detect, equals, forCommandLine, forName, getOutlierDetectors, getQuickInfo, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Min

protected double m_Min

the minimum acceptable value (incl).

m_Max

protected double m_Max

the maximum acceptable value (incl).

Constructor Detail

TimeseriesRange

public TimeseriesRange()

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

setMin

public void setMin(double value)

Sets the minimum value to accept.

Parameters:

value - the minimum

getMin

public double getMin()

Returns the minimum value accept.

Returns:

the minimum

minTipText

public String minTipText()

Returns the tip text for this property.

Returns:

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

setMax

public void setMax(double value)

Sets the maximum value accept.

Parameters:

value - the maximum

getMax

public double getMax()

Returns the maximum value accept.

Returns:

the maximum

maxTipText

public String maxTipText()

Returns the tip text for this property.

Returns:

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

checkData

protected void checkData(Timeseries data)

The default implementation only checks whether there is any data set.

Overrides:

checkData in class AbstractOutlierDetector<Timeseries>

Parameters:

data - the data to process

processData

protected List<String> processData(Timeseries data)

Performs the actual detection.

Specified by:

processData in class AbstractOutlierDetector<Timeseries>

Parameters:

data - the data to process

Returns:

the detections