oceanspy.OceanDataset.create_tree

OceanDataset.create_tree(grid_pos='C')

Create a scipy.spatial.cKDTree for quick nearest-neighbor lookup.

Parameters:

grid_pos: str

Grid position. Options: {‘C’, ‘G’, ‘U’, ‘V’}

Returns:

tree: scipy.spatial.cKDTree

Return a xKDTree object that can be used to query a point.

References

cKDTree: https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.cKDTree.html

Grid: https://mitgcm.readthedocs.io/en/latest/algorithm/horiz-grid.html