Package adams.data.spectrumfilter

Class LogTransform

  • 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 LogTransform
extends adams.data.filter.AbstractFilter<Spectrum>
    Transforms the amplitudes using log.

    Valid options are: 

    -D (property: debug)
    If set to true, scheme may output additional info to the console.
 
    -base <java.lang.String> (property: logBase)
    The base for the log ('e' or a positive number greater than 1).
    default: 10
    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 double m_ActualLogBase
      the actual base.
      protected String m_LogBase
      the base of the log.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      String getLogBase()
      Returns the base of the log ("e" or a positive number greater than 1).
      String globalInfo()
      Returns a string describing the object.
      String logBaseTipText()
      Returns the tip text for this property.
      protected Spectrum processData​(Spectrum data)
      Performs the actual filtering.
      void setLogBase​(String value)
      Sets the base of the log ("e" or a positive number greater than 1).

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

        protected String m_LogBase
        the base of the log.

      • m_ActualLogBase

        protected double m_ActualLogBase
        the actual base.

    • Constructor Detail

      • LogTransform

        public LogTransform()

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

      • setLogBase

        public void setLogBase​(String value)
        Sets the base of the log ("e" or a positive number greater than 1).
        Parameters:
        value - the base

      • getLogBase

        public String getLogBase()
        Returns the base of the log ("e" or a positive number greater than 1).
        Returns:
        the base

      • logBaseTipText

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