yt.lagos.HaloList.nearest_neighbors_2D

HaloList.nearest_neighbors_2D(haloID, num_neighbors=7, search_radius=0.20000000000000001, proj_dim=0)

For a halo its nearest neighbors in 2D using the kd tree.

This will strip a dimension from consideration in the kD-tree, and then calculate all the nearest projected neighbors of a halo. Returns a list of the neighbors distances and ID with format [distance,haloID].

Parameters :

haloID : int

The halo to find neighbors for.

num_neighbors : int

How many neighbors to search for. Default = 7.

search_radius : float

How far away to look for neighbors in code units. Default = 0.2.

proj_dim : int

Which dimension (0, 1, or 2) to project the halos into 2D. Default = 0.

Examples

>>> neighbors = halos.nearest_neighbors_2D(0)

Previous topic

yt.lagos.HaloList

Next topic

yt.lagos.HaloList.nearest_neighbors_3D

This Page