Package adams.data.multispectrumoperation

Class OutlierRemoval

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.multispectrumoperation.AbstractMultiSpectrumOperation

adams.data.multispectrumoperation.OutlierRemoval

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable

public class OutlierRemoval
extends AbstractMultiSpectrumOperation

Applies the specified outlier removal scheme to the multi-spectrum to remove potential outliers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractOutlierRemoval	m_OutlierRemoval	the outlier removal scheme to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected MultiSpectrum	doApply(MultiSpectrum data, adams.core.MessageCollection errors)	Performs the actual filtering.
AbstractOutlierRemoval	getOutlierRemoval()	Returns the outlier removal scheme to apply.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	outlierRemovalTipText()	Returns the tip text for this property.
void	setOutlierRemoval(AbstractOutlierRemoval value)	Sets the outlier removal scheme to apply.

Methods inherited from class adams.data.multispectrumoperation.AbstractMultiSpectrumOperation

apply, check

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_OutlierRemoval

protected AbstractOutlierRemoval m_OutlierRemoval

the outlier removal scheme to use.

Constructor Detail

OutlierRemoval

public OutlierRemoval()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setOutlierRemoval

public void setOutlierRemoval(AbstractOutlierRemoval value)

Sets the outlier removal scheme to apply.

Parameters:

value - the removal scheme

getOutlierRemoval

public AbstractOutlierRemoval getOutlierRemoval()

Returns the outlier removal scheme to apply.

Returns:

the removal scheme

outlierRemovalTipText

public String outlierRemovalTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractMultiSpectrumOperation

Returns:

null if no info available, otherwise short string

doApply

protected MultiSpectrum doApply(MultiSpectrum data,
                                adams.core.MessageCollection errors)

Performs the actual filtering.

Specified by:

doApply in class AbstractMultiSpectrumOperation

Parameters:

data - the data to filter

errors - for collecting errors

Returns:

the filtered data, null if failed to generate output