Package adams.data.spectrumfilter

Class Rebase

  • 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<adams.data.filter.Filter>, adams.core.SizeOfHandler, adams.data.filter.Filter<Spectrum>, Serializable, Comparable
    public class Rebase
extends adams.data.filter.AbstractFilter<Spectrum>
    Shifts all wave numbers (left or right), so that the first wave number is at the specified starting point. 

    -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
 
    -start <float> (property: start)
    The new starting point for the wave numbers.
    default: 0.0
 
    -update-wave-numbers <boolean> (property: updateWaveNumbers)
    If enabled, the wave numbers get updated using the specified step size.
    default: false
 
    -wave-step <float> (property: waveStep)
    The difference between two wave numbers when updating the wave numbers.
    default: 1.0
    Version:
    $Revision: 2242 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

        adams.data.filter.AbstractFilter.FilterJob<T extends adams.data.container.DataContainer>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected float m_Start
      the new starting point for wave numbers.
      protected boolean m_UpdateWaveNumbers
      whether to introduce new step size between points.
      protected float m_WaveStep
      the difference between two wave numbers.

      • Fields inherited from class adams.data.filter.AbstractFilter

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      float getStart()
      Returns the new starting point for the wave numbers.
      boolean getUpdateWaveNumbers()
      Returns whether to update the wave numbers using the specified step size.
      float getWaveStep()
      Returns the difference between two wave numbers when updating them.
      String globalInfo()
      Returns a string describing the object.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setStart​(float value)
      Sets the new starting point for the wave numbers.
      void setUpdateWaveNumbers​(boolean value)
      Sets whether to update the wave numbers using the specified step size.
      void setWaveStep​(float value)
      Sets the difference between two wave numbers when updating them.
      String startTipText()
      Returns the tip text for this property.
      String updateWaveNumbersTipText()
      Returns the tip text for this property.
      String waveStepTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.filter.AbstractFilter

        checkData, cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, 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 interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Start

        protected float m_Start
        the new starting point for wave numbers.

      • m_UpdateWaveNumbers

        protected boolean m_UpdateWaveNumbers
        whether to introduce new step size between points.

      • m_WaveStep

        protected float m_WaveStep
        the difference between two wave numbers.

    • Constructor Detail

      • Rebase

        public Rebase()

    • 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.data.filter.AbstractFilter<Spectrum>

      • setStart

        public void setStart​(float value)
        Sets the new starting point for the wave numbers.
        Parameters:
        value - the start

      • getStart

        public float getStart()
        Returns the new starting point for the wave numbers.
        Returns:
        the start

      • startTipText

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

      • setUpdateWaveNumbers

        public void setUpdateWaveNumbers​(boolean value)
        Sets whether to update the wave numbers using the specified step size.
        Parameters:
        value - true if to update

      • getUpdateWaveNumbers

        public boolean getUpdateWaveNumbers()
        Returns whether to update the wave numbers using the specified step size.
        Returns:
        true if to update

      • updateWaveNumbersTipText

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

      • setWaveStep

        public void setWaveStep​(float value)
        Sets the difference between two wave numbers when updating them.
        Parameters:
        value - the difference

      • getWaveStep

        public float getWaveStep()
        Returns the difference between two wave numbers when updating them.
        Returns:
        the difference

      • waveStepTipText

        public String waveStepTipText()
        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​(Spectrum data)
        Performs the actual filtering.
        Specified by:
        processData in class adams.data.filter.AbstractFilter<Spectrum>
        Parameters:
        data - the data to filter
        Returns:
        the filtered data