behroozi10_model_dictionary

halotools.empirical_models.behroozi10_model_dictionary(redshift=0.0, **kwargs)[source] [edit on github]

Dictionary that can be passed to the SubhaloModelFactory to build a subhalo-based composite model using the stellar-to-halo-mass relation published in Behroozi et al. (2010), arXiv:1205.5807.

For a tutorial on this composite model, see Behroozi et al. (2010) Composite Model.

Parameters:

redshift : float, optional

Redshift of the stellar-to-halo-mass relation of the model. Must be consistent with the redshift of the halo catalog you populate. Default value is set in the sim_defaults by the default_redshift variable.

prim_haloprop_key : string, optional

String giving the column name of the primary halo property governing stellar mass. Default is set in the model_defaults module by the default_smhm_haloprop variable.

scatter_model : object, optional

Class governing stochasticity of stellar mass. Default scatter is log-normal, implemented by the LogNormalScatterModel class.

scatter_abscissa : array_like, optional

Array of values giving the abscissa at which the level of scatter will be specified by the input ordinates. Default behavior will result in constant scatter at a level set in the model_defaults module by the default_smhm_scatter variable.

scatter_ordinates : array_like, optional

Array of values defining the level of scatter at the input abscissa. Default behavior will result in constant scatter at a level set in the model_defaults module by the default_smhm_scatter variable.

Examples

Calling the behroozi10_model_dictionary with no arguments retrieves a python dictionary that can be passed to the SubhaloModelFactory to build the behroozi10 composite model with default settings:

>>> from halotools.empirical_models import SubhaloModelFactory
>>> model_dictionary = behroozi10_model_dictionary()
>>> model_instance = SubhaloModelFactory(**model_dictionary)

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)