org.openimaj.math.geometry.point

Interface Coordinate

All Superinterfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

All Known Subinterfaces:

Location, Point2d, Point3d, ScaleSpacePoint

All Known Implementing Classes:

AbstractPoint2d, AffineInterestPointKeypoint, AffineSimulationKeypoint, AffineSimulationKeypoint.AffineSimulationKeypointLocation, ByteDSIFTKeypoint, CircularInterestPointKeypoint, DoublePoint2dImpl, EllipticInterestPointData, Feature, FloatDSIFTKeypoint, FloatKeypoint, FValuePixel, GenericValuePixel, InterestPointData, InterestPointKeypoint, IntValuePixel, Keypoint, KeypointLocation, MinMaxKeypoint, MinMaxKeypoint.MinMaxKeypointLocation, PayloadCoordinate, Pixel, Point2dImpl, Point3dImpl, QuantisedKeypoint, ScaleSpaceLocation, SIFTGeoKeypoint.SIFTGeoLocation, SpatialLocation, ValuePixel

public interface Coordinate
extends ReadWriteable

Generic interface to get the distance along a dimension of an object representing a point in an n-dimensional space

Author:

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

Method Summary

Modifier and Type	Method and Description
int	getDimensions()
Number	getOrdinate(int dimension) Get the ordinate value for a specific dimension.
void	setOrdinate(int dimension, Number value) Set the ordinate value for a specific dimension.

Methods inherited from interface org.openimaj.io.ReadableASCII

asciiHeader, readASCII

Methods inherited from interface org.openimaj.io.ReadableBinary

binaryHeader, readBinary

Methods inherited from interface org.openimaj.io.WriteableASCII

asciiHeader, writeASCII

Methods inherited from interface org.openimaj.io.WriteableBinary

binaryHeader, writeBinary

Method Detail

getOrdinate

Number getOrdinate(int dimension)

Get the ordinate value for a specific dimension.

Parameters:

dimension - The index of the dimension we are interested in

Returns:

The value of the ordinate of the given dimension.

Throws:

IllegalArgumentException - if the Coordinate does not support the dimension.

setOrdinate

void setOrdinate(int dimension,
                 Number value)

Set the ordinate value for a specific dimension.

Parameters:

dimension - The index of the dimension we are interested in

value - The value of the ordinate of the given dimension.

Throws:

IllegalArgumentException - if the Coordinate does not support the dimension.

getDimensions

int getDimensions()

Returns:

The number of dimensions in the coordinate.