org.openimaj.knn

Class ObjectNearestNeighbours<T>

java.lang.Object

org.openimaj.knn.ObjectNearestNeighbours<T>

Type Parameters:

T - Type of object being compared.

All Implemented Interfaces:

NearestNeighbours<T,float[],org.openimaj.util.pair.IntFloatPair>

Direct Known Subclasses:

ObjectNearestNeighboursExact

public abstract class ObjectNearestNeighbours<T>
extends Object
implements NearestNeighbours<T,float[],org.openimaj.util.pair.IntFloatPair>

Abstract base class for k-nearest-neighbour calculations with any form of object that can be compared with a DistanceComparator.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.openimaj.util.comparator.DistanceComparator<? super T>	distance

Constructor Summary

Constructors

Constructor and Description
ObjectNearestNeighbours(org.openimaj.util.comparator.DistanceComparator<? super T> distance) Construct with the given distance measure

Method Summary

Modifier and Type	Method and Description
org.openimaj.util.comparator.DistanceComparator<? super T>	distanceComparator() Get the distance comparator
static <T> float	distanceFunc(org.openimaj.util.comparator.DistanceComparator<? super T> distance, T qu, T pnt) Static method to find a distance between a query vector and point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openimaj.knn.NearestNeighbours

searchKNN, searchKNN, searchKNN, searchNN, searchNN, searchNN, size

Field Detail

distance

protected org.openimaj.util.comparator.DistanceComparator<? super T> distance

Constructor Detail

ObjectNearestNeighbours

public ObjectNearestNeighbours(org.openimaj.util.comparator.DistanceComparator<? super T> distance)

Construct with the given distance measure

Parameters:

distance - the distance measure

Method Detail

distanceFunc

public static <T> float distanceFunc(org.openimaj.util.comparator.DistanceComparator<? super T> distance,
                                     T qu,
                                     T pnt)

Static method to find a distance between a query vector and point.

Type Parameters:

T - Type of object being compared.

Parameters:

distance - the distance measure

qu - The query vector.

pnt - The point

Returns:

the distance

distanceComparator

public org.openimaj.util.comparator.DistanceComparator<? super T> distanceComparator()

Get the distance comparator

Returns:

the distance comparator