tinker13_model_dictionary

halotools.empirical_models.tinker13_model_dictionary(threshold=10.5, **kwargs)[source] [edit on github]

Dictionary to build an HOD-style based on Tinker et al. (2013), arXiv:1308.2974.

See Tinker et al. (2013) Composite Model for a tutorial on this 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]

Examples

The simplest way to instantiate the tinker13 model is using the PrebuiltHodModelFactory class:

>>> from halotools.empirical_models import PrebuiltHodModelFactory
>>> model_instance = PrebuiltHodModelFactory('tinker13')

Alternatively, you can pass the returned values of tinker13_model_dictionary to HodModelFactory. The calling signature is slightly more complicated relative to, for example, leauthaud11_model_dictionary because tinker13_model_dictionary also returns a supplementary_dictionary specifying the model_feature_calling_sequence (see The model_feature_calling_sequence mechanism).

>>> model_dictionary, supplementary_dictionary = tinker13_model_dictionary()
>>> constructor_kwargs = model_dictionary
>>> for key in supplementary_dictionary: constructor_kwargs[key] = supplementary_dictionary[key]
>>> from halotools.empirical_models import HodModelFactory
>>> model_instance = HodModelFactory(**constructor_kwargs)

To load a model based on a different threshold and redshift:

>>> model_instance = PrebuiltHodModelFactory('tinker13', threshold = 11, redshift = 2)

Or, equivalently,

>>> model_dictionary, supplementary_dictionary = tinker13_model_dictionary(threshold = 11, redshift = 2)
>>> constructor_kwargs = model_dictionary
>>> for key in supplementary_dictionary: constructor_kwargs[key] = supplementary_dictionary[key]
>>> model_instance = HodModelFactory(**constructor_kwargs)

As with all instances of the PrebuiltHodModelFactory, you can populate a mock by passing the model a halo catalog:

>>> from halotools.sim_manager import FakeSim
>>> halocat = FakeSim(redshift = model_instance.redshift)
>>> model_instance.populate_mock(halocat)