gov.sandia.cognition.statistics.method
Class ConvexReceiverOperatingCharacteristic

java.lang.Object
  extended by gov.sandia.cognition.util.AbstractCloneableSerializable
      extended by gov.sandia.cognition.statistics.method.ConvexReceiverOperatingCharacteristic
All Implemented Interfaces:
Evaluator<Double,Double>, CloneableSerializable, Serializable, Cloneable

@PublicationReferences(references={@PublicationReference(author="Wikipedia",title="Concave function",type=WebPage,year=2011,url="http://en.wikipedia.org/wiki/Concave_function"),@PublicationReference(author="Wikipedia",title="Convex hull",type=WebPage,year=2011,url="http://en.wikipedia.org/wiki/Convex_hull")})
public class ConvexReceiverOperatingCharacteristic
extends AbstractCloneableSerializable
implements Evaluator<Double,Double>

Computes the convex hull of the Receiver Operating Characteristic (ROC), which a mathematician might call a "concave down" function. curve.

Since:
3.2.1
Author:
Kevin R. Dixon
See Also:
Serialized Form

Method Summary
 ConvexReceiverOperatingCharacteristic clone()
          This makes public the clone method on the Object class and removes the exception that it throws.
 double computeAreaUnderConvexHull()
          Computes the area under the convex hull
static ConvexReceiverOperatingCharacteristic computeConvexNull(ReceiverOperatingCharacteristic roc)
          Computes the convex hull of a ROC curve
 Double evaluate(Double input)
          Computes the convex hull values using a trapezoid interpolation.
 ArrayList<ReceiverOperatingCharacteristic.DataPoint> getConvexHull()
          Getter for convexHull
protected  void setConvexHull(ArrayList<ReceiverOperatingCharacteristic.DataPoint> convexHull)
          Setter for convexHull
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

clone

public ConvexReceiverOperatingCharacteristic clone()
Description copied from class: AbstractCloneableSerializable
This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:
clone in interface CloneableSerializable
Overrides:
clone in class AbstractCloneableSerializable
Returns:
A clone of this object.

evaluate

public Double evaluate(Double input)
Computes the convex hull values using a trapezoid interpolation.

Specified by:
evaluate in interface Evaluator<Double,Double>
Parameters:
input - falsePositiveRate from which to estimate the truePositiveRate
Returns:
TruePositiveRate for the given FalsePositiveRate

computeConvexNull

public static ConvexReceiverOperatingCharacteristic computeConvexNull(ReceiverOperatingCharacteristic roc)
Computes the convex hull of a ROC curve

Parameters:
roc - ROC curve from which to extract the convex hull
Returns:
Convex hull over the ROC curve

computeAreaUnderConvexHull

public double computeAreaUnderConvexHull()
Computes the area under the convex hull

Returns:
Area under the convex hull

getConvexHull

public ArrayList<ReceiverOperatingCharacteristic.DataPoint> getConvexHull()
Getter for convexHull

Returns:
Convex hull of the ROC curve

setConvexHull

protected void setConvexHull(ArrayList<ReceiverOperatingCharacteristic.DataPoint> convexHull)
Setter for convexHull

Parameters:
convexHull - Convex hull of the ROC curve