org.openimaj.image.feature.local.keypoints

Class FloatKeypoint

java.lang.Object

org.openimaj.image.feature.local.keypoints.FloatKeypoint

All Implemented Interfaces:

Serializable, Cloneable, FeatureVectorProvider<FloatFV>, LocalFeature<KeypointLocation,FloatFV>, LocalFeatureVectorProvider<KeypointLocation,FloatFV>, LocationProvider<KeypointLocation>, Readable, ReadableASCII, ReadableBinary, ReadWriteable, VariableLength, Writeable, WriteableASCII, WriteableBinary, Coordinate, Point2d, ScaleSpacePoint

public class FloatKeypoint
extends Object
implements Serializable, ScaleSpacePoint, LocalFeature<KeypointLocation,FloatFV>, VariableLength, Cloneable

A local interest point with a location, scale, orientation and associated feature. The feature is stored as an array of floats.

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	ori dominant orientation of keypoint
float	scale scale of keypoint
float[]	vector keypoint feature descriptor (i.e.
float	x x-position of keypoint
float	y y-position of keypoint

Constructor Summary

Constructors

Constructor and Description
FloatKeypoint() Construct with the default feature vector length for SIFT (128).
FloatKeypoint(float x, float y, float ori, float scale, float[] ivec) Construct with the given parameters.
FloatKeypoint(FloatKeypoint k) Construct by copying from another FloatKeypoint
FloatKeypoint(int length) Construct with the given feature vector length.
FloatKeypoint(Keypoint k) Construct from a Keypoint.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader()
byte[]	binaryHeader()
FloatKeypoint	clone()
static MemoryLocalFeatureList<FloatKeypoint>	convert(List<? extends Keypoint> keys) Convert a list of Keypoints to FloatKeypoints.
Point2d	copy()
void	copyFrom(Point2d p)
boolean	equals(Object obj)
int	getDimensions()
FloatFV	getFeatureVector()
KeypointLocation	getLocation()
Float	getOrdinate(int dimension)
float	getScale()
float	getX()
float	getY()
int	hashCode()
boolean	locationEquals(Object obj) Test whether the location of this FloatKeypoint and another FloatKeypoint is the same.
Point2d	minus(Point2d a)
void	readASCII(Scanner in)
void	readBinary(DataInput in)
void	setLocation(KeypointLocation location) Set the location of this FloatKeypoint
void	setOrdinate(int dimension, Number value)
void	setScale(float scale)
void	setX(float x)
void	setY(float y)
String	toString()
FloatKeypoint	transform(Jama.Matrix transform)
void	translate(float x, float y)
void	translate(Point2d v)
void	writeASCII(PrintWriter out)
void	writeBinary(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

vector

public float[] vector

keypoint feature descriptor (i.e. SIFT)

ori

public float ori

dominant orientation of keypoint

scale

public float scale

scale of keypoint

x

public float x

x-position of keypoint

y

public float y

y-position of keypoint

Constructor Detail

FloatKeypoint

public FloatKeypoint()

Construct with the default feature vector length for SIFT (128).

FloatKeypoint

public FloatKeypoint(int length)

Construct with the given feature vector length.

Parameters:

length - the length of the feature vector

FloatKeypoint

public FloatKeypoint(float x,
                     float y,
                     float ori,
                     float scale,
                     float[] ivec)

Construct with the given parameters.

Parameters:

x - the x-ordinate of the keypoint

y - the y-ordinate of the keypoint

ori - the orientation of the keypoint

scale - the scale of the keypoint

ivec - the feature vector of the keypoint

FloatKeypoint

public FloatKeypoint(FloatKeypoint k)

Construct by copying from another FloatKeypoint

Parameters:

k - the FloatKeypoint to copy from

FloatKeypoint

public FloatKeypoint(Keypoint k)

Construct from a Keypoint.

Parameters:

k -

Method Detail

getOrdinate

public Float getOrdinate(int dimension)

Specified by:

getOrdinate in interface Coordinate

getDimensions

public int getDimensions()

Specified by:

getDimensions in interface Coordinate

getX

public float getX()

Specified by:

getX in interface Point2d

getY

public float getY()

Specified by:

getY in interface Point2d

setX

public void setX(float x)

Specified by:

setX in interface Point2d

setY

public void setY(float y)

Specified by:

setY in interface Point2d

getScale

public float getScale()

Specified by:

getScale in interface ScaleSpacePoint

setScale

public void setScale(float scale)

Specified by:

setScale in interface ScaleSpacePoint

toString

public String toString()

Overrides:

toString in class Object

locationEquals

public boolean locationEquals(Object obj)

Test whether the location of this FloatKeypoint and another FloatKeypoint is the same.

Parameters:

obj - the other keypoint

Returns:

true if the locations match; false otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FloatKeypoint clone()

Overrides:

clone in class Object

copyFrom

public void copyFrom(Point2d p)

Specified by:

copyFrom in interface Point2d

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Specified by:

writeBinary in interface WriteableBinary

Throws:

IOException

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Specified by:

writeASCII in interface WriteableASCII

Throws:

IOException

readBinary

public void readBinary(DataInput in)
                throws IOException

Specified by:

readBinary in interface ReadableBinary

Throws:

IOException

readASCII

public void readASCII(Scanner in)
               throws IOException

Specified by:

readASCII in interface ReadableASCII

Throws:

IOException

binaryHeader

public byte[] binaryHeader()

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

asciiHeader

public String asciiHeader()

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

getFeatureVector

public FloatFV getFeatureVector()

Specified by:

getFeatureVector in interface FeatureVectorProvider<FloatFV>

getLocation

public KeypointLocation getLocation()

Specified by:

getLocation in interface LocationProvider<KeypointLocation>

setLocation

public void setLocation(KeypointLocation location)

Set the location of this FloatKeypoint

Parameters:

location - the location

translate

public void translate(float x,
                      float y)

Specified by:

translate in interface Point2d

transform

public FloatKeypoint transform(Jama.Matrix transform)

Specified by:

transform in interface Point2d

minus

public Point2d minus(Point2d a)

Specified by:

minus in interface Point2d

translate

public void translate(Point2d v)

Specified by:

translate in interface Point2d

copy

public Point2d copy()

Specified by:

copy in interface Point2d

convert

public static MemoryLocalFeatureList<FloatKeypoint> convert(List<? extends Keypoint> keys)

Convert a list of Keypoints to FloatKeypoints.

Parameters:

keys - the Keypoints to convert.

Returns:

the converted FloatKeypoints.

setOrdinate

public void setOrdinate(int dimension,
                        Number value)

Specified by:

setOrdinate in interface Coordinate