org.openimaj.ml.annotation.model

Class ModelAnnotator<OBJECT,ANNOTATION,FEATURE>

java.lang.Object

org.openimaj.ml.annotation.AbstractAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.BatchAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.model.ModelAnnotator<OBJECT,ANNOTATION,FEATURE>

Type Parameters:

OBJECT - Type of object being annotated

ANNOTATION - Type of annotation

FEATURE - Type of feature extracted by the extractor

All Implemented Interfaces:

Classifier<ANNOTATION,OBJECT>, Annotator<OBJECT,ANNOTATION>, BatchTrainer<Annotated<OBJECT,ANNOTATION>>

public class ModelAnnotator<OBJECT,ANNOTATION,FEATURE>
extends BatchAnnotator<OBJECT,ANNOTATION>

An BatchAnnotator backed by a EstimatableModel. This only really makes sense if the dependent variable of the model can take a set of discrete values.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
ModelAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor, EstimatableModel<FEATURE,ANNOTATION> model, Set<ANNOTATION> annotations) Construct with the given parameters.

Method Summary

Modifier and Type	Method and Description
List<ScoredAnnotation<ANNOTATION>>	annotate(OBJECT object) Generate annotations for the given object.
Set<ANNOTATION>	getAnnotations()
void	train(List<? extends Annotated<OBJECT,ANNOTATION>> data) Train the object with the given data.

Methods inherited from class org.openimaj.ml.annotation.BatchAnnotator

train

Methods inherited from class org.openimaj.ml.annotation.AbstractAnnotator

classify

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelAnnotator

public ModelAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor,
                      EstimatableModel<FEATURE,ANNOTATION> model,
                      Set<ANNOTATION> annotations)

Construct with the given parameters.

Parameters:

extractor - The feature extractor

model - The model

annotations - The set of annotations that the model can produce

Method Detail

train

public void train(List<? extends Annotated<OBJECT,ANNOTATION>> data)

Description copied from interface: BatchTrainer

Train the object with the given data. BatchTrainers should reset the underlying model everytime this method is called.

Parameters:

data - the training data

getAnnotations

public Set<ANNOTATION> getAnnotations()

Returns:

a Set of all annotations this Annotator knows about

annotate

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

Description copied from interface: Annotator

Generate annotations for the given object.

Parameters:

object - the image

Returns:

generated annotations