Tinker13Cens

class halotools.empirical_models.Tinker13Cens(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 Tinker13Cens 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.

quiescent_fraction_abscissa : array, optional

Values of the primary halo property at which the quiescent fraction is specified. Default is [10**12, 10**13.5, 10**15].

quiescent_fraction_ordinates : array, optional

Values of the quiescent fraction when evaluated at the input abscissa. Default is [0.25, 0.7, 0.95]

Methods Summary

mc_sfr_designation([seed])
mean_log_halo_mass_active(log_stellar_mass)
mean_log_halo_mass_quiescent(log_stellar_mass)
mean_occupation(**kwargs)
mean_occupation_active(**kwargs)
mean_occupation_quiescent(**kwargs)
mean_quiescent_fraction(**kwargs)
mean_stellar_mass_active(**kwargs)
mean_stellar_mass_quiescent(**kwargs)

Methods Documentation

mc_sfr_designation(seed=None, **kwargs)[source] [edit on github]
mean_log_halo_mass_active(log_stellar_mass)[source] [edit on github]
mean_log_halo_mass_quiescent(log_stellar_mass)[source] [edit on github]
mean_occupation(**kwargs)[source] [edit on github]
mean_occupation_active(**kwargs)[source] [edit on github]
mean_occupation_quiescent(**kwargs)[source] [edit on github]
mean_quiescent_fraction(**kwargs)[source] [edit on github]
mean_stellar_mass_active(**kwargs)[source] [edit on github]
mean_stellar_mass_quiescent(**kwargs)[source] [edit on github]