org.openimaj.util.tree

Class ShortKDTree

java.lang.Object

org.openimaj.util.tree.ShortKDTree

public class ShortKDTree
extends Object

Immutable KD-Tree implementation for short[] data. Allows various tree-construction strategies to be applied through the ShortKDTree.SplitChooser. Supports efficient range, radius and nearest-neighbour search for relatively low dimensional spaces.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShortKDTree.ApproximateBBFMedianSplit Approximate best-bin-first median splitting.
static class	ShortKDTree.BasicMedianSplit Basic median split.
static class	ShortKDTree.BBFMedianSplit Best-bin-first median splitting.
static class	ShortKDTree.KDTreeNode An internal node of the KDTree
static class	ShortKDTree.RandomisedBBFMeanSplit Randomised best-bin-first splitting strategy: Nodes with less than a set number of items become leafs.
static interface	ShortKDTree.SplitChooser Interface for describing how a branch in the KD-Tree should be created

Field Summary

Fields

Modifier and Type	Field and Description
short[][]	data The underlying data array
ShortKDTree.KDTreeNode	root The tree roots

Constructor Summary

Constructors

Constructor and Description
ShortKDTree(short[][] data) Construct with the given data and default splitting strategy (ShortKDTree.BBFMedianSplit)
ShortKDTree(short[][] data, ShortKDTree.SplitChooser split) Construct with the given data and splitting strategy

Method Summary

Modifier and Type	Method and Description
short[][]	coordinateRadiusSearch(short[] centre, short radius) Find all the points within the given radius of the given point.
void	coordinateRadiusSearch(short[] centre, short radius, gnu.trove.procedure.TObjectFloatProcedure<short[]> proc) Find all the points within the given radius of the given point.
short[][]	coordinateRangeSearch(short[] lowerExtreme, short[] upperExtreme) Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes.
int[]	indexRadiusSearch(short[] centre, short radius) Search the tree for the indexes of all points contained within the hypersphere defined by the given centre and radius.
int[]	indexRangeSearch(short[] lowerExtreme, short[] upperExtreme) Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes.
List<int[]>	leafIndices() Find all the indices seperated by leaves
IntFloatPair	nearestNeighbour(short[] qu) Nearest-neighbour search
List<IntFloatPair>	nearestNeighbours(short[] qu, int n) Nearest-neighbour search
void	radiusSearch(short[] centre, short radius, gnu.trove.procedure.TIntObjectProcedure<short[]> proc) Find all the points within the given radius of the given point.
void	rangeSearch(short[] lowerExtreme, short[] upperExtreme, gnu.trove.procedure.TIntObjectProcedure<short[]> proc) Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes.

Methods inherited from class java.lang.Object

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

Field Detail

root

public final ShortKDTree.KDTreeNode root

The tree roots

data

public final short[][] data

The underlying data array

Constructor Detail

ShortKDTree

public ShortKDTree(short[][] data)

Construct with the given data and default splitting strategy (ShortKDTree.BBFMedianSplit)

Parameters:

data - the data

ShortKDTree

public ShortKDTree(short[][] data,
                   ShortKDTree.SplitChooser split)

Construct with the given data and splitting strategy

Parameters:

data - the data

split - the splitting strategy

Method Detail

coordinateRangeSearch

public short[][] coordinateRangeSearch(short[] lowerExtreme,
                                       short[] upperExtreme)

Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes.

Parameters:

lowerExtreme - the lower extreme of the hyperrectangle

upperExtreme - the upper extreme of the hyperrectangle

Returns:

the points within the given bounds

indexRangeSearch

public int[] indexRangeSearch(short[] lowerExtreme,
                              short[] upperExtreme)

Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes.

Parameters:

lowerExtreme - the lower extreme of the hyperrectangle

upperExtreme - the upper extreme of the hyperrectangle

Returns:

the points within the given bounds

indexRadiusSearch

public int[] indexRadiusSearch(short[] centre,
                               short radius)

Search the tree for the indexes of all points contained within the hypersphere defined by the given centre and radius.

Parameters:

centre - the centre point

radius - the radius

Returns:

the points within the given bounds

radiusSearch

public void radiusSearch(short[] centre,
                         short radius,
                         gnu.trove.procedure.TIntObjectProcedure<short[]> proc)

Find all the points within the given radius of the given point. Internally this works by finding the points in the hyper-square encompassing the hyper-circle and then filtering. Each valid point that is found is reported to the given processor together with its index.

The search can be stopped early by returning false from the TIntObjectProcedure.execute(int, Object) method.

Parameters:

centre - the centre point

radius - the radius

proc - the process

rangeSearch

public void rangeSearch(short[] lowerExtreme,
                        short[] upperExtreme,
                        gnu.trove.procedure.TIntObjectProcedure<short[]> proc)

Search the tree for all points contained within the hyperrectangle defined by the given upper and lower extremes. Each valid point that is found is reported to the given processor together with its index in the original data.

The search can be stopped early by returning false from the TIntObjectProcedure.execute(int, Object) method.

Parameters:

lowerExtreme - the lower extreme of the hyperrectangle

upperExtreme - the upper extreme of the hyperrectangle

proc - the processor

nearestNeighbours

public List<IntFloatPair> nearestNeighbours(short[] qu,
                                            int n)

Nearest-neighbour search

Parameters:

qu - the query point

n - the number of neighbours to find

Returns:

the indices and distances

nearestNeighbour

public IntFloatPair nearestNeighbour(short[] qu)

Nearest-neighbour search

Parameters:

qu - the query point

Returns:

the indices and distances

coordinateRadiusSearch

public short[][] coordinateRadiusSearch(short[] centre,
                                        short radius)

Find all the points within the given radius of the given point. Internally this works by finding the points in the hyper-square encompassing the hyper-circle and then filtering.

Parameters:

centre - the centre point

radius - the radius

Returns:

the points

coordinateRadiusSearch

public void coordinateRadiusSearch(short[] centre,
                                   short radius,
                                   gnu.trove.procedure.TObjectFloatProcedure<short[]> proc)

Find all the points within the given radius of the given point. Internally this works by finding the points in the hyper-square encompassing the hyper-circle and then filtering. Each valid point that is found is reported to the given processor together with its distance from the centre.

The search can be stopped early by returning false from the TIntObjectProcedure.execute(int, Object) method.

Parameters:

centre - the centre point

radius - the radius

proc - the process

leafIndices

public List<int[]> leafIndices()

Find all the indices seperated by leaves

Returns:

all the leaves