Leauthaud11_SHMR_Model

class halotools.halo_occupation.Leauthaud11_SHMR_Model(parameter_dict=None, threshold=None)

Bases: halotools.halo_occupation.HOD_Model

Subclass of HOD_Model object, where functional forms for occupation statistics are taken from Leauthaud et al. 2011 arXiv:1103.2077

Parameters:

parameter_dict : dictionary, optional.

Contains values for the parameters specifying the model. Dictionary keys are ‘m1’,’ms0’,’beta’,’delta’,’gamma’,’siglogm’,’bcut’,’bsat’,’betacut’,’betasat’,’alphasat’.

Default values pertain to the best-fit values for the z2 redshift bin in leauthaud et al. 2012. Note these these default values assume h=0.72, M200b, and a Chabrier IMF.

threshold : float. Default value is default_stellar_mass_threshold Stellar Mass Threshold.

Notes

relation is current set to be Anatoly’s.

Attributes Summary

primary_halo_property_key

Model is based on .

Methods Summary

mean_concentration(logM, halo_type)	Concentration-mass relation of the model.
mean_ncen(logM, halo_type)	Expected number of central galaxies in a halo of mass logM.
mean_nsat(logM, halo_type)	Expected number of satellite galaxies in a halo of mass logM.
mh2ms(mh)	Converts Halo mass to Stellar mass by inverting SHMR :Parameters: mh : array_like array of stellar mass :Returns: ms : array_like array of halo masses corresponding to the input stellar masses.
mh2ms_funct(ms, mh)	Function for brentq
ms2mh(ms)	Converts Stellar mass to Mhalo using SHMR Input is stellar mass in log10 units Output is Mh in log units :Parameters: ms : array_like array of stellar mass :Returns: mh : array_like array of halo masses corresponding to the input stellar masses.
published_parameters([threshold])	Best-fit HOD parameters from Table 5 of Leauthaud et al.
require_correct_keys()	If a parameter dictionary is passed to the class upon instantiation, this method is used to enforce that the set of keys is in accord with the set of keys required by the model.

Attributes Documentation

primary_halo_property_key

Model is based on .

Methods Documentation

mean_concentration(logM, halo_type)

Concentration-mass relation of the model.

Parameters:

logM : array_like

array of of halos in catalog

halo_type : array

array of halo types. Entirely ignored in this model. Included as a passed variable purely for consistency between the way this function is called by different models.

Returns:

concentrations : array_like

Mean concentration of halos of the input mass, using anatoly_concentration model.

mean_ncen(logM, halo_type)

Expected number of central galaxies in a halo of mass logM. See Equation 8 of arXiv:1103.2077

Parameters:

logM : array

array of of halos in catalog

halo_type : array

array of halo types. Entirely ignored in this model. Included as a passed variable purely for consistency between the way this function is called by different models.

Returns:

mean_ncen : array

Notes

Mean number of central galaxies in a host halo of the specified mass.

mean_nsat(logM, halo_type)

Expected number of satellite galaxies in a halo of mass logM. See Equation 12 of arXiv:1103.2077

Parameters:

logM : array

array of of halos in catalog

halo_type : array

array of halo types. Entirely ignored in this model. Included as a passed variable purely for consistency between the way this function is called by different models.

Returns:

mean_nsat : float or array

Mean number of satellite galaxies in a host halo of the specified mass.

mh2ms(mh)

Converts Halo mass to Stellar mass by inverting SHMR

Parameters:

mh : array_like

array of stellar mass

Returns:

ms : array_like

array of halo masses corresponding to the input stellar masses.

mh2ms_funct(ms, mh)

Function for brentq Returns SHMR-Mh

ms2mh(ms)

Converts Stellar mass to Mhalo using SHMR Input is stellar mass in log10 units Output is Mh in log units

Parameters:

ms : array_like

array of stellar mass

Returns:

mh : array_like

array of halo masses corresponding to the input stellar masses.

published_parameters(threshold=None)

Best-fit HOD parameters from Table 5 of Leauthaud et al. 2012. For the second redshift bin.

Parameters:

threshold : float

Any stellar mass threshold

Returns:

parameter_dict : dict

Dictionary of model parameters whose values have been set to agree with the values taken from Table 5 of Leauthaud et al. 2012.

require_correct_keys()

If a parameter dictionary is passed to the class upon instantiation, this method is used to enforce that the set of keys is in accord with the set of keys required by the model.