Moster13SmHm¶
- class halotools.empirical_models.Moster13SmHm(**kwargs)[source]¶
Bases:
PrimGalpropModel
Stellar-to-halo-mass relation based on Moster et al. (2013), arXiv:1205.5807.
- Parameters:
- prim_haloprop_keystring, optional
String giving the column name of the primary halo property governing stellar mass. Default is set in the
model_defaults
module.- scatter_modelobject, optional
Class governing stochasticity of stellar mass. Default scatter is log-normal, implemented by the
LogNormalScatterModel
class.- scatter_abscissaarray_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_ordinatesarray_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.
Method returns a dictionary of all model parameters set to the values in Table 1 of Moster et al. (2013).
Methods Documentation
- mean_stellar_mass(**kwargs)[source]¶
Return the stellar mass of a central galaxy as a function of the input table.
- Parameters:
- prim_haloproparray, optional
Array of mass-like variable upon which occupation statistics are based. If
prim_haloprop
is not passed, thentable
keyword argument must be passed.- tableobject, optional
Data table storing halo catalog. If
table
is not passed, thenprim_haloprop
keyword argument must be passed.- redshiftfloat 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 theprim_haloprop
ortable
argument.
- Returns:
- mstararray_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.