Package adams.data.io.input

Class SimpleEEMReader

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.data.io.input.AbstractDataContainerReader>, adams.core.SizeOfHandler, adams.core.Stoppable, Serializable, Comparable
    public class SimpleEEMReader
extends AbstractThreeWayDataReader
    Reads EEM data in spreadsheet format (tab-separated columns). 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -input <adams.core.io.PlaceholderFile> (property: input)
    The file to read and turn into a container.
    default: ${CWD}
 
    -create-dummy-report <boolean> (property: createDummyReport)
    If true, then a dummy report is created if none present.
    default: false
 
    -instrument <java.lang.String> (property: instrument)
    The name of the instrument that generated the spectra (if not already present 
    in data).
    default: unknown
 
    -format <java.lang.String> (property: format)
    The data format string.
    default: EEM
 
    -keep-format <boolean> (property: keepFormat)
    If enabled the format obtained from the file is not replaced by the format 
    defined here.
    default: false
 
    -use-absolute-source <boolean> (property: useAbsoluteSource)
    If enabled the source report field stores the absolute file name rather 
    than just the name.
    default: false
 
    -x <double> (property: X)
    The value to use for the X axis.
    default: 0.0
 
    -ignore-wave-numbers <boolean> (property: ignoreWaveNumbers)
    If enabled, the wave numbers get ignored and column and row indices are
    used instead.
    default: false
 
    -denormalize <boolean> (property: denormalize)
    If enabled, the amplitudes get denormalized using the 'Normalized by ' value.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_X

        protected double m_X
        the X value to use for the 3-way data.

      • m_IgnoreWaveNumbers

        protected boolean m_IgnoreWaveNumbers
        whether to ignore the wavenumbers in the file and just use column indices.

      • m_Denormalize

        protected boolean m_Denormalize
        whether to denormalize the data using the "Normalized by " value.

    • Constructor Detail

      • SimpleEEMReader

        public SimpleEEMReader()

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

      • setX

        public void setX​(double value)
        Sets the value to use for the X axis.
        Parameters:
        value - the value

      • getX

        public double getX()
        Returns the value to use for the X axis.
        Returns:
        the value

      • XTipText

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

      • setIgnoreWaveNumbers

        public void setIgnoreWaveNumbers​(boolean value)
        Sets whether to ignore the wave numbers and use row/col indices instead.
        Parameters:
        value - true if to ignore

      • getIgnoreWaveNumbers

        public boolean getIgnoreWaveNumbers()
        Returns whether to ignore the wave numbers and use row/col indices instead.
        Returns:
        true if to ignore

      • ignoreWaveNumbersTipText

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

      • setDenormalize

        public void setDenormalize​(boolean value)
        Sets whether to denormalize the amplitudes using the 'Normalized by ' value.
        Parameters:
        value - true if to denormalize

      • getDenormalize

        public boolean getDenormalize()
        Returns whether to denormalize the amplitudes using the 'Normalized by ' value.
        Returns:
        true if to denormalize

      • denormalizeTipText

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

      • getFormatDescription

        public String getFormatDescription()
        Returns a string describing the format (used in the file chooser).
        Specified by:
        getFormatDescription in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatDescription in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>
        Returns:
        a description suitable for displaying in the file chooser

      • getFormatExtensions

        public String[] getFormatExtensions()
        Returns the extension(s) of the format.
        Specified by:
        getFormatExtensions in interface adams.core.io.FileFormatHandler
        Specified by:
        getFormatExtensions in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>
        Returns:
        the extension (without the dot!)

      • readData

        protected void readData()
        Performs the actual reading.
        Specified by:
        readData in class adams.data.io.input.AbstractDataContainerReader<ThreeWayData>