Behroozi_relation

cosmo_utils.mock_catalogues.shmr_funcs.Behroozi_relation(log_mstar, z=0.0, return_mhalo_h0=False, mstar_h0=False)

Returns the halo mass of a central galaxy as a function of its stellar mass.

Parameters:

log_mstar : float ,`np.ndarray`, or array-like

Value or array of values of base-10 logarithm of stellar mass in h=1 solar mass units.

z : int, float, np.ndarray or array-like

Redshift of the halo hosting the galaxy. If passing an array, it must be of the same length as the input log_mstar.

return_mhalo_h0 : bool, optional

If True, the function returns the halo masses in h=1 units. This variable is set to False by default.

mstar_h0 : bool, optional

If True, the stellar mass in log_mstar is converted from h=1 units to h=0.7 units. This variable is set to False by default.

Returns:

log_halo_mass : float or np.ndarray

Array or float containing 10-base logarithm of halo mass in h=1 solar mass units.

Notes

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