adams.data.conversion
Class HeatmapToBufferedImage

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.conversion.AbstractConversion
              adams.data.conversion.HeatmapToBufferedImage

All Implemented Interfaces:

CleanUpHandler, Debuggable, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class HeatmapToBufferedImage
extends AbstractConversion

Turns a heatmap into a BufferedImage.

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
 

-generator <adams.gui.visualization.heatmap.AbstractColorGradientGenerator> (property: generator)
    The generator to use for creating the gradient colors.
    default: adams.gui.visualization.heatmap.BiColorGenerator
 

Version:

$Revision: 6031 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected AbstractColorGradientGenerator	m_Generator the generator to use.
protected Color[]	m_GradientColors the gradient colors.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

HeatmapToBufferedImage()

Method Summary

Class	accepts() Returns the class that is accepted as input.
void	defineOptions() Adds options to the internal list of options.
protected Object	doConvert() Performs the actual conversion.
Class	generates() Returns the class that is generated as output.
String	generatorTipText() Returns the tip text for this property.
AbstractColorGradientGenerator	getGenerator() Returns the number of gradient colors to use.
protected Color[]	getGradientColors() Generates the gradient colors.
String	globalInfo() Returns a string describing the object.
protected void	reset() Resets the object.
void	setGenerator(AbstractColorGradientGenerator value) Sets the number of gradient colors to use.

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getInput, getOutput, getOwner, getQuickInfo, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

m_Generator

protected AbstractColorGradientGenerator m_Generator

the generator to use.

m_GradientColors

protected Color[] m_GradientColors

the gradient colors.

Constructor Detail

HeatmapToBufferedImage

public HeatmapToBufferedImage()

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 AbstractOptionHandler

reset

protected void reset()

Resets the object.

Overrides:

reset in class AbstractConversion

setGenerator

public void setGenerator(AbstractColorGradientGenerator value)

Sets the number of gradient colors to use.

Parameters:

value - the number of colors

getGenerator

public AbstractColorGradientGenerator getGenerator()

Returns the number of gradient colors to use.

Returns:

the number of colors

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.

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

getGradientColors

protected Color[] getGradientColors()

Generates the gradient colors.

Returns:

the colors

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion