adams.data.weka.predictions
Class NamedSetup

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.data.weka.predictions.AbstractErrorScaler
              extended by adams.data.weka.predictions.NamedSetup
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, SizeOfHandler, Serializable, weka.core.CapabilitiesHandler

public class NamedSetup
extends AbstractErrorScaler

Applies a scaler that is referenced via its global setup name (see 'NamedSetups').

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
 
-setup <java.lang.String> (property: setup)
    The name of the setup to use.
    default: name_of_setup
 

Version:
$Revision: 4584 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

Field Summary
protected  AbstractErrorScaler m_ActualScheme
          the actual scheme.
protected  NamedSetup m_Setup
          the name of the setup to load.
 
Fields inherited from class adams.core.option.AbstractOptionHandler
m_DebugLevel, m_OptionManager
 
Constructor Summary
NamedSetup()
           
 
Method Summary
 void defineOptions()
          Adds options to the internal list of options.
protected  AbstractErrorScaler getActualScheme()
          Returns the named setup.
 weka.core.Capabilities getCapabilities()
          Returns the capabilities of this object.
 NamedSetup getSetup()
          Returns the setup name.
 String globalInfo()
          Returns a string describing the object.
 void reset()
          Resets the filter.
 ArrayList scale(ArrayList data)
          Scales the errors.
 void setSetup(NamedSetup value)
          Sets the setup name.
 String setupTipText()
          Returns the tip text for this property.
 
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, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, setDebugLevel, toCommandLine
 
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_Setup

protected NamedSetup m_Setup
the name of the setup to load.


m_ActualScheme

protected AbstractErrorScaler m_ActualScheme
the actual scheme.

Constructor Detail

NamedSetup

public NamedSetup()
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

reset

public void reset()
Resets the filter.

Overrides:
reset in class AbstractOptionHandler

setSetup

public void setSetup(NamedSetup value)
Sets the setup name.

Parameters:
value - the name

getSetup

public NamedSetup getSetup()
Returns the setup name.

Returns:
the name

setupTipText

public String setupTipText()
Returns the tip text for this property.

Returns:
tip text for this property suitable for displaying in the gui

getActualScheme

protected AbstractErrorScaler getActualScheme()
Returns the named setup.

Returns:
the actual scheme to use

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


Copyright © 2012 University of Waikato, Hamilton, NZ. All Rights Reserved.