Package edu.cmu.tetrad.algcomparison.statistic

Class OrientationRecall

java.lang.Object

edu.cmu.tetrad.algcomparison.statistic.OrientationRecall

All Implemented Interfaces:

Statistic, Serializable

public class OrientationRecall
extends Object
implements Statistic

Represents an implementation of the Statistic interface that calculates the Orientation Recall.

The Orientation Recall is a statistic that measures the accuracy of the estimated orientation of edges in a graph compared to the true graph. It calculates the ratio of true positive orientations to the sum of true positive and false negative orientations.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OrientationRecall()	Constructs a new instance of the statistic.

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Returns the abbreviation for the statistic.
String	getDescription()	Returns a short one-line description of this statistic.
double	getNormValue(double value)	Returns a mapping of the statistic to the interval [0, 1], with higher being better.
double	getValue(Graph trueGraph, Graph estGraph, DataModel dataModel)	Calculates the Orientation Recall statistic, which measures the accuracy of the estimated orientation of edges in a graph compared to the true graph.

Methods inherited from class java.lang.Object

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

Constructor Details

OrientationRecall

public OrientationRecall()

Constructs a new instance of the statistic.

Method Details

getAbbreviation

public String getAbbreviation()

Returns the abbreviation for the statistic.

Specified by:

getAbbreviation in interface Statistic

Returns:

The abbreviation.

getDescription

public String getDescription()

Returns a short one-line description of this statistic. This will be printed at the beginning of the report.

Specified by:

getDescription in interface Statistic

Returns:

The description of the statistic.

getValue

public double getValue(Graph trueGraph,
 Graph estGraph,
 DataModel dataModel)

Calculates the Orientation Recall statistic, which measures the accuracy of the estimated orientation of edges in a graph compared to the true graph.

Specified by:

getValue in interface Statistic

Parameters:

trueGraph - The true graph (DAG, CPDAG, PAG_of_the_true_DAG).

estGraph - The estimated graph (same type).

dataModel - The data model.

Returns:

The value of the statistic.

getNormValue

public double getNormValue(double value)

Returns a mapping of the statistic to the interval [0, 1], with higher being better. This is used for a calculation of a utility for an algorithm. If the statistic is already between 0 and 1, you can just return the statistic.

Specified by:

getNormValue in interface Statistic

Parameters:

value - The value of the statistic.

Returns:

The weight of the statistic, 0 to 1, higher is better.