org.openimaj.experiment.evaluation.cluster.analyser

Class NMIAnalysis

java.lang.Object

org.openimaj.experiment.evaluation.cluster.analyser.NMIAnalysis

All Implemented Interfaces:

AnalysisResult, RandomBaselineWrappable

public class NMIAnalysis
extends Object
implements AnalysisResult, RandomBaselineWrappable

Measures normalised mutual information. Intuatively this is how much information one gets about the true clustering given the estimate clustering

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
double	nmi The NMI

Constructor Summary

Constructors

Constructor and Description
NMIAnalysis()

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	score()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nmi

public double nmi

The NMI

Constructor Detail

NMIAnalysis

public NMIAnalysis()

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

score

public double score()

Specified by:

score in interface RandomBaselineWrappable

Returns:

the underlying score to wrap in a TestRandomBaselineClusterAnalyser