adams.data.filter
Class Rotate

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.filter.AbstractFilter<Heatmap>
              adams.data.filter.Rotate

All Implemented Interfaces:

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

public class Rotate
extends AbstractFilter<Heatmap>

Rotates a heatmap by a specified number of degrees clockwise.

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
 

-rotation <ROTATE_90_DEGREES|ROTATE_180_DEGREES|ROTATE_270_DEGREES> (property: rotation)
    The type of rotation to perform on the heatmap.
    default: ROTATE_180_DEGREES
 

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

Rotate.Rotation Defines the type of rotation to perform.

Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

protected Rotate.Rotation

m_Rotation the type of rotation to perform.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Rotate()

Method Summary

void	defineOptions() Adds options to the internal list of options.
Rotate.Rotation	getRotation() Returns the type of rotation to perform.
String	globalInfo() Returns a string describing the object.
protected Heatmap	processData(Heatmap data) Performs the actual filtering.
String	rotationTipText() Returns the tip text for this property.
void	setRotation(Rotate.Rotation value) Sets the type of rotation to perform.

Methods inherited from class adams.data.filter.AbstractFilter

checkData, cleanUp, compareTo, destroy, equals, filter, filter, filter, filter, filter, forCommandLine, forName, getFilters, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_Rotation

protected Rotate.Rotation m_Rotation

the type of rotation to perform.

Constructor Detail

Rotate

public Rotate()

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

setRotation

public void setRotation(Rotate.Rotation value)

Sets the type of rotation to perform.

Parameters:

value - the type

getRotation

public Rotate.Rotation getRotation()

Returns the type of rotation to perform.

Returns:

the type

rotationTipText

public String rotationTipText()

Returns the tip text for this property.

Returns:

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

processData

protected Heatmap processData(Heatmap data)

Performs the actual filtering.

Specified by:

processData in class AbstractFilter<Heatmap>

Parameters:

data - the data to filter

Returns:

the filtered data