uxarray.Grid.get_ball_tree

uxarray.Grid.get_ball_tree#

Grid.get_ball_tree(coordinates='face centers', coordinate_system='spherical', distance_metric='haversine', reconstruct=False)#

Get the BallTree data structure of this Grid that allows for nearest neighbor queries (k nearest or within some radius) on either the (node_x, node_y, node_z) and (node_lon, node_lat), edge (edge_x, edge_y, edge_z) and (edge_lon, edge_lat), or center (face_x, face_y, face_z) and (face_lon, ` face_lat`) nodes.

Parameters:

  • coordinates (str, default="face centers") – Selects which tree to query, with “nodes” selecting the Corner Nodes, “edge centers” selecting the Edge Centers of each edge, and “face centers” selecting the Face Centers of each face

  • coordinate_system (str, default="cartesian") – Selects which coordinate type to use to create the tree, “cartesian” selecting cartesian coordinates, and “spherical” selecting spherical coordinates.

  • distance_metric (str, default="haversine") – Distance metric used to construct the BallTree, options include: ‘euclidean’, ‘l2’, ‘minkowski’, ‘p’,’manhattan’, ‘cityblock’, ‘l1’, ‘chebyshev’, ‘infinity’, ‘seuclidean’, ‘mahalanobis’, ‘hamming’, ‘canberra’, ‘braycurtis’, ‘jaccard’, ‘dice’, ‘rogerstanimoto’, ‘russellrao’, ‘sokalmichener’, ‘sokalsneath’, ‘haversine’

  • reconstruct (bool, default=False) – If true, reconstructs the tree

Returns:

self._ball_tree – BallTree instance

Return type:

grid.Neighbors.BallTree

Contents