Package adams.data.spectrumfilter

Class SubRange

  • 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 SubRange
extends adams.data.filter.AbstractFilter<Spectrum>
    Returns a sub-range of wave numbers from a spectrum.

    Valid options are: 

    -D (property: debug)
    If set to true, scheme may output additional info to the console.
 
    -min <double> (property: minWaveNumber)
    The smallest wave number to include in the output; use -1 for unlimited.
    default: -1.0
 
    -max <double> (property: maxWaveNumber)
    The largest wave number to include in the output; use -1 for unlimited.
    default: -1.0
 
    -invert (property: invert)
    If set to true, then all but the selected range will be returned.
    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 boolean m_Invert
      whether to invert the matching sense.
      protected double m_MaxWaveNumber
      the maximum wave number.
      protected double m_MinWaveNumber
      the minimum wave number.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      boolean getInvert()
      Returns whether to invert the matching sense.
      double getMaxWaveNumber()
      Returns the maximum wave number to include in the output.
      double getMinWaveNumber()
      Returns the minimum wave number to include in the output.
      String globalInfo()
      Returns a string describing the object.
      String invertTipText()
      Returns the tip text for this property.
      String maxWaveNumberTipText()
      Returns the tip text for this property.
      String minWaveNumberTipText()
      Returns the tip text for this property.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setInvert​(boolean value)
      Whether to invert the matching sense.
      void setMaxWaveNumber​(double value)
      Sets the maximum wave number to include in the output.
      void setMinWaveNumber​(double value)
      Sets the minimum wave number to include in the output.

      • 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_MinWaveNumber

        protected double m_MinWaveNumber
        the minimum wave number.

      • m_MaxWaveNumber

        protected double m_MaxWaveNumber
        the maximum wave number.

      • m_Invert

        protected boolean m_Invert
        whether to invert the matching sense.

    • Constructor Detail

      • SubRange

        public SubRange()

    • 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>

      • setMinWaveNumber

        public void setMinWaveNumber​(double value)
        Sets the minimum wave number to include in the output.
        Parameters:
        value - the minimum

      • getMinWaveNumber

        public double getMinWaveNumber()
        Returns the minimum wave number to include in the output.
        Returns:
        the minimum

      • minWaveNumberTipText

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

      • setMaxWaveNumber

        public void setMaxWaveNumber​(double value)
        Sets the maximum wave number to include in the output.
        Parameters:
        value - the maximum

      • getMaxWaveNumber

        public double getMaxWaveNumber()
        Returns the maximum wave number to include in the output.
        Returns:
        the maximum

      • maxWaveNumberTipText

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

      • setInvert

        public void setInvert​(boolean value)
        Whether to invert the matching sense.
        Parameters:
        value - true if to return everything apart the selected range

      • getInvert

        public boolean getInvert()
        Returns whether to invert the matching sense.
        Returns:
        true if to return everything apart the selected range

      • invertTipText

        public String invertTipText()
        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