org.openimaj.ml.annotation

Interface Annotator<OBJECT,ANNOTATION>

Type Parameters:

OBJECT - Type of object being annotated

ANNOTATION - Type of annotation

All Superinterfaces:

Classifier<ANNOTATION,OBJECT>

All Known Subinterfaces:

SentimentAnnotator<OBJECT,CLONETYPE>

All Known Implementing Classes:

AbstractAnnotator, AnnotatorFaceRecogniser, AudioAnnotator, BatchAnnotator, DenseLinearTransformAnnotator, EigenFaceRecogniser, EntityAnnotator, FaceRecogniser, FeatureCachingIncrementalBatchAnnotator, FisherFaceRecogniser, IncrementalAnnotator, IndependentPriorRandomAnnotator, InstanceCachingIncrementalBatchAnnotator, KNNAnnotator, LiblinearAnnotator, LinearSVMAnnotator, ModelAnnotator, MPQAToken, MPQATokenList, NaiveBayesAnnotator, NaiveBayesSentimentAnnotator, SVMAnnotator, TokenListSentimentAnnotator, TokenSentimentAnnotator, UniformRandomAnnotator, YagoEntityCandidateAnnotator, YagoEntityCompleteAnnotator, YagoEntityContextAnnotator

public interface Annotator<OBJECT,ANNOTATION>
extends Classifier<ANNOTATION,OBJECT>

Base class for objects capable of annotating things. Annotators are essentially general forms of classifiers; annotation and classification should be seen as synonymous.

The annotation interface extends the idea of a classifier with support for feature-extraction from certain forms of object in order to generate the classifications/annotations. The annotate(Object) and Classifier.classify(Object) methods do exactly the same thing, but return results in different forms. Which method is used might depend on the task at hand. A simple implementation of the Classifier.classify(Object) method that calls the annotate(Object) method can be found in the AbstractAnnotator class. Implementors are advised to extend the AbstractAnnotator class or one of its subclasses.

Author:

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

Method Summary

Modifier and Type	Method and Description
List<ScoredAnnotation<ANNOTATION>>	annotate(OBJECT object) Generate annotations for the given object.
Set<ANNOTATION>	getAnnotations()

Methods inherited from interface org.openimaj.experiment.evaluation.classification.Classifier

classify

Method Detail

getAnnotations

Set<ANNOTATION> getAnnotations()

Returns:

a Set of all annotations this Annotator knows about

annotate

List<ScoredAnnotation<ANNOTATION>> annotate(OBJECT object)

Generate annotations for the given object.

Parameters:

object - the image

Returns:

generated annotations