org.openimaj.feature.local.list

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

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<T>

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

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

Type Parameters:

T - the type of local feature

All Implemented Interfaces:

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

public class StreamLocalFeatureList<T extends LocalFeature<?,?>>
extends AbstractStreamBackedList<T>
implements LocalFeatureList<T>

A list of LocalFeatures backed by an input stream. The list is read-only, and can only be read in order (i.e. random access is not possible).

Author:

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

Field Summary

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

clz, consumed, 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	StreamLocalFeatureList(InputStream stream, int size, boolean isBinary, int headerLength, int recordLength, int veclen, Class<T> clz)

Method Summary

Methods

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 id your instances can't be constructed with a no-args ctr
static <T extends LocalFeature<?,?>> StreamLocalFeatureList<T>	read(BufferedInputStream stream, Class<T> clz) Construct a new StreamLocalFeatureList from the given input stream.
static <T extends LocalFeature<?,?>> StreamLocalFeatureList<T>	read(InputStream stream, Class<T> clz) Construct a new StreamLocalFeatureList from the given input stream.
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.AbstractStreamBackedList

consumed, listIterator, randomSubList, readRecord, readRecordASCII, remaining, size

Methods inherited from class java.util.AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class java.util.AbstractList

add, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, 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, retainAll, set, size, toArray, toArray

Constructor Detail

StreamLocalFeatureList

protected StreamLocalFeatureList(InputStream stream,
                      int size,
                      boolean isBinary,
                      int headerLength,
                      int recordLength,
                      int veclen,
                      Class<T> clz)

Method Detail

read

public static <T extends LocalFeature<?,?>> StreamLocalFeatureList<T> read(InputStream stream,
                                                           Class<T> clz)
                                                                throws IOException

Construct a new StreamLocalFeatureList from the given input stream.

Type Parameters:

T - the type of local feature

Parameters:

stream - the input stream

clz - the class of local feature to read

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static <T extends LocalFeature<?,?>> StreamLocalFeatureList<T> read(BufferedInputStream stream,
                                                           Class<T> clz)
                                                                throws IOException

Construct a new StreamLocalFeatureList from the given input stream.

Type Parameters:

T - the type of local feature

Parameters:

stream - the input stream

clz - the class of local feature to read

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

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 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.

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

newElementInstance

protected T newElementInstance()

Description copied from class: AbstractStreamBackedList

Override this id your instances can't be constructed with a no-args ctr

Overrides:

newElementInstance in class AbstractStreamBackedList<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 AbstractList<T extends LocalFeature<?,?>>