de.jstacs.classifiers.performanceMeasures
Class AucROC

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

All Implemented Interfaces:

NumericalPerformanceMeasure, GalaxyConvertible, Storable, Cloneable

public class AucROC
extends ROCCurve
implements NumericalPerformanceMeasure

This class implements the area under curve of the Receiver Operating Characteristics curve.

Author:

Jan Grau, Jens Keilwagen

See Also:

AucROC

Nested Class Summary

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

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.classifiers.performanceMeasures.ROCCurve

NAME

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

AucROC()
Constructs a new instance of the performance measure AucROC.

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

Method Summary

NumericalResultSet	compute(double[][][] classSpecificScores) This method allows to compute the performance measure of given class specific scores.
NumericalResultSet	compute(double[] sortedScoresClass0, double[] sortedScoresClass1) This method allows to compute the performance measure of given sorted score ratios.
String	getName() The method returns the name of the performance measure.

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

getAllowedNumberOfClasses

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

getCollectionOfAllMeasures

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

AucROC

public AucROC()

Constructs a new instance of the performance measure AucROC.

AucROC

public AucROC(StringBuffer xml)
       throws NonParsableException

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

Parameters:

xml - the XML representation as StringBuffer

Throws:

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

Method Detail

compute

public NumericalResultSet compute(double[] sortedScoresClass0,
                                  double[] sortedScoresClass1)

Description copied from class: AbstractPerformanceMeasure

This method allows to compute the performance measure of given sorted score ratios. This method can only be used for binary classifiers.

Specified by:

compute in interface NumericalPerformanceMeasure

Overrides:

compute in class ROCCurve

Parameters:

sortedScoresClass0 - the sorted score ratios of class 0

sortedScoresClass1 - the sorted score ratios of class 1

Returns:

a result set containing the results of the performance measure

See Also:

Arrays.sort(double[])

compute

public NumericalResultSet 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 interface NumericalPerformanceMeasure

Overrides:

compute in class TwoClassAbstractPerformanceMeasure

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

getName

public String getName()

Description copied from class: AbstractPerformanceMeasure

The method returns the name of the performance measure.

Overrides:

getName in class ROCCurve

Returns:

the name of the performance measure