adams.data.io.output
Class FloatMatrixHeatmapWriter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.output.AbstractDataContainerWriter<Heatmap>
              adams.data.io.output.AbstractHeatmapWriter
                  adams.data.io.output.FloatMatrixHeatmapWriter

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<AbstractDataContainerWriter>, SizeOfHandler, Serializable, Comparable

public class FloatMatrixHeatmapWriter
extends AbstractHeatmapWriter

Writes heat map files (2-D array of single precision floating point numbers).

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

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

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_Output, m_OutputIsFile

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

FloatMatrixHeatmapWriter()

Method Summary

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.
protected void	initialize() Initializes the members.
protected boolean	writeData(List<Heatmap> data) Performs the actual writing.

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

getWriters

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

checkData, cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getOutput, isOutputFile, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatMatrixHeatmapWriter

public FloatMatrixHeatmapWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

getFormatDescription

public String getFormatDescription()

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

Specified by:

getFormatDescription in class AbstractDataContainerWriter<Heatmap>

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 class AbstractDataContainerWriter<Heatmap>

Returns:

the extension(s) (without the dot!)

writeData

protected boolean writeData(List<Heatmap> data)

Performs the actual writing.

Specified by:

writeData in class AbstractDataContainerWriter<Heatmap>

Parameters:

data - the data to write

Returns:

true if successfully written