adams.data.filter
Class Threshold

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

All Implemented Interfaces:

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

public class Threshold
extends AbstractFilter<Heatmap>

Zeroes all intensity values that are either below or above a user-specified threshold, depending on the selected threshold type.

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
 

-type <ABOVE|BELOW> (property: type)
    The type of threshold to use: if BELOW then all values that fall below the
    threshold are zeroed, if ABOVE then all values that are above the threshold
    are zeroed.
    default: BELOW
 

-threshold <double> (property: threshold)
    The threshold in percent (0.0 - 100.0).
    default: 90.0
    minimum: 0.0
    maximum: 100.0
 

Version:

$Revision: 6027 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

Threshold.Type The type of threshold.

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

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

protected double	m_Threshold the threshold percentage.
protected Threshold.Type	m_Type the type of threshold.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Threshold()

Method Summary

void	defineOptions() Adds options to the internal list of options.
double	getThreshold() Returns the threshold in use.
Threshold.Type	getType() Returns the type of threshold in use.
String	globalInfo() Returns a string describing the object.
protected Heatmap	processData(Heatmap data) Performs the actual filtering.
void	setThreshold(double value) Sets the threshold to use.
void	setType(Threshold.Type value) Sets the type of threshold to use.
String	thresholdTipText() Returns the tip text for this property.
String	typeTipText() 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_Type

protected Threshold.Type m_Type

the type of threshold.

m_Threshold

protected double m_Threshold

the threshold percentage.

Constructor Detail

Threshold

public Threshold()

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

setType

public void setType(Threshold.Type value)

Sets the type of threshold to use.

Parameters:

value - the type

getType

public Threshold.Type getType()

Returns the type of threshold in use.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setThreshold

public void setThreshold(double value)

Sets the threshold to use.

Parameters:

value - the threshold (0.0 - 100.0)

getThreshold

public double getThreshold()

Returns the threshold in use.

Returns:

the threshold (0.0 - 100.0)

thresholdTipText

public String thresholdTipText()

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