org.openimaj.feature.local

Class FloatLocalFeatureAdaptor<L extends Location>

java.lang.Object

org.openimaj.feature.local.FloatLocalFeatureAdaptor<L>

Type Parameters:

L - The type of Location

All Implemented Interfaces:

FeatureVectorProvider<FloatFV>, LocalFeature<L,FloatFV>, LocalFeatureVectorProvider<L,FloatFV>, LocationProvider<L>, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

public class FloatLocalFeatureAdaptor<L extends Location>
extends Object
implements LocalFeature<L,FloatFV>

This class is designed as a wrapper around any form of local feature and provides a way of exposing that feature as a FloatFV, without the cost of necessarily storing the underlying feature as a FloatFV. For example, this can be used to make a Keypoint look like it's backed by a float array rather than a byte array, without incurring the four-times increase in storage this would incur.

The implementation also allows a normalisation process to occur during conversion through a Normaliser.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FloatLocalFeatureAdaptor(LocalFeature<L,?> localFeature) Construct a new FloatLocalFeatureAdaptor with the given underlying feature
FloatLocalFeatureAdaptor(LocalFeature<L,?> localFeature, Normaliser<FloatFV> normaliser) Construct a new FloatLocalFeatureAdaptor with the given underlying feature and normaliser.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
boolean	equals(Object obj)
FloatFV	getFeatureVector() Get the FeatureVector associated with this object.
L	getLocation() Get the location associated with this object.
int	hashCode()
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
static <L extends Location> List<FloatLocalFeatureAdaptor<L>>	wrap(List<? extends LocalFeature<L,?>> list) Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.
static <L extends Location> List<FloatLocalFeatureAdaptor<L>>	wrap(List<? extends LocalFeature<L,?>> list, Normaliser<FloatFV> normaliser) Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.
static List<FloatLocalFeatureAdaptor<?>>	wrapUntyped(List<? extends LocalFeature<?,?>> list) Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.
static List<FloatLocalFeatureAdaptor<?>>	wrapUntyped(List<? extends LocalFeature<?,?>> list, Normaliser<FloatFV> normaliser) Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.
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 java.lang.Object

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

Constructor Detail

FloatLocalFeatureAdaptor

public FloatLocalFeatureAdaptor(LocalFeature<L,?> localFeature)

Construct a new FloatLocalFeatureAdaptor with the given underlying feature

Parameters:

localFeature - the underlying feature

FloatLocalFeatureAdaptor

public FloatLocalFeatureAdaptor(LocalFeature<L,?> localFeature,
                                Normaliser<FloatFV> normaliser)

Construct a new FloatLocalFeatureAdaptor with the given underlying feature and normaliser.

Parameters:

localFeature - the underlying feature

normaliser - the normaliser

Method Detail

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

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

Returns:

header

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

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

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

getFeatureVector

public FloatFV getFeatureVector()

Description copied from interface: FeatureVectorProvider

Get the FeatureVector associated with this object.

Specified by:

getFeatureVector in interface FeatureVectorProvider<FloatFV>

Returns:

the feature vector.

getLocation

public L getLocation()

Description copied from interface: LocationProvider

Get the location associated with this object.

Specified by:

getLocation in interface LocationProvider<L extends Location>

Returns:

the location.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

wrap

public static <L extends Location> List<FloatLocalFeatureAdaptor<L>> wrap(List<? extends LocalFeature<L,?>> list)

Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.

Parameters:

list - the input list

Returns:

the wrapped list

wrapUntyped

public static List<FloatLocalFeatureAdaptor<?>> wrapUntyped(List<? extends LocalFeature<?,?>> list)

Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.

Parameters:

list - the input list

Returns:

the wrapped list

wrap

public static <L extends Location> List<FloatLocalFeatureAdaptor<L>> wrap(List<? extends LocalFeature<L,?>> list,
                                                                          Normaliser<FloatFV> normaliser)

Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.

Parameters:

list - the input list

normaliser - the normaliser

Returns:

the wrapped list

wrapUntyped

public static List<FloatLocalFeatureAdaptor<?>> wrapUntyped(List<? extends LocalFeature<?,?>> list,
                                                            Normaliser<FloatFV> normaliser)

Produce a LocalFeatureList of FloatLocalFeatureAdaptor by wrapping the input list, and dynamically wrapping with the FloatLocalFeatureAdaptors on demand.

Parameters:

list - the input list

normaliser - the normaliser

Returns:

the wrapped list