get_halo_mass_key¶
-
halotools.empirical_models.
get_halo_mass_key
(mdef)[source] [edit on github]¶ For the input mass definition, return the string used to access halo table column storing the halo mass.
For example, the function will return
halo_mvir
if passed the stringvir
, and will returnhalo_m200m
if passed200m
, each of which correspond to the Halotools convention for the column storing the halo mass inCachedHaloCatalog
data tables.Parameters: mdef: str
String specifying the halo mass definition, e.g., ‘vir’ or ‘200m’.
Returns: mass_key : str