Package adams.data.multifilter

Class FilteredMultiSpectrumFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.multifilter.AbstractMultiSpectrumFilter

adams.data.multifilter.FilteredMultiSpectrumFilter

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<AbstractMultiSpectrumFilter>, adams.core.SizeOfHandler, Serializable, Comparable

public class FilteredMultiSpectrumFilter
extends AbstractMultiSpectrumFilter

The pre-filters select the spectra from the incoming multi-spectrum and re-package them into a new multi-spectrum. This new multi-spectrum is then pushed through the actual filter.

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

-no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 

-pre-filter <knir.data.multifilter.AbstractMultiSpectrumFilter> [-pre-filter ...] (property: preFilters)
    The pre-filters to use for creating the multi-spectrum presented to the 
    base-filter.
    default: 
 

-base-filter <knir.data.multifilter.AbstractMultiSpectrumFilter> (property: baseFilter)
    The base filter to apply to the multi-spectrum generated by the pre-filters.
    default: knir.data.multifilter.PickByIndex
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractMultiSpectrumFilter	m_BaseFilter	the base filter.
protected AbstractMultiSpectrumFilter[]	m_PreFilters	the "pre" filters.

Fields inherited from class adams.data.multifilter.AbstractMultiSpectrumFilter

m_DontUpdateID

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

Method Summary

Modifier and Type	Method	Description
String	baseFilterTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
AbstractMultiSpectrumFilter	getBaseFilter()	Returns the base filter.
AbstractMultiSpectrumFilter[]	getPreFilters()	Returns the pre-filters.
String	globalInfo()	Returns a string describing the object.
String	preFiltersTipText()	Returns the tip text for this property.
protected Spectrum	processData(MultiSpectrum data)	Performs the actual filtering.
void	setBaseFilter(AbstractMultiSpectrumFilter value)	Sets the base filter.
void	setPreFilters(AbstractMultiSpectrumFilter[] value)	Sets the pre-filters.

Methods inherited from class adams.data.multifilter.AbstractMultiSpectrumFilter

checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, forName, getDontUpdateID, getFilters, reset, setDontUpdateID, 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

Field Detail

m_PreFilters

protected AbstractMultiSpectrumFilter[] m_PreFilters

the "pre" filters.

m_BaseFilter

protected AbstractMultiSpectrumFilter m_BaseFilter

the base filter.

Constructor Detail

FilteredMultiSpectrumFilter

public FilteredMultiSpectrumFilter()

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 AbstractMultiSpectrumFilter

setPreFilters

public void setPreFilters(AbstractMultiSpectrumFilter[] value)

Sets the pre-filters.

Parameters:

value - the filters

getPreFilters

public AbstractMultiSpectrumFilter[] getPreFilters()

Returns the pre-filters.

Returns:

the filters

preFiltersTipText

public String preFiltersTipText()

Returns the tip text for this property.

Returns:

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

setBaseFilter

public void setBaseFilter(AbstractMultiSpectrumFilter value)

Sets the base filter.

Parameters:

value - the base filter

getBaseFilter

public AbstractMultiSpectrumFilter getBaseFilter()

Returns the base filter.

Returns:

the base filter

baseFilterTipText

public String baseFilterTipText()

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 Spectrum processData(MultiSpectrum data)

Performs the actual filtering.

Specified by:

processData in class AbstractMultiSpectrumFilter

Parameters:

data - the data to filter

Returns:

the filtered data, null if failed to generate output