Moster13SmHm

class halotools.empirical_models.Moster13SmHm(**kwargs)[source] [edit on github]

Bases: halotools.empirical_models.PrimGalpropModel

Stellar-to-halo-mass relation based on Moster et al. (2013), arXiv:1205.5807.

Parameters:

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.

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.

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.

Methods Summary

mean_stellar_mass(**kwargs) Return the stellar mass of a central galaxy as a function of the input table.
retrieve_default_param_dict() Method returns a dictionary of all model parameters set to the values in Table 1 of Moster et al.

Methods Documentation

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.

redshift : float or array, optional

Redshift of the halo hosting the galaxy. Default is set in sim_defaults. If passing an array, must be of the same length as the prim_haloprop or table argument.

Returns:

mstar : array_like

Array containing stellar masses living in the input table.

Notes

The parameter values in Moster+13 were fit to data assuming h=0.704, but all halotools inputs are in h=1 units. Thus we will transform our input halo mass to h=0.704 units, evaluate using the moster parameters, and then transform back to h=1 units before returning the result.

retrieve_default_param_dict()[source] [edit on github]

Method returns a dictionary of all model parameters set to the values in Table 1 of Moster et al. (2013).

Returns:

d : dict

Dictionary containing parameter values.