ZuMandelbaum15SmHm¶
- class halotools.empirical_models.ZuMandelbaum15SmHm(prim_haloprop_key='halo_m200m', **kwargs)[source]¶
Bases:
PrimGalpropModel
Stellar-to-halo-mass relation based on Zu and Mandelbaum 2015.
Note
The
ZuMandelbaum15SmHm
model is part of thezu_mandelbaum15
prebuilt composite HOD-style model. For a tutorial on thezu_mandelbaum15
composite model, see Zu & Mandelbaum et al. (2015) Composite Model.- Parameters:
- prim_haloprop_keystring, optional
String giving the column name of the primary halo property governing stellar mass.
Notes
Note that the best-fit parameters of this model are based on the
halo_m200m
halo mass definition. Using alternative choices of mass definition will require altering the model parameters in order to mock up the same model published in Zu & Mandelbaum 2015. The Colossus python package written by Benedikt Diemer can be used to convert between different halo mass definitions. This may be useful if you wish to use an existing halo catalog for which the halo mass definition you need is unavailable.Methods Summary
mean_halo_mass
(stellar_mass, **kwargs)Return the halo mass of a central galaxy as a function of the stellar mass.
mean_scatter
(**kwargs)Use the
param_dict
ofPrimGalpropModel
to update theparam_dict
of the scatter model, and then call themean_scatter
method of the scatter model.mean_stellar_mass
(**kwargs)Return the stellar mass of a central galaxy as a function of the input table.
scatter_ln_mstar
(halo_mass)Scatter in \({\rm ln M}_{\ast}\) as a function of halo mass.
scatter_realization
(**kwargs)Monte Carlo realization of stellar mass stochasticity
Methods Documentation
- mean_halo_mass(stellar_mass, **kwargs)[source]¶
Return the halo mass of a central galaxy as a function of the stellar mass.
- Parameters:
- stellar_massarray
Array of stellar masses in h=1 solar mass units.
- Returns:
- halo_massarray_like
Array of halo mass in h=1 solar mass units.
Examples
>>> from halotools.empirical_models import ZuMandelbaum15SmHm >>> model = ZuMandelbaum15SmHm() >>> halo_mass = model.mean_halo_mass(10**11)
- mean_scatter(**kwargs)[source]¶
Use the
param_dict
ofPrimGalpropModel
to update theparam_dict
of the scatter model, and then call themean_scatter
method of the scatter model.
- mean_stellar_mass(**kwargs)[source]¶
Return the stellar mass of a central galaxy as a function of the input table.
- Parameters:
- prim_haloproparray, optional
Array of mass-like variable upon which occupation statistics are based. If
prim_haloprop
is not passed, thentable
keyword argument must be passed.- tableobject, optional
Data table storing halo catalog. If
table
is not passed, thenprim_haloprop
keyword argument must be passed.
- Returns:
- stellar_massarray_like
Array containing stellar masses living in the input table, in solar mass units assuming h = 1.
Examples
>>> from halotools.empirical_models import ZuMandelbaum15SmHm >>> model = ZuMandelbaum15SmHm() >>> stellar_mass = model.mean_stellar_mass(prim_haloprop=10**12)
- scatter_ln_mstar(halo_mass)[source]¶
Scatter in \({\rm ln M}_{\ast}\) as a function of halo mass.
- Parameters:
- halo_massarray_like
Halo mass in units of Msun with h=1.
- Returns:
- scatterarray_like
Examples
>>> from halotools.empirical_models import ZuMandelbaum15SmHm >>> model = ZuMandelbaum15SmHm() >>> sigma = model.scatter_ln_mstar(1e12)