edu.stanford.nlp.util

Class ConfusionMatrix<U>

java.lang.Object

edu.stanford.nlp.util.ConfusionMatrix<U>

Type Parameters:

U - the class label type

public class ConfusionMatrix<U>
extends java.lang.Object

This implements a confusion table over arbitrary types of class labels. Main routines of interest:

• add(guess, gold), increments the guess/gold entry in this cell by 1
• get(guess, gold), returns the number of entries in this cell
• toString(), returns printed form of the table, with marginals and contingencies for each class label

Example usage:

 Confusion<String> myConf = new Confusion<String>();
 myConf.add("l1", "l1");
 myConf.add("l1", "l2");
 myConf.add("l2", "l2");
 System.out.println(myConf.toString());
 

NOTES: - This sorts by the toString() of the guess and gold labels. Thus the label.toString() values should be distinct!

Author:

yeh1@cs.stanford.edu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ConfusionMatrix.Contingency Contingency table, listing precision ,recall, specificity, and f1 given the number of true and false positives, true and false negatives.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.DecimalFormat	format

Constructor Summary

Constructors

Constructor and Description
ConfusionMatrix()
ConfusionMatrix(java.util.Locale locale)

Method Summary

Modifier and Type	Method and Description
void	add(U guess, U gold) Increments the entry for this guess and gold by 1.
void	add(U guess, U gold, int increment) Increments the entry for this guess and gold by the given increment amount.
java.lang.Integer	get(U guess, U gold) Retrieves the number of entries with this guess and gold.
ConfusionMatrix.Contingency	getContingency(U positiveLabel) Returns the contingency table for the given class label, where all other class labels are treated as negative.
void	gui() Show the confusion matrix in a GUI.
static void	main(java.lang.String[] args)
java.lang.String	printTable() Prints the current confusion in table form to a string, with contingency
void	setDelimPadSize(int newPadSize) Sets the width used to separate cells in the table.
void	setLeftPadSize(int newPadSize) This sets the lefthand side pad width for displaying the text table.
void	setUseRealLabels(boolean useRealLabels)
java.lang.String	toString()
java.util.Set<U>	uniqueLabels() Returns the set of distinct class labels entered into this confusion table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

format

protected java.text.DecimalFormat format

Constructor Detail

ConfusionMatrix

public ConfusionMatrix()

ConfusionMatrix

public ConfusionMatrix(java.util.Locale locale)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setLeftPadSize

public void setLeftPadSize(int newPadSize)

This sets the lefthand side pad width for displaying the text table.

Parameters:

newPadSize -

setDelimPadSize

public void setDelimPadSize(int newPadSize)

Sets the width used to separate cells in the table.

setUseRealLabels

public void setUseRealLabels(boolean useRealLabels)

add

public void add(U guess,
                U gold)

Increments the entry for this guess and gold by 1.

add

public void add(U guess,
                U gold,
                int increment)

Increments the entry for this guess and gold by the given increment amount.

get

public java.lang.Integer get(U guess,
                             U gold)

Retrieves the number of entries with this guess and gold.

uniqueLabels

public java.util.Set<U> uniqueLabels()

Returns the set of distinct class labels entered into this confusion table.

getContingency

public ConfusionMatrix.Contingency getContingency(U positiveLabel)

Returns the contingency table for the given class label, where all other class labels are treated as negative.

printTable

public java.lang.String printTable()

Prints the current confusion in table form to a string, with contingency

gui

public void gui()

Show the confusion matrix in a GUI.

main

public static void main(java.lang.String[] args)