Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.classifiers.performanceMeasures
Class ROCCurve

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

All Implemented Interfaces:
  GalaxyConvertible, Storable, Cloneable

Direct Known Subclasses:
  AucROC

    public class ROCCurve

extends TwoClassAbstractPerformanceMeasure

This class implements the Receiver Operating Characteristics curve and the area under the curve. The Receiver Operating Characteristics curve is the plot of sensitivity () against the false positive rate ( ) for all possible classification thresholds. If you are only interested in the area under this curve, you can use `AucROC` instead.

Author:
  Jan Grau, Jens Keilwagen

Nested Class Summary

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

Field Summary
`static String` | `NAME` The name of the performance measure return by `getName()`

Fields inherited from class de.jstacs.parameters.ParameterSet
`errorMessage, parameters, parent`

Constructor Summary
`ROCCurve()` Constructs a new instance of the performance measure `ROCCurve`.
`ROCCurve(StringBuffer xml)` The standard constructor for the interface `Storable`.

Method Summary
`ResultSet` | `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
`compute, 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`

Field Detail

### NAME

    public static final String NAME

  The name of the performance measure return by `getName()`

  See Also:
    Constant Field Values

Constructor Detail

### ROCCurve

    public ROCCurve()

  Constructs a new instance of the performance measure `ROCCurve`.

### ROCCurve

    public ROCCurve(StringBuffer xml)
             throws NonParsableException

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

  Parameters:
    `xml` - the XML representation as `StringBuffer`
  Throws:
    `NonParsableException` - if the `ROCCurve` could not be reconstructed out of the `StringBuffer` `xml`

Method Detail

### getName

    public String getName()

  Description copied from class: `AbstractPerformanceMeasure`
  The method returns the name of the performance measure.

  Specified by:
    `getName` in class `AbstractPerformanceMeasure`
  Returns:
    the name of the performance measure

### compute

    public ResultSet 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 class `AbstractPerformanceMeasure`
  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[])`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD