Package adams.data.io.output

Class CALSpectrumWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractDataContainerWriter<Spectrum>

adams.data.io.output.AbstractSpectrumWriter

adams.data.io.output.NIRSpectrumWriter

adams.data.io.output.CALSpectrumWriter

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.output.DataContainerWriter>, adams.core.SizeOfHandler, adams.data.io.output.DataContainerWriter<Spectrum>, adams.data.io.output.StreamableBinaryDataContainerWriter<Spectrum>, adams.data.io.output.StreamableDataContainerWriter<Spectrum>, Serializable, Comparable

public class CALSpectrumWriter
extends NIRSpectrumWriter

Write spectra to .CAL file. As per .NIR file, except with 'constituent values'. i.e. reference values.

Author:

dale

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.data.report.Field[]	m_Constituents	constituents.

Fields inherited from class adams.data.io.output.NIRSpectrumWriter

m_Client, m_EOC, m_FileID, m_InstrumentName, m_Master, m_Operator, m_ProductCode, m_ProductCodeFromField, m_SampleID1, m_SampleID2, m_SampleID3, m_Segments, m_Serial, m_Timestamp, m_WaveEnds, m_WaveStarts, m_WaveSteps

Fields inherited from class adams.data.io.output.AbstractDataContainerWriter

m_Output, m_OutputIsFile

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

Method Summary

Modifier and Type	Method	Description
String	constituentsTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
adams.data.report.Field[]	getConstituents()	Returns the constituents.
FossOutputHelper.ConstituentValues	getConstituentValues(Spectrum sp)	Create ConstituentValues for a spectrum.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
FossOutputHelper.Generalheader	getGeneralHeader(List<Spectrum> data)	Create GeneralHeader from list of Spectra.
FossOutputHelper.InstrumentHeader	getInstrumentHeader()	Create InstrumentHeader using parameters.
void	setConstituents(adams.data.report.Field[] value)	Sets the constituents.

Methods inherited from class adams.data.io.output.NIRSpectrumWriter

canWriteMultiple, clientTipText, endPointsTipText, EOCTipText, fileIDTipText, genByteArray, genByteArray, getClient, getDataBlock, getEndPoints, getEOC, getFileID, getIncrements, getInstrumentName, getMaster, getOperator, getProductCode, getProductCodeFromField, getSampleHeader, getSampleID1, getSampleID2, getSampleID3, getSampleInfo, getSegmentWidths, getSerialNo, getStartPoints, getTimestamp, globalInfo, incrementsTipText, initialize, instrumentNameTipText, masterTipText, operatorTipText, productCodeFromFieldTipText, productCodeTipText, sampleID1TipText, sampleID2TipText, sampleID3TipText, segmentWidthsTipText, serialNoTipText, setClient, setEndPoints, setEOC, setFileID, setIncrements, setInstrumentName, setMaster, setOperator, setProductCode, setProductCodeFromField, setSampleID1, setSampleID2, setSampleID3, setSegmentWidths, setSerialNo, setStartPoints, setTimestamp, startPointsTipText, timestampTipText, write, write, writeData

Methods inherited from class adams.data.io.output.AbstractSpectrumWriter

getWriters, outputTipText

Methods inherited from class adams.data.io.output.AbstractDataContainerWriter

checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getAdditionalInformation, getDefaultFormatExtension, getOutput, isOutputFile, reset, setOutput, shallowCopy, shallowCopy, write, write

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.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.data.io.output.DataContainerWriter

getOutput, isOutputFile, outputTipText, setOutput, write, write

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_Constituents

protected adams.data.report.Field[] m_Constituents

constituents.

Constructor Detail

CALSpectrumWriter

public CALSpectrumWriter()

Method Detail

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 NIRSpectrumWriter

setConstituents

public void setConstituents(adams.data.report.Field[] value)

Sets the constituents.

Parameters:

value - the fields

getConstituents

public adams.data.report.Field[] getConstituents()

Returns the constituents.

Returns:

the fields

constituentsTipText

public String constituentsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getGeneralHeader

public FossOutputHelper.Generalheader getGeneralHeader(List<Spectrum> data)

Create GeneralHeader from list of Spectra. Needs to update file type, and number of constituents.

Overrides:

getGeneralHeader in class NIRSpectrumWriter

Parameters:

data - list of Spectra

Returns:

GeneralHeader

getInstrumentHeader

public FossOutputHelper.InstrumentHeader getInstrumentHeader()

Create InstrumentHeader using parameters. Needs to update constituent names.

Overrides:

getInstrumentHeader in class NIRSpectrumWriter

Returns:

InstrumentHeader

getConstituentValues

public FossOutputHelper.ConstituentValues getConstituentValues(Spectrum sp)

Create ConstituentValues for a spectrum. Needs to update constituent values.

Overrides:

getConstituentValues in class NIRSpectrumWriter

Parameters:

sp - spectrum

Returns:

ConstituentValues

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface adams.core.io.FileFormatHandler

Overrides:

getFormatDescription in class NIRSpectrumWriter

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

Overrides:

getFormatExtensions in class NIRSpectrumWriter

Returns:

the extension(s) (without the dot!)