org.openimaj.feature.local

Class SpatialLocation

java.lang.Object

org.openimaj.math.geometry.point.Point2dImpl

org.openimaj.feature.local.SpatialLocation

All Implemented Interfaces:

Serializable, Cloneable, Location, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Coordinate, Point2d

Direct Known Subclasses:

ByteDSIFTKeypoint, FloatDSIFTKeypoint, ScaleSpaceLocation

public class SpatialLocation
extends Point2dImpl
implements Location, Cloneable

SpatialLocation represents a Location in 2d-space. SpatialLocations contain x and y ordinates.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openimaj.math.geometry.point.Point2dImpl

x, y

Constructor Summary

Constructors

Constructor and Description
SpatialLocation() Construct the ScaleSpaceLocation at 0, 0.
SpatialLocation(float x, float y) Construct the SpatialLocation with the given x and y coordinates.

Method Summary

Methods

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
SpatialLocation	clone()
int	getDimensions()
Float	getOrdinate(int dimension) Get the ordinate value for a specific dimension.
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
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.math.geometry.point.Point2dImpl

copy, copyFrom, createRandomPoint, createRandomPoint, equals, fromDoubleArray, getX, getY, hashCode, minus, setX, setY, toString, transform, translate, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialLocation

public SpatialLocation()

Construct the ScaleSpaceLocation at 0, 0.

SpatialLocation

public SpatialLocation(float x,
               float y)

Construct the SpatialLocation with the given x and y coordinates.

Parameters:

x - the x-coordinate

y - the y-coordinate

Method Detail

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 Point2dImpl

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 Point2dImpl

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 Point2dImpl

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 Point2dImpl

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 Point2dImpl

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 Point2dImpl

Returns:

header

getOrdinate

public Float getOrdinate(int dimension)

Description copied from interface: Coordinate

Get the ordinate value for a specific dimension.

Specified by:

getOrdinate in interface Coordinate

Overrides:

getOrdinate in class Point2dImpl

Parameters:

dimension - The index of the dimension we are interested in

Returns:

The value of the ordinate of the given dimension.

getDimensions

public int getDimensions()

Specified by:

getDimensions in interface Coordinate

Overrides:

getDimensions in class Point2dImpl

Returns:

The number of dimensions in the coordinate.

clone

public SpatialLocation clone()

Overrides:

clone in class Point2dImpl