Package adams.data.outlier

Class FilteredOutlierDetector<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.outlier.AbstractOutlierDetector<T>

adams.data.outlier.AbstractDatabaseConnectionOutlierDetector<T>

adams.data.outlier.FilteredOutlierDetector<T>

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<OutlierDetector>, SizeOfHandler, OutlierDetector<T>, DatabaseConnectionHandler, DatabaseConnectionProvider, DatabaseConnectionUser, Serializable, Comparable

public class FilteredOutlierDetector<T extends DataContainer>
extends AbstractDatabaseConnectionOutlierDetector<T>

A meta detector that first filters the data through a filter before pushing it through the base detector.

Valid options are:

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

-filter <gcms.data.filter.AbstractFilter [options]> (property: filter)
         The filter to apply.
         default: gcms.data.filter.PassThrough
 

-detector <gcms.data.outlier.AbstractOutlierDetector [options]> (property: detector)
         The detector to use.
         default: gcms.data.outlier.PassThrough
 

Default options for gcms.data.filter.PassThrough (-filter/filter):

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

Default options for gcms.data.outlier.PassThrough (-detector/detector):

-D (property: debug)
         If set to true, scheme may output additional info to the console.
 

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 AbstractOutlierDetector	m_Detector	the detector to use.
protected Filter	m_Filter	the filter to use.

Fields inherited from class adams.data.outlier.AbstractDatabaseConnectionOutlierDetector

m_DatabaseConnection

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	detectorTipText()	Returns the tip text for this property.
String	filterTipText()	Returns the tip text for this property.
protected AbstractDatabaseConnection	getDefaultDatabaseConnection()	Returns the default database connection.
AbstractOutlierDetector	getDetector()	Returns the detector in use.
Filter	getFilter()	Returns the filter in use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected List<String>	processData(DataContainer data)	Performs the actual detection: filters the data and then runs it through the detector.
void	reset()	Resets the detector and filter (but does not clear the input data!).
void	setDetector(AbstractOutlierDetector value)	Sets the detector to use.
void	setFilter(Filter value)	Sets the filter to use.
protected void	updateDatabaseConnection()	Updates the database connection in the outlier detectors.

Methods inherited from class adams.data.outlier.AbstractDatabaseConnectionOutlierDetector

getDatabaseConnection, setDatabaseConnection

Methods inherited from class adams.data.outlier.AbstractOutlierDetector

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

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected Filter m_Filter

the filter to use.

m_Detector

protected AbstractOutlierDetector m_Detector

the detector to use.

Constructor Detail

FilteredOutlierDetector

public FilteredOutlierDetector()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractDatabaseConnectionOutlierDetector<T extends DataContainer>

reset

public void reset()

Resets the detector and filter (but does not clear the input data!).

Overrides:

reset in class AbstractOutlierDetector<T extends DataContainer>

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultDatabaseConnection

protected AbstractDatabaseConnection getDefaultDatabaseConnection()

Returns the default database connection.

Specified by:

getDefaultDatabaseConnection in class AbstractDatabaseConnectionOutlierDetector<T extends DataContainer>

Returns:

the default database connection

filterTipText

public String filterTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setFilter

public void setFilter(Filter value)

Sets the filter to use.

Parameters:

value - the filter to use

getFilter

public Filter getFilter()

Returns the filter in use.

Returns:

the filter

detectorTipText

public String detectorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setDetector

public void setDetector(AbstractOutlierDetector value)

Sets the detector to use.

Parameters:

value - the detector to use

getDetector

public AbstractOutlierDetector getDetector()

Returns the detector in use.

Returns:

the detector

updateDatabaseConnection

protected void updateDatabaseConnection()

Updates the database connection in the outlier detectors.

Overrides:

updateDatabaseConnection in class AbstractDatabaseConnectionOutlierDetector<T extends DataContainer>

processData

protected List<String> processData(DataContainer data)

Performs the actual detection: filters the data and then runs it through the detector.

Specified by:

processData in class AbstractOutlierDetector<T extends DataContainer>

Parameters:

data - the data to process

Returns:

the detections