TITLE:: FluidKDTree
summary:: KD Tree on the server
categories:: FluidManipulation
related:: Classes/FluidDataSet

DESCRIPTION::
A server-side K-Dimensional tree for efficient neighbourhood searches of multi-dimensional data. See https://scikit-learn.org/stable/modules/neighbors.html#nearest-neighbor-algorithms for more on KD Trees

CLASSMETHODS::

INSTANCEMETHODS::

METHOD:: read
Set the object's state from a JSON file

ARGUMENT:: filename
The location of a JSON file on disk

ARGUMENT:: action
function to run when the data is loaded

METHOD:: kNearestDist
Get the distances of the K nearest neighbours to a point

ARGUMENT:: buffer
A LINK::Classes/Buffer:: containing a data point to match against. The number of frames in the buffer must match the dimensionality of the LINK::Classes/FluidDataSet:: the tree was fitted to.

ARGUMENT:: k
The number of neighbours to search

ARGUMENT:: action
A function that will run when the query returns, whose argument is an array of distances

returns:: nothing, but could return an array if you like

METHOD:: fit
Build the tree by scanning the points of a LINK::Classes/FluidDataSet::

ARGUMENT:: dataset
The LINK::Classes/FluidDataSet:: of interest. This can either be a data set object itself, or the name of one.

ARGUMENT:: action
A function to run when indexing is complete

METHOD:: write
Write the index of the tree to disk. Currently this will not overwrite extant files.

ARGUMENT:: filename
The path of a JSON file to write

ARGUMENT:: action
A function to run when writing is complete

METHOD:: kNearest
Returns the IDs of the CODE::k:: points nearest to the one passed

ARGUMENT:: buffer
A LINK::Classes/Buffer:: containing a data point to match against. The number of frames in the buffer must match the dimensionality of the LINK::Classes/FluidDataSet:: the tree was fitted to.

ARGUMENT:: k
The number of neighbours to return

ARGUMENT:: action
A function that will run when the query returns, whose argument is an array of point IDs from the tree's LINK::Classes/FluidDataSet::

returns:: Nothing, but could return an array of IDs if you like

METHOD:: cols
Get the dimensionality of the data that the tree is indexed against

ARGUMENT:: action
A function that runs when the query returns, whose argument is the dimensionality

EXAMPLES::

code::
(some example code)
::