adams.data.filter
Class SubtractField

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

All Implemented Interfaces:

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

public class SubtractField
extends AbstractFilter<Heatmap>

Subtracts the value of the numeric field from all non-zero heatmap values.
Values that fall below zero are automatically set to zero (minimum value for a heatmap).

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
 

-field <adams.data.report.Field> (property: field)
    The (numeric) field in the report to subtract from the heatmap values.
    default: Heatsense\\tTemperature[N]
 

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 Field

m_Field the field containing the numeric value.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

SubtractField()

Method Summary

void	defineOptions() Adds options to the internal list of options.
String	fieldTipText() Returns the tip text for this property.
Field	getField() Returns the field to normalize to.
String	globalInfo() Returns a string describing the object.
protected Heatmap	processData(Heatmap data) Performs the actual filtering.
void	setField(Field value) Sets the field to normalize to.

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_Field

protected Field m_Field

the field containing the numeric value.

Constructor Detail

SubtractField

public SubtractField()

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

setField

public void setField(Field value)

Sets the field to normalize to.

Parameters:

value - the field

getField

public Field getField()

Returns the field to normalize to.

Returns:

the field

fieldTipText

public String fieldTipText()

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