org.openimaj.feature.local.list

Class FileLocalFeatureList<T extends LocalFeature<?,?>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.openimaj.util.list.AbstractFileBackedList<T>

org.openimaj.feature.local.list.FileLocalFeatureList<T>

Type Parameters:

T - the type of local feature

All Implemented Interfaces:

Cloneable, Iterable<T>, Collection<T>, List<T>, LocalFeatureList<T>, Writeable, WriteableASCII, WriteableBinary, RandomisableList<T>

public class FileLocalFeatureList<T extends LocalFeature<?,?>>
extends AbstractFileBackedList<T>
implements LocalFeatureList<T>, Cloneable

A LocalFeatureList backed by a file. Data is only read as necessary.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	veclen

Fields inherited from class org.openimaj.util.list.AbstractFileBackedList

charset, clz, file, headerLength, isBinary, recordLength, size

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.openimaj.feature.local.list.LocalFeatureList

BINARY_HEADER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileLocalFeatureList(int size, int veclen, boolean isBinary, int headerLength, int recordLength, File file, Class<T> clz)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii output.
<Q> Q[]	asDataArray(Q[] a) Get the feature-vector data of the list as a two-dimensional array of data.
byte[]	binaryHeader() Header for binary output.
protected T	newElementInstance() Override this if your instances can't be constructed with a no-args constructor
protected AbstractFileBackedList<T>	newInstance(int newSize, boolean isBinary, int newHeaderLength, int recordLength, File file)
static <T extends LocalFeature<?,?>> FileLocalFeatureList<T>	read(File keypointFile, Class<T> clz) Read a file containing a set of local features of a type clz.
MemoryLocalFeatureList<T>	subList(int fromIndex, int toIndex)
int	vecLength() Get the length of the feature-vectors of each local feature if they are constant.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class org.openimaj.util.list.AbstractFileBackedList

add, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, randomSubList, readRecord, readRecordASCII, set, size, toArray, toArray

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, listIterator, listIterator, remove, removeRange

Methods inherited from class java.util.AbstractCollection

addAll, remove, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.util.list.RandomisableList

randomSubList

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

veclen

protected final int veclen

Constructor Detail

FileLocalFeatureList

protected FileLocalFeatureList(int size,
                               int veclen,
                               boolean isBinary,
                               int headerLength,
                               int recordLength,
                               File file,
                               Class<T> clz)

Method Detail

read

public static <T extends LocalFeature<?,?>> FileLocalFeatureList<T> read(File keypointFile,
                                                                         Class<T> clz)
                                                                  throws IOException

Read a file containing a set of local features of a type clz. It is assumed that clz can instantiate itself either given a vec length or no parameters and furthermore, that this instantiated instance can write itself, even when filled with no other data.

Type Parameters:

T - the local feature class

Parameters:

keypointFile - the file

clz - the local feature class

Returns:

a list of local feature backed by the file

Throws:

IOException - if a problem occurs reading the file

vecLength

public int vecLength()

Description copied from interface: LocalFeatureList

Get the length of the feature-vectors of each local feature if they are constant. This value is used as instantiate new local features in the case that the local feature has a constructor that takes a single integer.

Specified by:

vecLength in interface LocalFeatureList<T extends LocalFeature<?,?>>

Returns:

the feature-vector length

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

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

binaryHeader

public byte[] binaryHeader()

Description copied from interface: WriteableBinary

Header for binary output. Will be automatically written by IOUtils when using writeBinary().

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

asciiHeader

public String asciiHeader()

Description copied from interface: WriteableASCII

Header for ascii output. Will be automatically written by IOUtils when using writeASCII().

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

asDataArray

public <Q> Q[] asDataArray(Q[] a)

Description copied from interface: LocalFeatureList

Get the feature-vector data of the list as a two-dimensional array of data. The number of rows will equal the number of features in the list, and the type <Q>must be compatible with the data type of the features themselves.

Specified by:

asDataArray in interface LocalFeatureList<T extends LocalFeature<?,?>>

Type Parameters:

Q - the data type

Parameters:

a - the array to fill

Returns:

the array, filled with the feature-vector data.

newInstance

protected AbstractFileBackedList<T> newInstance(int newSize,
                                                boolean isBinary,
                                                int newHeaderLength,
                                                int recordLength,
                                                File file)

Specified by:

newInstance in class AbstractFileBackedList<T extends LocalFeature<?,?>>

newElementInstance

protected T newElementInstance()

Description copied from class: AbstractFileBackedList

Override this if your instances can't be constructed with a no-args constructor

Overrides:

newElementInstance in class AbstractFileBackedList<T extends LocalFeature<?,?>>

Returns:

subList

public MemoryLocalFeatureList<T> subList(int fromIndex,
                                         int toIndex)

Specified by:

subList in interface List<T extends LocalFeature<?,?>>

Specified by:

subList in interface LocalFeatureList<T extends LocalFeature<?,?>>

Overrides:

subList in class AbstractFileBackedList<T extends LocalFeature<?,?>>