Package adams.data.spectrumfilter.detrend

Class RangeBased

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class RangeBased
extends AbstractDetrend
    Performs the correction using slopes/intercepts calculated for the defined ranges. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -range <adams.core.base.BaseInterval> [-range ...] (property: ranges)
    The ranges of wave numbers to use for calculating the intercept/slope corrections.
    default: (-Infinity;+Infinity)
    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.BaseInterval[] m_Ranges
      the ranges to calculate the intercept/slope for.

      • 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
      RangeBased()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Spectrum correct​(Spectrum data)
      Corrects the spectrum.
      void defineOptions()
      Adds options to the internal list of options.
      adams.core.base.BaseInterval[] getRanges()
      Returns the wave number ranges.
      String globalInfo()
      Returns a string describing the object.
      String rangesTipText()
      Returns the tip text for this property.
      void setRanges​(adams.core.base.BaseInterval[] value)
      Sets the wave number ranges.

      • 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 interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Ranges

        protected adams.core.base.BaseInterval[] m_Ranges
        the ranges to calculate the intercept/slope for.

    • Constructor Detail

      • RangeBased

        public RangeBased()

    • 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

      • setRanges

        public void setRanges​(adams.core.base.BaseInterval[] value)
        Sets the wave number ranges.
        Parameters:
        value - the ranges

      • getRanges

        public adams.core.base.BaseInterval[] getRanges()
        Returns the wave number ranges.
        Returns:
        the ranges

      • rangesTipText

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

      • correct

        public Spectrum correct​(Spectrum data)
        Corrects the spectrum.
        Specified by:
        correct in class AbstractDetrend
        Parameters:
        data - the spectrum to process
        Returns:
        the processed spectrum