org.openimaj.experiment.evaluation.cluster.analyser

Class RandomBaselineSMEAnalysis

java.lang.Object

org.openimaj.experiment.evaluation.cluster.analyser.RandomBaselineSMEAnalysis

All Implemented Interfaces:

AnalysisResult

public class RandomBaselineSMEAnalysis
extends Object
implements AnalysisResult

Results of applying a RandomBaselineSMEAnalysis to evaluate clustering. These metrics are taken from the Introduction to Information Retrieval. Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
int[][]	correct The correct clustering
int[][]	estimated The estimation
RandomBaselineClusterAnalysis<FScoreAnalysis>	fscore F-Score
RandomBaselineClusterAnalysis<PurityAnalysis>	purity A measure of how pure each cluster is.
RandomBaselineClusterAnalysis<RandomIndexAnalysis>	randIndex
ClusterStatsAnalysis	stats General statistics

Constructor Summary

Constructors

Constructor and Description
RandomBaselineSMEAnalysis(int[][] correct, int[][] estimated) Construct with the correct assignments and estimated assignments.

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

Methods inherited from class java.lang.Object

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

Field Detail

purity

public RandomBaselineClusterAnalysis<PurityAnalysis> purity

A measure of how pure each cluster is. P = 1/N Sigma_k max_j | w_k AND c_j |

Count the true classes of all the elements in a class, make a count of the largest group from each cluster, divide by number of elements in all clusters.

High means: most of the clusters had a high number of a single class Low means: most of the clusters had a roughly equal spread of all the classes

fscore

public RandomBaselineClusterAnalysis<FScoreAnalysis> fscore

F-Score

randIndex

public RandomBaselineClusterAnalysis<RandomIndexAnalysis> randIndex

stats

public ClusterStatsAnalysis stats

General statistics

correct

public int[][] correct

The correct clustering

estimated

public int[][] estimated

The estimation

Constructor Detail

RandomBaselineSMEAnalysis

public RandomBaselineSMEAnalysis(int[][] correct,
                                 int[][] estimated)

Construct with the correct assignments and estimated assignments.

Parameters:

correct -

estimated -

Method Detail

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

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