Package adams.data.multifilter

Class Average

  • 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 Average
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.
    Before the spectra are average, the knir.data.filter.StandardiseByInterpolation filter is applied to ensure the spectra can be aligned. 

    -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
 
    -standardize <knir.data.filter.StandardiseByInterpolation> (property: standardize)
    The filter for standardizing the spectra.
    default: knir.data.filter.StandardiseByInterpolation
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • Average

        public Average()

    • 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

      • setStandardize

        public void setStandardize​(StandardiseByInterpolation value)
        Sets the filter to use for standardizing the spectra.
        Parameters:
        value - the filter

      • getStandardize

        public StandardiseByInterpolation getStandardize()
        Returns the filter to use for standardizing the spectra.
        Returns:
        the filter

      • standardizeTipText

        public String standardizeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.