org.openimaj.feature

Class MultidimensionalShortFV

java.lang.Object

org.openimaj.feature.ArrayFeatureVector<short[]>

org.openimaj.feature.ShortFV

org.openimaj.feature.MultidimensionalShortFV

All Implemented Interfaces:

Serializable, Cloneable, FeatureVector, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Concatenatable<ShortFV,ShortFV>

public class MultidimensionalShortFV
extends ShortFV
implements Serializable, Cloneable, FeatureVector

Basic short multidimensional feature vector implementation

Author:

Jonathon Hare

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int[]	nbins Array containing the number of bins in each dimension

Fields inherited from class org.openimaj.feature.ArrayFeatureVector

values

Constructor Summary

Constructors

Constructor and Description
MultidimensionalShortFV() Construct an empty feature vector
MultidimensionalShortFV(int... nbins) Construct empty FV with given dimensions
MultidimensionalShortFV(short[][] values) Construct from 2-dimensional array
MultidimensionalShortFV(short[][][] values) Construct from 3-dimensional array
MultidimensionalShortFV(short[] values, int... nbins) Construct from flattened values array and dimensions

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
MultidimensionalDoubleFV	asDoubleFV() Convert the FV to a DoubleFV representation
byte[]	binaryHeader() Header for binary input.
MultidimensionalShortFV	clone()
double	compare(MultidimensionalShortFV h, ShortFVComparison method) Compare this FV to another with the given method.
short	get(int... coords) Get the element at the given n-dimensional coordinate
short	get(int x) Get the element at the given flat index
int[]	getCoordinates(int index) Given an index, calculate the coordinate which would map to that index using getIndex(int...)
int	getIndex(int... coords) Convert the given coordinate into a flat index value
short[]	getVector() Get the underlying flat-vector representation
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
void	set(short value, int... coords) Set the the element at the given n-dimensional coordinate
String	toString()
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.feature.ShortFV

asDoubleVector, compare, concatenate, concatenate, equals, getAsDouble, hashCode, length, newInstance, normaliseFV, normaliseFV, normaliseFV, normaliseFV, setFromDouble, subvector, subvector

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.feature.FeatureVector

asDoubleVector, getAsDouble, length, newInstance, normaliseFV, normaliseFV, normaliseFV, normaliseFV, setFromDouble

Field Detail

nbins

public int[] nbins

Array containing the number of bins in each dimension

Constructor Detail

MultidimensionalShortFV

public MultidimensionalShortFV()

Construct an empty feature vector

MultidimensionalShortFV

public MultidimensionalShortFV(int... nbins)

Construct empty FV with given dimensions

Parameters:

nbins - the number of bins in each dimension

MultidimensionalShortFV

public MultidimensionalShortFV(short[] values,
                               int... nbins)

Construct from flattened values array and dimensions

Parameters:

values - the flat array of values

nbins - the number of bins in each dimension

MultidimensionalShortFV

public MultidimensionalShortFV(short[][] values)

Construct from 2-dimensional array

Parameters:

values - the 2d array

MultidimensionalShortFV

public MultidimensionalShortFV(short[][][] values)

Construct from 3-dimensional array

Parameters:

values - the 3d array

Method Detail

getVector

public short[] getVector()

Get the underlying flat-vector representation

Specified by:

getVector in interface FeatureVector

Overrides:

getVector in class ArrayFeatureVector<short[]>

Returns:

a flat 1d representation of the feature

get

public short get(int x)

Get the element at the given flat index

Overrides:

get in class ShortFV

Parameters:

x - the flattened element index

Returns:

the value corresponding to x

getIndex

public int getIndex(int... coords)

Convert the given coordinate into a flat index value

Parameters:

coords - the coordinate

Returns:

the flattened index

set

public void set(short value,
                int... coords)

Set the the element at the given n-dimensional coordinate

Parameters:

value - the value to set

coords - the coordinates

get

public short get(int... coords)

Get the element at the given n-dimensional coordinate

Parameters:

coords - the coordinates

Returns:

the value at the given coordinates

clone

public MultidimensionalShortFV clone()

Overrides:

clone in class ShortFV

toString

public String toString()

Overrides:

toString in class ShortFV

asDoubleFV

public MultidimensionalDoubleFV asDoubleFV()

Convert the FV to a DoubleFV representation

Specified by:

asDoubleFV in interface FeatureVector

Overrides:

asDoubleFV in class ShortFV

Returns:

the DoubleFV representation

compare

public double compare(MultidimensionalShortFV h,
                      ShortFVComparison method)

Compare this FV to another with the given method.

Parameters:

h - the feature to compare against.

method - the method to compare with.

Returns:

a score determined by the comparison method.

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

Overrides:

writeBinary in class ShortFV

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

Overrides:

writeASCII in class ShortFV

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Overrides:

readBinary in class ShortFV

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Overrides:

readASCII in class ShortFV

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

Overrides:

binaryHeader in class ShortFV

Returns:

header

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Overrides:

asciiHeader in class ShortFV

Returns:

header

getCoordinates

public int[] getCoordinates(int index)

Given an index, calculate the coordinate which would map to that index using getIndex(int...)

Parameters:

index -

Returns:

the coordinates