java.lang.Object
- net.imglib2.neighborsearch.KNearestNeighborSearchOnKDTree<T>

All Implemented Interfaces:

EuclideanSpace, KNearestNeighborSearch<T>, NearestNeighborSearch<T>
```
public class KNearestNeighborSearchOnKDTree<T>
extends java.lang.Object
implements KNearestNeighborSearch<T>
```
Implementation of KNearestNeighborSearch search for kd-trees.

Field Summary

Fields
Modifier and Type	Field	Description
`protected KDTreeNode<T>[]`	`bestPoints`
`protected double[]`	`bestSquDistances`
`protected int`	`k`
`protected int`	`n`
`protected double[]`	`pos`
`protected KDTree<T>`	`tree`

Constructor Summary

Constructors
Constructor Description

KNearestNeighborSearchOnKDTree(KDTree<T> tree, int k)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KNearestNeighborSearchOnKDTree<T>`	`copy()`	Create a copy.
`double`	`getDistance()`	Access the Euclidean distance between the reference location as used for the last search and the nearest neighbor, ordered by square Euclidean distance.
`double`	`getDistance(int i)`	Access the Euclidean distance between the reference location as used for the last search and the i^th nearest neighbor, ordered by square Euclidean distance.
`int`	`getK()`	Get the of k nearest neighbor points used in this search
`RealLocalizable`	`getPosition()`	Access the position of the nearest neighbor, ordered by square Euclidean distance.
`RealLocalizable`	`getPosition(int i)`	Access the position of the i^th nearest neighbor, ordered by square Euclidean distance.
`Sampler<T>`	`getSampler()`	Access the data of the nearest neighbor.
`Sampler<T>`	`getSampler(int i)`	Access the data of the i^th nearest neighbor, ordered by square Euclidean distance.
`double`	`getSquareDistance()`	Access the square Euclidean distance between the reference location as used for the last search and the nearest neighbor, ordered by square Euclidean distance.
`double`	`getSquareDistance(int i)`	Access the square Euclidean distance between the reference location as used for the last search and the i^th nearest neighbor, ordered by square Euclidean distance.
`int`	`numDimensions()`	Gets the space's number of dimensions.
`void`	`search(RealLocalizable reference)`	Perform k-nearest-neighbor search for a reference coordinate.
`protected void`	`searchNode(KDTreeNode<T> current)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tree
```
protected KDTree<T> tree
```
  - n
```
protected final int n
```
  - pos
```
protected final double[] pos
```
  - k
```
protected final int k
```
  - bestPoints
```
protected KDTreeNode<T>[] bestPoints
```
  - bestSquDistances
```
protected double[] bestSquDistances
```
- Constructor Detail
  - KNearestNeighborSearchOnKDTree
```
public KNearestNeighborSearchOnKDTree(KDTree<T> tree,
                                      int k)
```
- Method Detail
  - numDimensions
```
public int numDimensions()
```
    Description copied from interface: EuclideanSpace
    
    Gets the space's number of dimensions.
    
    Specified by:
    
    numDimensions in interface EuclideanSpace
  - getK
```
public int getK()
```
    Description copied from interface: KNearestNeighborSearch
    
    Get the of k nearest neighbor points used in this search
    
    Specified by:
    
    getK in interface KNearestNeighborSearch<T>
    
    Returns:
    
    the number of nearest neighbor points k used for this search
  - search
```
public void search(RealLocalizable reference)
```
    Description copied from interface: KNearestNeighborSearch
    
    Perform k-nearest-neighbor search for a reference coordinate.
    
    Specified by:
    
    search in interface KNearestNeighborSearch<T>
    
    Specified by:
    
    search in interface NearestNeighborSearch<T>
  - searchNode
```
protected void searchNode(KDTreeNode<T> current)
```
  - getSampler
```
public Sampler<T> getSampler(int i)
```
    Description copied from interface: KNearestNeighborSearch
    
    Access the data of the i^th nearest neighbor, ordered by square Euclidean distance. Data is accessed through a Sampler that guarantees write access if the underlying data set is writable.
    
    Specified by:
    
    getSampler in interface KNearestNeighborSearch<T>
  - getPosition
```
public RealLocalizable getPosition(int i)
```
    Description copied from interface: KNearestNeighborSearch
    
    Access the position of the i^th nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getPosition in interface KNearestNeighborSearch<T>
  - getSquareDistance
```
public double getSquareDistance(int i)
```
    Description copied from interface: KNearestNeighborSearch
    
    Access the square Euclidean distance between the reference location as used for the last search and the i^th nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getSquareDistance in interface KNearestNeighborSearch<T>
  - getDistance
```
public double getDistance(int i)
```
    Description copied from interface: KNearestNeighborSearch
    
    Access the Euclidean distance between the reference location as used for the last search and the i^th nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getDistance in interface KNearestNeighborSearch<T>
  - getPosition
```
public RealLocalizable getPosition()
```
    Description copied from interface: NearestNeighborSearch
    
    Access the position of the nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getPosition in interface NearestNeighborSearch<T>
  - getSampler
```
public Sampler<T> getSampler()
```
    Description copied from interface: NearestNeighborSearch
    
    Access the data of the nearest neighbor. Data is accessed through a Sampler that guarantees write access if the underlying data set is writable.
    
    Specified by:
    
    getSampler in interface NearestNeighborSearch<T>
  - getSquareDistance
```
public double getSquareDistance()
```
    Description copied from interface: NearestNeighborSearch
    
    Access the square Euclidean distance between the reference location as used for the last search and the nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getSquareDistance in interface NearestNeighborSearch<T>
  - getDistance
```
public double getDistance()
```
    Description copied from interface: NearestNeighborSearch
    
    Access the Euclidean distance between the reference location as used for the last search and the nearest neighbor, ordered by square Euclidean distance.
    
    Specified by:
    
    getDistance in interface NearestNeighborSearch<T>
  - copy
```
public KNearestNeighborSearchOnKDTree<T> copy()
```
    Description copied from interface: KNearestNeighborSearch
    
    Create a copy.
    
    Specified by:
    
    copy in interface KNearestNeighborSearch<T>
    
    Specified by:
    
    copy in interface NearestNeighborSearch<T>

Class KNearestNeighborSearchOnKDTree<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tree

n

pos

k

bestPoints

bestSquDistances

Constructor Detail

KNearestNeighborSearchOnKDTree

Method Detail

numDimensions

getK

search

searchNode

getSampler

getPosition

getSquareDistance

getDistance

getPosition

getSampler

getSquareDistance

getDistance

copy