Package adams.data.io.input

Class SPCSpectrumReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractDataContainerReader<Spectrum>

adams.data.io.input.AbstractSpectrumReader

adams.data.io.input.SPCSpectrumReader

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 SPCSpectrumReader
extends AbstractSpectrumReader

Reads spectra in SPC format (Galactic Universal Data Format) format.
See the specifications here:
http://serswiki.bme.gatech.edu/images/a/ae/SPC_Open_Specification.pdf

-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
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SPCSpectrumReader.AbstractParser	Parser class for SPC files.
static class	SPCSpectrumReader.FileParser	Parser class for SPC files (header).
static class	SPCSpectrumReader.SubFileParser	Parser class for SPC files (header).

Field Summary

Fields inherited from class adams.data.io.input.AbstractSpectrumReader

m_Format, m_Instrument, m_KeepFormat, m_Stopped, m_UseAbsoluteSource, OPTION_OUTPUTDIR

Fields inherited from class adams.data.io.input.AbstractDataContainerReader

m_CreateDummyReport, m_Input, m_InputIsFile, m_Processed, m_ReadData

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
SPCSpectrumReader()

Method Summary

Modifier and Type	Method	Description
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
static void	main(String[] args)	Runs the reader from the command-line.
protected void	readData()	Performs the actual reading.

Methods inherited from class adams.data.io.input.AbstractSpectrumReader

checkData, createDummyReport, defineOptions, formatTipText, getDefaultFormat, getDefaultInstrument, getDefaultKeepFormat, getDefaultUseAbsoluteSource, getFormat, getInstrument, getKeepFormat, getReaders, getUseAbsoluteSource, instrumentTipText, keepFormatTipText, postProcessData, runReader, setFormat, setInstrument, setKeepFormat, setUseAbsoluteSource, stopExecution, useAbsoluteSourceTipText

Methods inherited from class adams.data.io.input.AbstractDataContainerReader

cleanUp, compareTo, createDummyReportTipText, destroy, doRead, equals, getAdditionalInformation, getCreateDummyReport, getDefaultFormatExtension, getInput, initialize, inputTipText, isInputFile, read, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

SPCSpectrumReader

public SPCSpectrumReader()

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!)

readData

protected void readData()

Performs the actual reading.

Specified by:

readData in class adams.data.io.input.AbstractDataContainerReader<Spectrum>

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