org.openimaj.experiment.evaluation.retrieval.analysers

Class PrecisionAtNResult<QUERY>

java.lang.Object

org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtNResult<QUERY>

Type Parameters:

QUERY - Type of query

All Implemented Interfaces:

AnalysisResult

public class PrecisionAtNResult<QUERY>
extends Object
implements AnalysisResult

AnalysisResult used with PrecisionAtN to hold the P@N precision after N documents have been retrieved.

Provides both per-query precisions and descriptive statistics over all queries.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
PrecisionAtNResult(int N) Construct with the given N.

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

Constructor Detail

PrecisionAtNResult

public PrecisionAtNResult(int N)

Construct with the given N.

Parameters:

N - number of retrieved documents at which precision is calculated

Method Detail

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

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