get_halo_boundary_key

halotools.empirical_models.get_halo_boundary_key(mdef)[source] [edit on github]

For the input mass definition, return the string used to access halo table column storing the halo radius.

For example, the function will return halo_rvir if passed the string vir, and will return halo_r200m if passed 200m, each of which correspond to the Halotools convention for the column storing the distance between the host halo center and host halo boundary in CachedHaloCatalog data tables.

Parameters:

mdef: str

String specifying the halo mass definition, e.g., ‘vir’ or ‘200m’.

Returns:

radius_key : str