adams.data.filter
Class Submap

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

All Implemented Interfaces:

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

public class Submap
extends AbstractFilter<Heatmap>

Creates a submap, specified by the coordinates of the top-left corner (row and column), width and height.

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
 

-row <int> (property: row)
    The row of the top-left corner, the starting point of the submap (0-based
    ).
    default: 0
    minimum: 0
 

-col <int> (property: column)
    The column of the top-left corner, the starting point of the submap (0-based
    ).
    default: 0
    minimum: 0
 

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

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

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

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

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

protected int	m_Column the column to start (top-left).
protected int	m_Height the height of the submap.
protected int	m_Row the row to start (top-left).
protected int	m_Width the width of the submap.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Submap()

Method Summary

String	columnTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
int	getColumn() Returns the column start the submap from.
int	getHeight() Returns the height start the submap from.
int	getRow() Returns the row start the submap from.
int	getWidth() Returns the width start the submap from.
String	globalInfo() Returns a string describing the object.
String	heightTipText() Returns the tip text for this property.
protected Heatmap	processData(Heatmap data) Performs the actual filtering.
String	rowTipText() Returns the tip text for this property.
void	setColumn(int value) Sets the column to start the submap from.
void	setHeight(int value) Sets the height of the submap.
void	setRow(int value) Sets the row to start the submap from.
void	setWidth(int value) Sets the width of the submap.
String	widthTipText() Returns the tip text for this property.

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_Row

protected int m_Row

the row to start (top-left).

m_Column

protected int m_Column

the column to start (top-left).

m_Height

protected int m_Height

the height of the submap.

m_Width

protected int m_Width

the width of the submap.

Constructor Detail

Submap

public Submap()

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

setRow

public void setRow(int value)

Sets the row to start the submap from.

Parameters:

value - the row (top-left corner)

getRow

public int getRow()

Returns the row start the submap from.

Returns:

the row (top-left corner)

rowTipText

public String rowTipText()

Returns the tip text for this property.

Returns:

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

setColumn

public void setColumn(int value)

Sets the column to start the submap from.

Parameters:

value - the column (top-left corner)

getColumn

public int getColumn()

Returns the column start the submap from.

Returns:

the column (top-left corner)

columnTipText

public String columnTipText()

Returns the tip text for this property.

Returns:

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

setHeight

public void setHeight(int value)

Sets the height of the submap.

Parameters:

value - the height

getHeight

public int getHeight()

Returns the height start the submap from.

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.

setWidth

public void setWidth(int value)

Sets the width of the submap.

Parameters:

value - the width

getWidth

public int getWidth()

Returns the width start the submap from.

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.

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