Leauthaud11Cens

class halotools.empirical_models.Leauthaud11Cens(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 any central galaxy occupation that derives from a stellar-to-halo-mass relation.

Note

The Leauthaud11Cens model is part of the leauthaud11 prebuilt composite HOD-style model. For a tutorial on the leauthaud11 composite model, see Leauthaud et al. (2011) 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.

Examples

>>> cen_model = Leauthaud11Cens()
>>> cen_model = Leauthaud11Cens(threshold = 11.25)
>>> cen_model = Leauthaud11Cens(prim_haloprop_key = 'halo_m200b')

Methods Summary

get_published_parameters() Return the values of self.param_dict according to the SIG_MOD1 values of Table 5 of arXiv:1104.0928 for the lowest redshift bin.
mean_log_halo_mass(log_stellar_mass) Return the base-10 logarithm of the halo mass of a central galaxy as a function of the base-10 logarithm of the input stellar mass.
mean_occupation(**kwargs) Expected number of central galaxies in a halo.
mean_stellar_mass(**kwargs) Return the stellar mass of a central galaxy as a function of the input table.

Methods Documentation

get_published_parameters()[source] [edit on github]

Return the values of self.param_dict according to the SIG_MOD1 values of Table 5 of arXiv:1104.0928 for the lowest redshift bin.

mean_log_halo_mass(log_stellar_mass)[source] [edit on github]

Return the base-10 logarithm of the halo mass of a central galaxy as a function of the base-10 logarithm of the input stellar mass.

Parameters:

log_stellar_mass : array

Array of base-10 logarithm of stellar masses in h=1 solar mass units.

Returns:

log_halo_mass : array_like

Array containing 10-base logarithm of halo mass in h=1 solar mass units.

mean_occupation(**kwargs)[source] [edit on github]

Expected number of central galaxies in a halo. See Equation 8 of arXiv:1103.2077.

Parameters:

prim_haloprop : array, optional

Array of mass-like variable upon which occupation statistics are based. If prim_haloprop is not passed, then table keyword argument must be passed.

table : object, optional

Data table storing halo catalog. If table is not passed, then prim_haloprop keyword argument must be passed.

Returns:

mean_ncen : array

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

Notes

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

mean_stellar_mass(**kwargs)[source] [edit on github]

Return the stellar mass of a central galaxy as a function of the input table.

Parameters:

prim_haloprop : array, optional

Array of mass-like variable upon which occupation statistics are based. If prim_haloprop is not passed, then table keyword argument must be passed.

table : object, optional

Data table storing halo catalog. If table is not passed, then prim_haloprop keyword argument must be passed.

Returns:

mstar : array_like

Array containing stellar masses living in the input table.