de.jstacs.classifiers.performanceMeasures
Class PerformanceMeasureParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.parameters.ExpandableParameterSet
          de.jstacs.classifiers.performanceMeasures.AbstractPerformanceMeasureParameterSet<PerformanceMeasure>
              de.jstacs.classifiers.performanceMeasures.PerformanceMeasureParameterSet

All Implemented Interfaces:

GalaxyConvertible, Storable, Cloneable

public class PerformanceMeasureParameterSet
extends AbstractPerformanceMeasureParameterSet<PerformanceMeasure>

This class implements a container of AbstractPerformanceMeasures that can be used in AbstractClassifier.evaluate(AbstractPerformanceMeasureParameterSet, boolean, de.jstacs.data.DataSet...).

Author:

Jens Keilwagen, Jan Grau

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ExpandableParameterSet

commentTemplate, nameTemplate, template

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

PerformanceMeasureParameterSet(int numClasses)
Constructs a new PerformanceMeasureParameterSet that can be used for classifiers that handle the given number of classes.

PerformanceMeasureParameterSet(PerformanceMeasure... measures)
Constructs a new PerformanceMeasureParameterSet with the given performance measures.

PerformanceMeasureParameterSet(StringBuffer xml)
The standard constructor for the interface Storable.

Method Summary

Methods inherited from class de.jstacs.classifiers.performanceMeasures.AbstractPerformanceMeasureParameterSet

createFilledParameters, createFilledParameters, getAllMeasures, getNumberOfClasses, removeMeasure, removeMeasures, removeMeasures, setMeasure

Methods inherited from class de.jstacs.parameters.ExpandableParameterSet

addParameterToSet, clone, fromGalaxy, fromXML, parameterRemovable, removeParameterFromSet, replaceContentWith, toGalaxy, toXML

Methods inherited from class de.jstacs.parameters.ParameterSet

getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerformanceMeasureParameterSet

public PerformanceMeasureParameterSet(StringBuffer xml)
                               throws NonParsableException

The standard constructor for the interface Storable. Constructs a PerformanceMeasureParameterSet out of an XML representation.

Parameters:

xml - the XML representation as StringBuffer

Throws:

NonParsableException - if the PerformanceMeasureParameterSet could not be reconstructed out of the StringBuffer xml

PerformanceMeasureParameterSet

public PerformanceMeasureParameterSet(int numClasses)
                               throws Exception

Constructs a new PerformanceMeasureParameterSet that can be used for classifiers that handle the given number of classes.

Parameters:

numClasses - the number of classes

Throws:

Exception - if something went wrong

See Also:

AbstractClassifier.getNumberOfClasses()

PerformanceMeasureParameterSet

public PerformanceMeasureParameterSet(PerformanceMeasure... measures)
                               throws Exception

Constructs a new PerformanceMeasureParameterSet with the given performance measures. The number of classes this PerformanceMeasureParameterSet can be used for is determined from the given AbstractPerformanceMeasures. If no measure is given, a new PerformanceMeasureParameterSet for binary classifiers is created.

Parameters:

measures - the AbstractPerformanceMeasure that shall be used

Throws:

Exception - if something went wrong