Tinker13QuiescentSats

class halotools.empirical_models.Tinker13QuiescentSats(threshold=10.5, prim_haloprop_key='halo_mvir', redshift=0.0, **kwargs)[source] [edit on github]

Bases: halotools.empirical_models.OccupationComponent

HOD-style model for a central galaxy occupation that derives from two distinct active/quiescent stellar-to-halo-mass relations.

Note

The Tinker13QuiescentSats model is part of the tinker13 prebuilt composite HOD-style model. For a tutorial on the tinker13 composite model, see Tinker et al. (2013) Composite Model.

Parameters:

threshold : float, optional

Stellar mass threshold of the mock galaxy sample in h=1 solar mass units. Default value is specified in the model_defaults module.

prim_haloprop_key : string, optional

String giving the column name of the primary halo property governing the occupation statistics of gal_type galaxies. Default value is specified in the model_defaults module.

redshift : float, optional

Redshift of the stellar-to-halo-mass relation. Default is set in sim_defaults.

Methods Summary

mc_sfr_designation(table, **kwargs)
mean_occupation(**kwargs) Expected number of central galaxies in a halo of mass halo_mass.

Methods Documentation

mc_sfr_designation(table, **kwargs)[source] [edit on github]
mean_occupation(**kwargs)[source] [edit on github]

Expected number of central galaxies in a halo of mass halo_mass. See Equation 12-14 of arXiv:1103.2077.

Parameters:

prim_haloprop : array, optional

array of masses of table in the catalog

table : object, optional

Data table storing halo catalog.

Returns:

mean_nsat : array

Mean number of central galaxies in the halo of the input mass.

Notes

Assumes constant scatter in the stellar-to-halo-mass relation.

Examples

>>> sat_model = Tinker13QuiescentSats()
>>> mean_nsat = sat_model.mean_occupation(prim_haloprop = 1.e13)