Package adams.data.multifilter

Class Mean

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.multifilter.AbstractMultiSpectrumFilter

adams.data.multifilter.AbstractFormatsBasedMultiSpectrumFilter

adams.data.multifilter.Mean

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 Mean
extends AbstractFormatsBasedMultiSpectrumFilter

Averages spectra into a single one. Either uses all spectra, if no format is specified, or only the ones that match the specified formats.

-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
 

-format <adams.core.base.BaseString> [-format ...] (property: formats)
    The formats of the spectra to average; use an empty array to average all.
    default: 
 

-new-format <java.lang.String> (property: newFormat)
    The new format to use for the averaged spectrum.
    default: AVG
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.multifilter.AbstractFormatsBasedMultiSpectrumFilter

m_Formats, m_NewFormat

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

Method Summary

Modifier and Type	Method	Description
String	formatsTipText()	Returns the tip text for this property.
protected String	getDefaultNewFormat()	Returns the default format for the generated spectrum.
String	globalInfo()	Returns a string describing the object.
String	newFormatTipText()	Returns the tip text for this property.
protected Spectrum	processData(MultiSpectrum data)	Performs the actual filtering.

Methods inherited from class adams.data.multifilter.AbstractFormatsBasedMultiSpectrumFilter

defineOptions, getFormats, getNewFormat, setFormats, setNewFormat

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

Constructor Detail

Mean

public Mean()

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

formatsTipText

public String formatsTipText()

Returns the tip text for this property.

Specified by:

formatsTipText in class AbstractFormatsBasedMultiSpectrumFilter

Returns:

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

getDefaultNewFormat

protected String getDefaultNewFormat()

Returns the default format for the generated spectrum.

Specified by:

getDefaultNewFormat in class AbstractFormatsBasedMultiSpectrumFilter

Returns:

the default format

newFormatTipText

public String newFormatTipText()

Returns the tip text for this property.

Specified by:

newFormatTipText in class AbstractFormatsBasedMultiSpectrumFilter

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