org.openimaj.feature

Class DiskCachingFeatureExtractor<FEATURE,OBJECT extends Identifiable>

java.lang.Object

org.openimaj.feature.DiskCachingFeatureExtractor<FEATURE,OBJECT>

Type Parameters:

FEATURE - Type of feature

OBJECT - Type of object

All Implemented Interfaces:

FeatureExtractor<FEATURE,OBJECT>

public class DiskCachingFeatureExtractor<FEATURE,OBJECT extends Identifiable>
extends Object
implements FeatureExtractor<FEATURE,OBJECT>

A simple wrapper for a feature extractor that caches the extracted feature to disk. If a feature has already been generated for a given object, it will be re-read from disk rather than being re-generated.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DiskCachingFeatureExtractor(File cacheDir, FeatureExtractor<FEATURE,OBJECT> extractor) Construct the cache in the given directory.
DiskCachingFeatureExtractor(File cacheDir, FeatureExtractor<FEATURE,OBJECT> extractor, boolean force) Construct the cache in the given directory.

Method Summary

Modifier and Type	Method and Description
FEATURE	extractFeature(OBJECT object) Extract features from an object and return them.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskCachingFeatureExtractor

public DiskCachingFeatureExtractor(File cacheDir,
                                   FeatureExtractor<FEATURE,OBJECT> extractor)

Construct the cache in the given directory. There will be one file created per object. The given extractor will be used to generate the features.

Parameters:

cacheDir - the location of the cache

extractor - the feature extractor

DiskCachingFeatureExtractor

public DiskCachingFeatureExtractor(File cacheDir,
                                   FeatureExtractor<FEATURE,OBJECT> extractor,
                                   boolean force)

Construct the cache in the given directory. There will be one file created per object. The given extractor will be used to generate the features. Optionally, all features can be regenerated.

Parameters:

cacheDir - the location of the cache

extractor - the feature extractor

force - if true, then all features will be regenerated and saved, rather than being loaded.

Method Detail

extractFeature

public FEATURE extractFeature(OBJECT object)

Description copied from interface: FeatureExtractor

Extract features from an object and return them.

Specified by:

extractFeature in interface FeatureExtractor<FEATURE,OBJECT extends Identifiable>

Parameters:

object - the object to extract from

Returns:

the extracted feature

toString

public String toString()

Overrides:

toString in class Object