Package adams.data.spectrumfilter

Class PadPower2

  • 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 PadPower2
extends adams.data.filter.AbstractFilter<Spectrum>
    Pads the spectrum to a power of 2 number of wave numbers. 

    -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
 
    -padding <ZERO|LAST> (property: paddingType)
    The type of padding to use.
    default: ZERO
 
    -num-additional <int> (property: numAdditional)
    The number of additional wave numbers to add.
    default: 0
    minimum: 0
 
    -wave-number-step-size <float> (property: waveNumberStepSize)
    The step size for the new wave numbers; using average if <= 0.
    default: -1.0
 
    -pad-left <boolean> (property: padLeft)
    If enabled the spectrum gets padded on the left rather than on the right.
    default: false
    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 int m_NumAdditional
      the number of additional data points to add.
      protected adams.data.padding.PaddingType m_PaddingType
      the type of padding to use.
      protected boolean m_PadLeft
      whether to padd on the left.
      protected float m_WaveNumberStepSize
      the step size between wave numbers (<= 0 to use average).

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      int getNumAdditional()
      Returns the number of additional wave numbers to add (beyond the power of 2).
      adams.data.padding.PaddingType getPaddingType()
      Returns the type of padding.
      boolean getPadLeft()
      Returns whether to pad on the left rather than on the right.
      float getWaveNumberStepSize()
      Returns the step size for the additional wave numbers.
      String globalInfo()
      Returns a string describing the object.
      String numAdditionalTipText()
      Returns the tip text for this property.
      String paddingTypeTipText()
      Returns the tip text for this property.
      String padLeftTipText()
      Returns the tip text for this property.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setNumAdditional​(int value)
      Sets the number of additional wave numbers to add (beyond the power of 2).
      void setPaddingType​(adams.data.padding.PaddingType value)
      Sets the type of padding.
      void setPadLeft​(boolean value)
      Sets whether to pad on the left rather than on the right.
      void setWaveNumberStepSize​(float value)
      Sets the step size for the additional wave numbers.
      String waveNumberStepSizeTipText()
      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_PaddingType

        protected adams.data.padding.PaddingType m_PaddingType
        the type of padding to use.

      • m_NumAdditional

        protected int m_NumAdditional
        the number of additional data points to add.

      • m_WaveNumberStepSize

        protected float m_WaveNumberStepSize
        the step size between wave numbers (<= 0 to use average).

      • m_PadLeft

        protected boolean m_PadLeft
        whether to padd on the left.

    • Constructor Detail

      • PadPower2

        public PadPower2()

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

      • setPaddingType

        public void setPaddingType​(adams.data.padding.PaddingType value)
        Sets the type of padding.
        Parameters:
        value - the type

      • getPaddingType

        public adams.data.padding.PaddingType getPaddingType()
        Returns the type of padding.
        Returns:
        the type

      • paddingTypeTipText

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

      • setNumAdditional

        public void setNumAdditional​(int value)
        Sets the number of additional wave numbers to add (beyond the power of 2).
        Parameters:
        value - the number

      • getNumAdditional

        public int getNumAdditional()
        Returns the number of additional wave numbers to add (beyond the power of 2).
        Returns:
        the number

      • numAdditionalTipText

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

      • setWaveNumberStepSize

        public void setWaveNumberStepSize​(float value)
        Sets the step size for the additional wave numbers. Uses average if <= 0.
        Parameters:
        value - the step size

      • getWaveNumberStepSize

        public float getWaveNumberStepSize()
        Returns the step size for the additional wave numbers. Uses average if <= 0.
        Returns:
        the step size

      • waveNumberStepSizeTipText

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

      • setPadLeft

        public void setPadLeft​(boolean value)
        Sets whether to pad on the left rather than on the right.
        Parameters:
        value - true if to pad on the left

      • getPadLeft

        public boolean getPadLeft()
        Returns whether to pad on the left rather than on the right.
        Returns:
        true if to pad on the left

      • padLeftTipText

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