adams.data.io.input
Class FloatMatrixHeatmapReader

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.input.AbstractDataContainerReader<Heatmap>
              adams.data.io.input.AbstractHeatmapReader
                  adams.data.io.input.FloatMatrixHeatmapReader

All Implemented Interfaces:

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

public class FloatMatrixHeatmapReader
extends AbstractHeatmapReader

Reads 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
 

-input <adams.core.io.PlaceholderFile> (property: input)
    The file to read and turn into a container.
    default: ${CWD}
 

-create-dummy-report (property: createDummyReport)
    If true, then a dummy report is created if none present.
 

-height <int> (property: height)
    The height of the heatmap.
    default: 240
    minimum: 1
 

-width <int> (property: width)
    The width of the heatmap.
    default: 320
    minimum: 1
 

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected int	m_Height the height of the heatmap.
protected int	m_Width the width of the heatmap.

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_DebugLevel, m_OptionManager

Constructor Summary

FloatMatrixHeatmapReader()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected int	getDefaultHeight() Returns the default height of the heatmap.
protected int	getDefaultWidth() Returns the default width of the heatmap.
String	getFormatDescription() Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions() Returns the extension(s) of the format.
int	getHeight() Returns the height of the heatmap.
int	getWidth() Returns the width of the heatmap.
String	globalInfo() Returns a string describing the object.
String	heightTipText() Returns the tip text for this property.
protected void	readData() Performs the actual reading.
void	setHeight(int value) Sets the height of the heatmap.
void	setWidth(int value) Sets the width of the heatmap.
String	widthTipText() Returns the tip text for this property.

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

getReaders

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

checkData, cleanUp, compareTo, createDummyReport, createDummyReportTipText, destroy, doRead, equals, forCommandLine, forName, getCreateDummyReport, getInput, initialize, inputTipText, isInputFile, postProcessData, read, reset, setCreateDummyReport, setInput, shallowCopy, shallowCopy

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

Field Detail

m_Height

protected int m_Height

the height of the heatmap.

m_Width

protected int m_Width

the width of the heatmap.

Constructor Detail

FloatMatrixHeatmapReader

public FloatMatrixHeatmapReader()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractDataContainerReader<Heatmap>

getDefaultHeight

protected int getDefaultHeight()

Returns the default height of the heatmap.

Returns:

the default height

setHeight

public void setHeight(int value)

Sets the height of the heatmap.

Parameters:

value - the height

getHeight

public int getHeight()

Returns the height of the heatmap.

Returns:

the height

heightTipText

public String heightTipText()

Returns the tip text for this property.

Returns:

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

getDefaultWidth

protected int getDefaultWidth()

Returns the default width of the heatmap.

Returns:

the default width

setWidth

public void setWidth(int value)

Sets the width of the heatmap.

Parameters:

value - the width

getWidth

public int getWidth()

Returns the width of the heatmap.

Returns:

the width

widthTipText

public String widthTipText()

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

Returns:

the extension(s) (without the dot!)

readData

protected void readData()

Performs the actual reading.

Specified by:

readData in class AbstractDataContainerReader<Heatmap>