org.openimaj.ml.annotation

Class FeatureCachingIncrementalBatchAnnotator<OBJECT,ANNOTATION,FEATURE>

java.lang.Object

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

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

org.openimaj.ml.annotation.FeatureCachingIncrementalBatchAnnotator<OBJECT,ANNOTATION,FEATURE>

Type Parameters:

OBJECT - Type of object

ANNOTATION - Type of annotation

FEATURE - Type of feature extracted and cached.

All Implemented Interfaces:

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

public class FeatureCachingIncrementalBatchAnnotator<OBJECT,ANNOTATION,FEATURE>
extends IncrementalAnnotator<OBJECT,ANNOTATION>

Adaptor that allows a BatchAnnotator to behave like a IncrementalAnnotator by caching extracted features and then performing training only when annotate(Object) is called.

Because the features are cached, the internal annotator must rely on a IdentityFeatureExtractor or similar, and thus not perform any extraction itself.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FeatureCachingIncrementalBatchAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor, BatchAnnotator<FEATURE,ANNOTATION> batchAnnotator) Construct with the given feature extractor and batch annotator, and use an in-memory cache.
FeatureCachingIncrementalBatchAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor, BatchAnnotator<FEATURE,ANNOTATION> batchAnnotator, GroupedListCache<ANNOTATION,FEATURE> cache) Construct with the given feature extractor and batch annotator, and use an in-memory cache.

Method Summary

Modifier and Type	Method and Description
List<ScoredAnnotation<ANNOTATION>>	annotate(OBJECT object) Generate annotations for the given object.
Set<ANNOTATION>	getAnnotations()
void	reset() Reset the object to its initial condition, as if it hasn't seen any training data.
void	train(Annotated<OBJECT,ANNOTATION> annotated) Train/update object using a new instance.

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

train, train, trainMultiClass

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

FeatureCachingIncrementalBatchAnnotator

public FeatureCachingIncrementalBatchAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor,
                                               BatchAnnotator<FEATURE,ANNOTATION> batchAnnotator)

Construct with the given feature extractor and batch annotator, and use an in-memory cache.

Parameters:

extractor - the extractor

batchAnnotator - the annotator

FeatureCachingIncrementalBatchAnnotator

public FeatureCachingIncrementalBatchAnnotator(FeatureExtractor<FEATURE,OBJECT> extractor,
                                               BatchAnnotator<FEATURE,ANNOTATION> batchAnnotator,
                                               GroupedListCache<ANNOTATION,FEATURE> cache)

Construct with the given feature extractor and batch annotator, and use an in-memory cache.

Parameters:

extractor - the extractor

batchAnnotator - the annotator

cache - the cache

Method Detail

train

public void train(Annotated<OBJECT,ANNOTATION> annotated)

Description copied from interface: IncrementalTrainer

Train/update object using a new instance.

Parameters:

annotated - instance to train with

reset

public void reset()

Description copied from interface: IncrementalTrainer

Reset the object to its initial condition, as if it hasn't seen any 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