PrimGalpropModel

class halotools.empirical_models.PrimGalpropModel(galprop_name, prim_haloprop_key='halo_mpeak', scatter_model=<class 'halotools.empirical_models.component_model_templates.scatter_models.LogNormalScatterModel'>, **kwargs)[source] [edit on github]

Bases: object

Abstract container class for models connecting table to their primary galaxy property, e.g., stellar mass or luminosity.

Parameters:

galprop_name : string

Name of the galaxy property being assigned. Most likely, this is either stellar mass or luminosity, but any name is permissible, e.g. baryonic_mass. Whatever you choose, this will be name of the column assigned to your mock galaxy catalog, and your model will have methods with the following two names deriving from your choice: mean_galprop_name, mc_galprop_name.

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.

redshift : float, optional

Redshift of the stellar-to-halo-mass relation. Default is 0.

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_scatter(**kwargs) Use the param_dict of PrimGalpropModel to update the param_dict of the scatter model, and then call the mean_scatter method of the scatter model.
scatter_realization(**kwargs) Use the param_dict of PrimGalpropModel to update the param_dict of the scatter model, and then call the scatter_realization method of the scatter model.

Methods Documentation

mean_scatter(**kwargs)[source] [edit on github]

Use the param_dict of PrimGalpropModel to update the param_dict of the scatter model, and then call the mean_scatter method of the scatter model.

scatter_realization(**kwargs)[source] [edit on github]

Use the param_dict of PrimGalpropModel to update the param_dict of the scatter model, and then call the scatter_realization method of the scatter model.