Package adams.data.io.output

Class SpectrumImageWriter

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

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>, Serializable, Comparable

public class SpectrumImageWriter
extends AbstractSpectrumWriter

Writes spectra as images using the supplied generator.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-output <adams.core.io.PlaceholderFile> (property: output)
    The file to write the container to.
    default: ${TMP}/out.tmp
 

-generator <adams.data.spectrumimage.AbstractSpectrumImageGenerator> (property: generator)
    The generator to use.
    default: adams.data.spectrumimage.Intensity
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractSpectrumImageGenerator	m_Generator	the generator to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	generatorTipText()	Returns the tip text for this property.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
AbstractSpectrumImageGenerator	getGenerator()	Returns the generator to use.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	setGenerator(AbstractSpectrumImageGenerator value)	Sets the generator to use.
protected boolean	writeData(List<Spectrum> data)	Performs the actual writing.

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

canWriteMultiple, 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.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Generator

protected AbstractSpectrumImageGenerator m_Generator

the generator to use.

Constructor Detail

SpectrumImageWriter

public SpectrumImageWriter()

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.data.io.output.AbstractDataContainerWriter<Spectrum>

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class adams.core.option.AbstractOptionHandler

setGenerator

public void setGenerator(AbstractSpectrumImageGenerator value)

Sets the generator to use.

Parameters:

value - the generator

getGenerator

public AbstractSpectrumImageGenerator getGenerator()

Returns the generator to use.

Returns:

the generator

generatorTipText

public String generatorTipText()

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.output.AbstractDataContainerWriter<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.output.AbstractDataContainerWriter<Spectrum>

Returns:

the extension(s) (without the dot!)

writeData

protected boolean writeData(List<Spectrum> data)

Performs the actual writing.

Specified by:

writeData in class adams.data.io.output.AbstractDataContainerWriter<Spectrum>

Parameters:

data - the data to write

Returns:

true if successfully written