org.openimaj.knn

Interface CoordinateIndex<T extends Coordinate>

Type Parameters:

T - the type of coordinate.

All Known Implementing Classes:

CoordinateBruteForce, CoordinateKDTree

public interface CoordinateIndex<T extends Coordinate>

Interface representing an index of Coordinates that can have points added to it and can be searched in a variety of ways.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	insert(T point) Insert a single coordinate into the index.
void	kNearestNeighbour(Collection<T> result, Coordinate query, int k) Find the k nearest neighbour points in the index to the query coordinate.
T	nearestNeighbour(Coordinate query) Find the nearest coordinate in the index to the query coordinate.
void	rangeSearch(Collection<T> results, Coordinate lowerExtreme, Coordinate upperExtreme) Search for all the coordinates in the index that lie in the hyper-rectangle defined by the lower and upper bound coordinates.

Method Detail

insert

void insert(T point)

Insert a single coordinate into the index.

Parameters:

point - coordinate to add.

rangeSearch

void rangeSearch(Collection<T> results,
                 Coordinate lowerExtreme,
                 Coordinate upperExtreme)

Search for all the coordinates in the index that lie in the hyper-rectangle defined by the lower and upper bound coordinates. Store found coordinates in the results collection.

Parameters:

results - Collection to hold the found coordinates.

lowerExtreme - Lower bound of the hyper-rectangle.

upperExtreme - Upper bound of the hyper-rectangle.

nearestNeighbour

T nearestNeighbour(Coordinate query)

Find the nearest coordinate in the index to the query coordinate.

Parameters:

query - The query coordinate.

Returns:

the closest coordinate in the index.

kNearestNeighbour

void kNearestNeighbour(Collection<T> result,
                       Coordinate query,
                       int k)

Find the k nearest neighbour points in the index to the query coordinate. Store found coordinates in the results collection.

Parameters:

result - Collection to hold the found coordinates.

query - The query coordinate.

k - The number of neighbours to find.