org.openimaj.experiment.evaluation.retrieval

Interface RetrievalAnalyser<RESULT extends AnalysisResult,QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable>

Type Parameters:

RESULT - the type of AnalysisResult produced.

QUERY - the type of the queries

DOCUMENT - the type of the documents

All Known Implementing Classes:

IREvalAnalyser, PrecisionAtN, TRECEvalAnalyser

public interface RetrievalAnalyser<RESULT extends AnalysisResult,QUERY,DOCUMENT extends org.openimaj.data.identity.Identifiable>

A RetrievalAnalyser is used to analyse the raw search results from a RetrievalEngine in the context of a RetrievalEvaluator and to produce an AnalysisResult describing the performance of the RetrievalEngine.

Author:

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

Method Summary

Modifier and Type	Method and Description
RESULT	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.

Method Detail

analyse

RESULT 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.

Parameters:

results - the results per query from the RetrievalEngine.

relevant - the ground-truth relevant documents per query.

Returns:

the results of the analysis