de.jstacs.classifiers.performanceMeasures
Class TwoClassAbstractPerformanceMeasure

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.classifiers.performanceMeasures.AbstractPerformanceMeasure
          de.jstacs.classifiers.performanceMeasures.TwoClassAbstractPerformanceMeasure

All Implemented Interfaces:

GalaxyConvertible, Storable, Cloneable

Direct Known Subclasses:

FalsePositiveRateForFixedSensitivity, MaximumNumericalTwoClassMeasure, PositivePredictiveValueForFixedSensitivity, PRCurve, ROCCurve, SensitivityForFixedSpecificity

public abstract class TwoClassAbstractPerformanceMeasure
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

protected	TwoClassAbstractPerformanceMeasure() Constructs a new TwoClassAbstractPerformanceMeasure with empty parameter values.
protected	TwoClassAbstractPerformanceMeasure(StringBuffer xml) The standard constructor for the interface Storable.

Method Summary

ResultSet	compute(double[][][] classSpecificScores) 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, getCollectionOfAllMeasures, getName

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

Constructor Detail

TwoClassAbstractPerformanceMeasure

protected TwoClassAbstractPerformanceMeasure()

Constructs a new TwoClassAbstractPerformanceMeasure with empty parameter values.

TwoClassAbstractPerformanceMeasure

protected TwoClassAbstractPerformanceMeasure(StringBuffer xml)
                                      throws NonParsableException

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

Parameters:

xml - the XML representation as StringBuffer

Throws:

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

Method Detail

compute

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

Description copied from class: AbstractPerformanceMeasure

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

Specified by:

compute in class AbstractPerformanceMeasure

Parameters:

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

Returns:

a result set containing the results of the performance measure

getAllowedNumberOfClasses

public final int getAllowedNumberOfClasses()

Description copied from class: AbstractPerformanceMeasure

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.

Specified by:

getAllowedNumberOfClasses in class AbstractPerformanceMeasure

Returns:

the allowed number of classes

See Also:

AbstractClassifier.getNumberOfClasses()