Package adams.data.io.input

Class SPASpectrumReader

  • 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.DataContainerReader>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.io.input.DataContainerReader<Spectrum>, adams.data.io.input.StreamableBinaryDataContainerReader<Spectrum>, adams.data.io.input.StreamableDataContainerReader<Spectrum>, Serializable, Comparable
    public class SPASpectrumReader
extends AbstractByteBasedSpectrumReader
    Loads spectral data files in Nicolet SPA format. 

    -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: NIR
 
    -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
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SPASpectrumReader

        public SPASpectrumReader()

    • 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

      • 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<Spectrum>
        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<Spectrum>
        Returns:
        the extension(s) (without the dot!)

      • readString

        protected String readString​(byte[] data,
                            int offset)
        Reads a string starting at the offset till encountering a null byte or EOF.
        Parameters:
        data - the bytes
        offset - the starting point
        Returns:
        the parsed string

      • readShort

        protected int readShort​(byte[] data,
                        int offset)
        Reads a short (2bytes).
        Parameters:
        data - the data to use
        offset - the offset
        Returns:
        the short

      • readInt

        protected int readInt​(byte[] data,
                      int offset)
        Reads an integer (4bytes).
        Parameters:
        data - the data to use
        offset - the offset
        Returns:
        the integer

      • readFloat

        protected float readFloat​(byte[] data,
                          int offset)
        Reads a float (4bytes).
        Parameters:
        data - the data to use
        offset - the offset
        Returns:
        the float

      • main

        public static void main​(String[] args)
        Runs the reader from the command-line. If the option AbstractSpectrumReader.OPTION_OUTPUTDIR is specified then the read spectra get output as .spec files in that directory.
        Parameters:
        args - the command-line options to use