uxarray.Grid.get_kd_tree#
- Grid.get_kd_tree(tree_type='nodes')#
Get the KDTree data structure of this Grid that allows for nearest neighbor queries (k nearest or within some radius) on either the nodes (
node_x
,node_y
,node_z
) or face centers (face_x
,face_y
,face_z
).- Parameters:
tree_type (str, default="nodes") – Selects which tree to query, with “nodes” selecting the Corner Nodes and “face centers” selecting the Face Centers of each face
- Returns:
self._kd_tree – KDTree instance
- Return type:
grid.Neighbors.KDTree