Package adams.data.multifilter

Class AbstractFormatsBasedMultiSpectrumFilter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.multifilter.AbstractMultiSpectrumFilter

adams.data.multifilter.AbstractFormatsBasedMultiSpectrumFilter

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

Direct Known Subclasses:

AbstractBinaryFormatsBasedMultiSpectrumFilter, Average, Fusion, Mean, Median

public abstract class AbstractFormatsBasedMultiSpectrumFilter
extends AbstractMultiSpectrumFilter

Ancestor for filters that require the user to specify the formats of the spectra to use for the filtering process.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.base.BaseString[]	m_Formats	the formats to average (empty = all).
protected String	m_NewFormat	the new format to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
abstract String	formatsTipText()	Returns the tip text for this property.
protected abstract String	getDefaultNewFormat()	Returns the default format for the generated spectrum.
adams.core.base.BaseString[]	getFormats()	Returns the formats of the specta to use.
String	getNewFormat()	Returns the new format for the generated spectrum.
abstract String	newFormatTipText()	Returns the tip text for this property.
void	setFormats(adams.core.base.BaseString[] value)	Sets the formats of the spectra to use.
void	setNewFormat(String value)	Sets the new format for the generated spectrum.

Methods inherited from class adams.data.multifilter.AbstractMultiSpectrumFilter

checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, forName, getDontUpdateID, getFilters, processData, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected adams.core.base.BaseString[] m_Formats

the formats to average (empty = all).

m_NewFormat

protected String m_NewFormat

the new format to use.

Constructor Detail

AbstractFormatsBasedMultiSpectrumFilter

public AbstractFormatsBasedMultiSpectrumFilter()

Method Detail

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

setFormats

public void setFormats(adams.core.base.BaseString[] value)

Sets the formats of the spectra to use.

Parameters:

value - the formats

getFormats

public adams.core.base.BaseString[] getFormats()

Returns the formats of the specta to use.

Returns:

the formats

formatsTipText

public abstract String formatsTipText()

Returns the tip text for this property.

Returns:

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

getDefaultNewFormat

protected abstract String getDefaultNewFormat()

Returns the default format for the generated spectrum.

Returns:

the default format

setNewFormat

public void setNewFormat(String value)

Sets the new format for the generated spectrum.

Parameters:

value - the new format

getNewFormat

public String getNewFormat()

Returns the new format for the generated spectrum.

Returns:

the new format

newFormatTipText

public abstract String newFormatTipText()

Returns the tip text for this property.

Returns:

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