Package adams.data.conversion

Class ArrayToSpectrum

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, Serializable
    public class ArrayToSpectrum
extends adams.data.conversion.AbstractConversion
    Converts a float array representing amplitudes into a spectrum. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -id <java.lang.String> (property: ID)
    The sample ID to use.
    default:
 
    -format <java.lang.String> (property: format)
    The format to use.
    default: NIR
 
    -waveno-start <float> (property: waveNoStart)
    The first wave number to use.
    default: 1550.0
 
    -waveno-inc <float> (property: waveNoInc)
    The increment to use between wave numbers.
    default: 2.0
    minimum: 0.0
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected String m_Format
      the format.
      protected String m_ID
      the sample id.
      protected float m_WaveNoInc
      the wave number increment.
      protected float m_WaveNoStart
      the starting wave number.

      • Fields inherited from class adams.data.conversion.AbstractConversion

        m_Input, m_Output, m_Owner, m_Stopped

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class accepts()
      Returns the class that is accepted as input.
      void defineOptions()
      Adds options to the internal list of options.
      protected Object doConvert()
      Performs the actual conversion.
      String formatTipText()
      Returns the tip text for this property.
      Class generates()
      Returns the class that is generated as output.
      String getFormat()
      Returns the format.
      String getID()
      Returns the sample ID.
      float getWaveNoInc()
      Returns the increment to use between wave numbers.
      float getWaveNoStart()
      Returns the first wave number to use.
      String globalInfo()
      Returns a string describing the object.
      String IDTipText()
      Returns the tip text for this property.
      void setFormat​(String value)
      Sets the format.
      void setID​(String value)
      Sets the sample ID.
      void setWaveNoInc​(float value)
      Sets the increment to use between wave numbers.
      void setWaveNoStart​(float value)
      Sets the first wave number to use.
      String waveNoIncTipText()
      Returns the tip text for this property.
      String waveNoStartTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.data.conversion.AbstractConversion

        checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

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

        cleanUpOptions, destroy, 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

    • Field Detail

      • m_ID

        protected String m_ID
        the sample id.

      • m_Format

        protected String m_Format
        the format.

      • m_WaveNoStart

        protected float m_WaveNoStart
        the starting wave number.

      • m_WaveNoInc

        protected float m_WaveNoInc
        the wave number increment.

    • Constructor Detail

      • ArrayToSpectrum

        public ArrayToSpectrum()

    • 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

      • setID

        public void setID​(String value)
        Sets the sample ID.
        Parameters:
        value - the sample ID

      • getID

        public String getID()
        Returns the sample ID.
        Returns:
        the sample ID

      • IDTipText

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

      • setFormat

        public void setFormat​(String value)
        Sets the format.
        Parameters:
        value - the format

      • getFormat

        public String getFormat()
        Returns the format.
        Returns:
        the format

      • formatTipText

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

      • setWaveNoStart

        public void setWaveNoStart​(float value)
        Sets the first wave number to use.
        Parameters:
        value - the wave no

      • getWaveNoStart

        public float getWaveNoStart()
        Returns the first wave number to use.
        Returns:
        the wave no

      • waveNoStartTipText

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

      • setWaveNoInc

        public void setWaveNoInc​(float value)
        Sets the increment to use between wave numbers.
        Parameters:
        value - the increment

      • getWaveNoInc

        public float getWaveNoInc()
        Returns the increment to use between wave numbers.
        Returns:
        the increment

      • waveNoIncTipText

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

      • accepts

        public Class accepts()
        Returns the class that is accepted as input.
        Specified by:
        accepts in interface adams.data.conversion.Conversion
        Specified by:
        accepts in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • generates

        public Class generates()
        Returns the class that is generated as output.
        Specified by:
        generates in interface adams.data.conversion.Conversion
        Specified by:
        generates in class adams.data.conversion.AbstractConversion
        Returns:
        the class

      • doConvert

        protected Object doConvert()
                    throws Exception
        Performs the actual conversion.
        Specified by:
        doConvert in class adams.data.conversion.AbstractConversion
        Returns:
        the converted data
        Throws:
        Exception - if something goes wrong with the conversion