Package adams.data.weka.predictions

Class RelativeNumericErrorScaler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.weka.predictions.AbstractErrorScaler

adams.data.weka.predictions.RelativeNumericErrorScaler

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable, weka.core.CapabilitiesHandler

public class RelativeNumericErrorScaler
extends AbstractErrorScaler

Scales the errors for numeric class attributes.

Valid options are:

-max <int> (property: maxSize)
    The maximum size of the errors after scaling.
    default: 20
    minimum: 1
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MaxSize	the maximum size.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
RelativeNumericErrorScaler()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
weka.core.Capabilities	getCapabilities()	Returns the capabilities of this object.
int	getMaxSize()	Returns the maximum size for the errors.
String	globalInfo()	Returns a string describing the object.
String	maxSizeTipText()	Returns the tip text for this property.
ArrayList	scale(ArrayList data)	Scales the errors.
void	setMaxSize(int value)	Sets the maximum size for the errors.

Methods inherited from class adams.data.weka.predictions.AbstractErrorScaler

compareTo, equals, forCommandLine, forName, getErrorScalers, shallowCopy, shallowCopy, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_MaxSize

protected int m_MaxSize

the maximum size.

Constructor Detail

RelativeNumericErrorScaler

public RelativeNumericErrorScaler()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

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

setMaxSize

public void setMaxSize(int value)

Sets the maximum size for the errors.

Parameters:

value - the size

getMaxSize

public int getMaxSize()

Returns the maximum size for the errors.

Returns:

the size

maxSizeTipText

public String maxSizeTipText()

Returns the tip text for this property.

Returns:

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

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the capabilities of this object. Returns what types of classes the scaler can handle.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Specified by:

getCapabilities in class AbstractErrorScaler

Returns:

the capabilities of this object

See Also:

Capabilities

scale

public ArrayList scale(ArrayList data)

Scales the errors.

Specified by:

scale in class AbstractErrorScaler

Parameters:

data - the data containing the errors to scale

Returns:

the scaled errors