Package adams.data.spectrumfilter.amplitudetransform

Class Triangle

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class Triangle
extends AbstractAmplitudeTransformer
    Multiplies the amplitude by the value from a triangle function. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -min <float> (property: min)
    The minimum for the triangle.
    default: 0.0
 
    -max <float> (property: max)
    The maximum for the triangle.
    default: 1.0
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected float m_Max
      the maximum for the triangle.
      protected float m_Min
      the minimum for the triangle.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      float getMax()
      Returns the maximum for the triangle.
      float getMin()
      Returns the minimum for the triangle.
      String globalInfo()
      Returns a string describing the object.
      String maxTipText()
      Returns the tip text for this property.
      String minTipText()
      Returns the tip text for this property.
      void setMax​(float value)
      Sets the maximum for the triangle.
      void setMin​(float value)
      Sets the minimum for the triangle.
      protected SpectrumPoint transform​(int index, SpectrumPoint point)
      Transform the spectrum point and returns a new object.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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

    • Field Detail

      • m_Min

        protected float m_Min
        the minimum for the triangle.

      • m_Max

        protected float m_Max
        the maximum for the triangle.

    • Constructor Detail

      • Triangle

        public Triangle()

    • 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.core.option.AbstractOptionHandler

      • setMin

        public void setMin​(float value)
        Sets the minimum for the triangle.
        Parameters:
        value - the minimum

      • getMin

        public float getMin()
        Returns the minimum for the triangle.
        Returns:
        the minimum

      • minTipText

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

      • setMax

        public void setMax​(float value)
        Sets the maximum for the triangle.
        Parameters:
        value - the maximum

      • getMax

        public float getMax()
        Returns the maximum for the triangle.
        Returns:
        the maximum

      • maxTipText

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