org.openimaj.image.feature.local.keypoints

Class SIFTGeoKeypoint

java.lang.Object

org.openimaj.image.feature.local.keypoints.SIFTGeoKeypoint

All Implemented Interfaces:

Serializable, Cloneable, FeatureVectorProvider<ByteFV>, LocalFeature<SIFTGeoKeypoint.SIFTGeoLocation,ByteFV>, LocalFeatureVectorProvider<SIFTGeoKeypoint.SIFTGeoLocation,ByteFV>, LocationProvider<SIFTGeoKeypoint.SIFTGeoLocation>, Readable, ReadableASCII, ReadableBinary, ReadWriteable, VariableLength, Writeable, WriteableASCII, WriteableBinary

public class SIFTGeoKeypoint
extends Object
implements LocalFeature<SIFTGeoKeypoint.SIFTGeoLocation,ByteFV>, VariableLength, Cloneable, Serializable

Implementation of a LocalFeature based on the .siftgeo format developed by Krystian Mikolajczyk for his tools.

Because the .siftgeo file-format is custom, it isn't directly compatible with that read by MemoryLocalFeatureList.read(java.io.BufferedInputStream, Class) or written with IOUtils. To work-around these issues, this class implements a set of static I/O methods for reading and writing multiple features to/from a standard .siftgeo file.

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SIFTGeoKeypoint.SIFTGeoLocation The location of a SIFTGeoKeypoint.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	descriptor The descriptor
SIFTGeoKeypoint.SIFTGeoLocation	location The location of the point

Constructor Summary

Constructors

Constructor and Description
SIFTGeoKeypoint(float x, float y, float orientation, float scale, float cornerness, Jama.Matrix affine, byte[] descriptor) Construct with the given parameters
SIFTGeoKeypoint(int len) Construct with the location set to zero, and with an empty descriptor of the given length.

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
ByteFV	getFeatureVector() Get the FeatureVector associated with this object.
SIFTGeoKeypoint.SIFTGeoLocation	getLocation() Get the location associated with this object.
static LocalFeatureList<SIFTGeoKeypoint>	read(DataInputStream stream) Read .siftgeo file from a stream.
static LocalFeatureList<SIFTGeoKeypoint>	read(File file) Read a .siftgeo file.
static LocalFeatureList<SIFTGeoKeypoint>	read(InputStream stream) Read .siftgeo file from a stream.
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
String	toString()
static void	write(List<SIFTGeoKeypoint> keys, DataOutputStream stream) Write a .siftgeo stream
static void	write(List<SIFTGeoKeypoint> keys, File file) Write a .siftgeo file
static void	write(List<SIFTGeoKeypoint> keys, OutputStream stream) Write a .siftgeo stream
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

location

public SIFTGeoKeypoint.SIFTGeoLocation location

The location of the point

descriptor

public byte[] descriptor

The descriptor

Constructor Detail

SIFTGeoKeypoint

public SIFTGeoKeypoint(int len)

Construct with the location set to zero, and with an empty descriptor of the given length.

Parameters:

len - the descriptor length

SIFTGeoKeypoint

public SIFTGeoKeypoint(float x,
                       float y,
                       float orientation,
                       float scale,
                       float cornerness,
                       Jama.Matrix affine,
                       byte[] descriptor)

Construct with the given parameters

Parameters:

x - x-ordinate of feature

y - y-ordinate of feature

scale - scale of feature

orientation - orientation of feature

cornerness - the saliency of the interest point

affine - affine parameters

descriptor - the descriptor

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 ByteFV getFeatureVector()

Description copied from interface: FeatureVectorProvider

Get the FeatureVector associated with this object.

Specified by:

getFeatureVector in interface FeatureVectorProvider<ByteFV>

Returns:

the feature vector.

getLocation

public SIFTGeoKeypoint.SIFTGeoLocation getLocation()

Description copied from interface: LocationProvider

Get the location associated with this object.

Specified by:

getLocation in interface LocationProvider<SIFTGeoKeypoint.SIFTGeoLocation>

Returns:

the location.

toString

public String toString()

Overrides:

toString in class Object

read

public static LocalFeatureList<SIFTGeoKeypoint> read(File file)
                                              throws IOException

Read a .siftgeo file.

Parameters:

file - the file

Returns:

the list of read SIFTGeoKeypoints

Throws:

IOException - if an error occurs during reading

read

public static LocalFeatureList<SIFTGeoKeypoint> read(InputStream stream)
                                              throws IOException

Read .siftgeo file from a stream.

Parameters:

stream - the stream

Returns:

the list of read SIFTGeoKeypoints

Throws:

IOException - if an error occurs during reading

read

public static LocalFeatureList<SIFTGeoKeypoint> read(DataInputStream stream)
                                              throws IOException

Read .siftgeo file from a stream.

Parameters:

stream - the stream

Returns:

the list of read SIFTGeoKeypoints

Throws:

IOException - if an error occurs during reading

write

public static void write(List<SIFTGeoKeypoint> keys,
                         File file)
                  throws IOException

Write a .siftgeo file

Parameters:

keys - the SIFTGeoKeypoints to write

file - the file

Throws:

IOException - if an error occurs whilst writing

write

public static void write(List<SIFTGeoKeypoint> keys,
                         OutputStream stream)
                  throws IOException

Write a .siftgeo stream

Parameters:

keys - the SIFTGeoKeypoints to write

stream - the stream

Throws:

IOException - if an error occurs whilst writing

write

public static void write(List<SIFTGeoKeypoint> keys,
                         DataOutputStream stream)
                  throws IOException

Write a .siftgeo stream

Parameters:

keys - the SIFTGeoKeypoints to write

stream - the stream

Throws:

IOException - if an error occurs whilst writing