org.openimaj.feature.local.list

Class LocalFeatureListIndex<K extends ReadWriteable,V extends LocalFeature<?,?>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,LocalFeatureList<V>>

org.openimaj.feature.local.list.LocalFeatureListIndex<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Serializable, Cloneable, Map<K,LocalFeatureList<V>>, ReadableBinary, ReadWriteableBinary, WriteableBinary

public class LocalFeatureListIndex<K extends ReadWriteable,V extends LocalFeature<?,?>>
extends HashMap<K,LocalFeatureList<V>>
implements ReadWriteableBinary

LocalFeatureListIndex is a @{link ReadWriteable} map of keys to local feature lists.

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	BINARY_HEADER The header used when writing LocalFeatureListIndex to streams and files
protected Class<K>	keyClass
protected Class<V>	valueClass

Constructor Summary

Constructors

Constructor and Description
LocalFeatureListIndex()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
static <K extends ReadWriteable,T extends QuantisedLocalFeature<?>> gnu.trove.map.hash.TIntObjectHashMap<gnu.trove.map.hash.TIntObjectHashMap<List<T>>>	invert(LocalFeatureListIndex<K,T> index) Invert an index of quantised features.
void	readBinary(DataInput in) Read internal state from in.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

BINARY_HEADER

public static final byte[] BINARY_HEADER

The header used when writing LocalFeatureListIndex to streams and files

keyClass

protected Class<K extends ReadWriteable> keyClass

valueClass

protected Class<V extends LocalFeature<?,?>> valueClass

Constructor Detail

LocalFeatureListIndex

public LocalFeatureListIndex()

Method Detail

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

invert

public static <K extends ReadWriteable,T extends QuantisedLocalFeature<?>> gnu.trove.map.hash.TIntObjectHashMap<gnu.trove.map.hash.TIntObjectHashMap<List<T>>> invert(LocalFeatureListIndex<K,T> index)

Invert an index of quantised features. The inversion process swaps keys and feature QuantisedLocalFeature.ids around so that the inverted index is a hash of ids to QuantisedLocalFeatures with the Object.hashCode() of the key stored in the QuantisedLocalFeature.id field.

The original index is not affected by the inversion operation.

Type Parameters:

T - the type of local feature.

K - the type of key.

Parameters:

index - the index to invert.

Returns:

an inverted-index data structure.