org.openimaj.experiment.evaluation.retrieval.analysers

Class PrecisionAtN<QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable>

java.lang.Object

org.openimaj.experiment.evaluation.retrieval.analysers.PrecisionAtN<QUERY,DOCUMENT>

Type Parameters:

QUERY - Type of query

DOCUMENT - Type of document

All Implemented Interfaces:

RetrievalAnalyser<PrecisionAtNResult<QUERY>,QUERY,DOCUMENT>

public class PrecisionAtN<QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable>
extends Object
implements RetrievalAnalyser<PrecisionAtNResult<QUERY>,QUERY,DOCUMENT>

RetrievalAnalyser that computes the precision after N documents have been retrieved (P@N).

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	N

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PrecisionAtNResult<QUERY>	analyse(Map<QUERY,List<DOCUMENT>> results, Map<QUERY,Set<DOCUMENT>> relevant) Analyse ranked results from a RetrievalEngine against a ground-truth set of relevant results and produce an AnalysisResult which can be read by a human.

Methods inherited from class java.lang.Object

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

Field Detail

N

protected int N

Constructor Detail

PrecisionAtN

public PrecisionAtN(int n)

Construct with the given N.

Parameters:

n - N, the number of top-ranked documents to consider.

Method Detail

analyse

public PrecisionAtNResult<QUERY> analyse(Map<QUERY,List<DOCUMENT>> results,
                                         Map<QUERY,Set<DOCUMENT>> relevant)

Description copied from interface: RetrievalAnalyser

Analyse ranked results from a RetrievalEngine against a ground-truth set of relevant results and produce an AnalysisResult which can be read by a human.

Specified by:

analyse in interface RetrievalAnalyser<PrecisionAtNResult<QUERY>,QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable>

Parameters:

results - the results per query from the RetrievalEngine.

relevant - the ground-truth relevant documents per query.

Returns:

the results of the analysis