Package adams.data.outlier

Class TimeseriesMinPoints

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.outlier.AbstractOutlierDetector<Timeseries>

adams.data.outlier.TimeseriesMinPoints

All Implemented Interfaces:

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

public class TimeseriesMinPoints
extends AbstractOutlierDetector<Timeseries>

Ensures that a minimum number of points in the timeseries have the specified minimum value.

Valid options are:

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

-num-points <double> (property: numPoints)
    The minimum number of points that must have at least the minimum value; 
    if less than 1 it is interpreted as percentage, otherwise as an absolute 
    number.
    default: 0.5
    minimum: 0.0
 

-min-value <double> (property: minValue)
    The minimum value that the data points must satisfy.
    default: 0.0
 

Version:

$Revision$

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_MinValue	the minimum value.
protected double	m_NumPoints	the number of points that need the minimum value (below 1 it is interpreted as percentage).

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
double	getMinValue()	Returns the currently set minimum.
double	getNumPoints()	Returns the currently set minimum number of points.
String	globalInfo()	Returns a string describing the object.
String	minValueTipText()	Returns the tip text for this property.
String	numPointsTipText()	Returns the tip text for this property.
protected List<String>	processData(Timeseries data)	Performs the actual detection.
void	setMinValue(double value)	Sets the minimum value.
void	setNumPoints(double value)	Sets the minimum number of points.

Methods inherited from class adams.data.outlier.AbstractOutlierDetector

checkData, 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_NumPoints

protected double m_NumPoints

the number of points that need the minimum value (below 1 it is interpreted as percentage).

m_MinValue

protected double m_MinValue

the minimum value.

Constructor Detail

TimeseriesMinPoints

public TimeseriesMinPoints()

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

setNumPoints

public void setNumPoints(double value)

Sets the minimum number of points.

Parameters:

value - the number of points

getNumPoints

public double getNumPoints()

Returns the currently set minimum number of points.

Returns:

the minimum number of points

numPointsTipText

public String numPointsTipText()

Returns the tip text for this property.

Returns:

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

setMinValue

public void setMinValue(double value)

Sets the minimum value.

Parameters:

value - the minimum

getMinValue

public double getMinValue()

Returns the currently set minimum.

Returns:

the minimum

minValueTipText

public String minValueTipText()

Returns the tip text for this property.

Returns:

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

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