Package adams.data.spectrumfilter

Class Remove

  • 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 Remove
extends adams.data.filter.AbstractFilter<Spectrum>
    Removes a range of amplitudes from a spectrum.
    The matching sense can be inverted as well, i.e., removing everything else but the defined range of amplitudes.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -range <java.lang.String> (property: range)
    The range of attributes to remove; A range is a comma-separated list of
    single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)'
     inverts the range '...'; the following placeholders can be used as well:
     first, second, third, last_2, last_1, last
    default:
 
    -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 adams.core.Range m_Range
      the range of amplitudes to remove.

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

    • 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.
      String getRange()
      Returns the range of amplitudes to remove.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      String invertTipText()
      Returns the tip text for this property.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      String rangeTipText()
      Returns the tip text for this property.
      void setInvert​(boolean value)
      Whether to invert the matching sense.
      void setRange​(String value)
      Sets the range of amplitudes to remove.

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

        protected adams.core.Range m_Range
        the range of amplitudes to remove.

      • m_Invert

        protected boolean m_Invert
        whether to invert the matching sense.

    • Constructor Detail

      • Remove

        public Remove()

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

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.core.option.AbstractOptionHandler

      • setRange

        public void setRange​(String value)
        Sets the range of amplitudes to remove.
        Parameters:
        value - the range

      • getRange

        public String getRange()
        Returns the range of amplitudes to remove.
        Returns:
        the range

      • rangeTipText

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