org.openimaj.experiment.evaluation.cluster.analyser

Class DecisionAnalysis

java.lang.Object

org.openimaj.experiment.evaluation.cluster.analyser.DecisionAnalysis

All Implemented Interfaces:

AnalysisResult

public class DecisionAnalysis
extends Object
implements AnalysisResult

Counting the number of true positives, true negatives, flase postitives and false negatives one can produce various cluster quality metrics including the fscore and randindex

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
long	FN The total number of pairs in different clusters which belong to the same class
long	FP The total number of pairs in a cluster which do not belong to the same class
long	TN The total number of pairs in different clusters which belong to different classes
long	TP The total number of pairs in a cluster which belong to the same class

Constructor Summary

Constructors

Constructor and Description
DecisionAnalysis()

Method Summary

Modifier and Type	Method and Description
String	getDetailReport() Get a String detailing the result.
net.sf.jasperreports.engine.JasperPrint	getDetailReport(String title, String info) Get a JasperPrint detailing the result.
String	getSummaryReport() Get a String summarising the result.
net.sf.jasperreports.engine.JasperPrint	getSummaryReport(String title, String info) Get a JasperPrint summarising the result.
double	precision()
double	recall()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TP

public long TP

The total number of pairs in a cluster which belong to the same class

FP

public long FP

The total number of pairs in a cluster which do not belong to the same class

TN

public long TN

The total number of pairs in different clusters which belong to different classes

FN

public long FN

The total number of pairs in different clusters which belong to the same class

Constructor Detail

DecisionAnalysis

public DecisionAnalysis()

Method Detail

getSummaryReport

public net.sf.jasperreports.engine.JasperPrint getSummaryReport(String title,
                                                                String info)
                                                         throws net.sf.jasperreports.engine.JRException

Description copied from interface: AnalysisResult

Get a JasperPrint summarising the result.

Specified by:

getSummaryReport in interface AnalysisResult

Parameters:

title - a title to add to the report

info - information to print at the beginning of the report

Returns:

a String summarising the result

Throws:

net.sf.jasperreports.engine.JRException

getDetailReport

public net.sf.jasperreports.engine.JasperPrint getDetailReport(String title,
                                                               String info)
                                                        throws net.sf.jasperreports.engine.JRException

Description copied from interface: AnalysisResult

Get a JasperPrint detailing the result.

Specified by:

getDetailReport in interface AnalysisResult

Parameters:

title - a title to add to the report

info - information to print at the beginning of the report

Returns:

a JasperPrint detailing the result.

Throws:

net.sf.jasperreports.engine.JRException

getSummaryReport

public String getSummaryReport()

Description copied from interface: AnalysisResult

Get a String summarising the result.

Specified by:

getSummaryReport in interface AnalysisResult

Returns:

a String summarising the result

getDetailReport

public String getDetailReport()

Description copied from interface: AnalysisResult

Get a String detailing the result.

Specified by:

getDetailReport in interface AnalysisResult

Returns:

a String detailing the result

toString

public String toString()

Overrides:

toString in class Object

precision

public double precision()

Returns:

The number of true positives as a proportion of overall positives

recall

public double recall()

Returns:

The number of true positives as a porportion of true positives and false negatives