de.jstacs.classifiers.performanceMeasures

Class AbstractTwoClassPerformanceMeasure

java.lang.Object

de.jstacs.parameters.ParameterSet

de.jstacs.classifiers.performanceMeasures.AbstractPerformanceMeasure

de.jstacs.classifiers.performanceMeasures.AbstractTwoClassPerformanceMeasure

All Implemented Interfaces:

PerformanceMeasure, GalaxyConvertible, Storable, Cloneable

Direct Known Subclasses:

AbstractNumericalTwoClassPerformanceMeasure, PRCurve, ROCCurve

public abstract class AbstractTwoClassPerformanceMeasure
extends AbstractPerformanceMeasure

This class is the abstract super class of any performance measure that can only be computed for binary classifiers.

Author:

Jan Grau, Jens Keilwagen

Nested Class Summary

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

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTwoClassPerformanceMeasure() Constructs a new AbstractTwoClassPerformanceMeasure with empty parameter values.
protected	AbstractTwoClassPerformanceMeasure(StringBuffer xml) The standard constructor for the interface Storable.

Method Summary

Modifier and Type	Method and Description
ResultSet	compute(double[][][] classSpecificScores, double[][] weights) This method allows to compute the performance measure of given class specific scores.
int	getAllowedNumberOfClasses() This method returns the allowed number of classes.

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

compute, compute, findSplitIndex, findThreshold, getCollectionOfAllMeasures, getName, getWeight, simpleWeights

Methods inherited from class de.jstacs.parameters.ParameterSet

clone, fromGalaxy, fromXML, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy, toXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.jstacs.classifiers.performanceMeasures.PerformanceMeasure

compute

Constructor Detail

AbstractTwoClassPerformanceMeasure

protected AbstractTwoClassPerformanceMeasure()

Constructs a new AbstractTwoClassPerformanceMeasure with empty parameter values.

AbstractTwoClassPerformanceMeasure

protected AbstractTwoClassPerformanceMeasure(StringBuffer xml)
                                      throws NonParsableException

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

Parameters:

xml - the XML representation as StringBuffer

Throws:

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

Method Detail

compute

public ResultSet compute(double[][][] classSpecificScores,
                         double[][] weights)

Description copied from interface: PerformanceMeasure

This method allows to compute the performance measure of given class specific scores.

Parameters:

classSpecificScores - the scores; first dimension = data sets, second dimension = sequences of the data set, third dimension classes of the classifier

weights - the weights for all sequence in all data sets

Returns:

a result set containing the results of the performance measure

getAllowedNumberOfClasses

public final int getAllowedNumberOfClasses()

Description copied from interface: PerformanceMeasure

This method returns the allowed number of classes. For many performance measures this number is fixed, e.g. for AUC-ROC the number is 2. If the number is not fixed the method returns 0, e.g. for the classification rate.

Returns:

the allowed number of classes

See Also:

AbstractClassifier.getNumberOfClasses()