Behroozi2010Relation

class cosmo_utils.mock_catalogues.shmr_funcs.Behroozi2010Relation(**kwargs)

Bases: object

Class used to define the stellar-halo mass relation of central galaxies as a function of halo mass.

Parameters:

input_h : {int, float} optional

Value of the Hubble constant in limits of between \([0, 1]\). This variable acts as the input h of variables, and it is set to 1 by default.

out_h : {int, float} optional

Value of the Hubble constant in limits of between \([0, 1]\). This variable acts as the output h of variables, and it is set to 1 by default.

Methods Summary

compute_example([log_mstar_min, …])	Computes the Behroozi et al.(2010) relation for central galaxies..
mean_log_halo_mass(log_mstar[, z])	Returns the halo mass of a central galaxy as a function of its stellar mass.

Methods Documentation

compute_example(log_mstar_min=8, log_mstar_max=12, mstep=500, return_pd=True)

Computes the Behroozi et al. (2010) relation for central galaxies.

Parameters:

log_mstar_min : {float, int}, optional

Logarithmic 10-base minimum stellar mass. This variable is set to 10 by default.

log_mstar_max : {float, int}, optional

Logarithmic 10-base maximum stellar mass. This variable is set to 15 by default.

mstep : {float, int} optional

Number of elements in the output arrays of halo masses and stellar masses. This variable is set to 100 by default.

return_pd : bool, optional

If True, the function returns a pandas.DataFrame with the logarithmic 10-base halo masses and stellar masses of central galaxies in the units of self.out_h. This variable is set to True by default.

Returns:

mass_obj : {dict, pandas.DataFrame}

Dictionary containing arrays or floats of the logarithmic 10-base halo mass and stellar masses of central galaxies in units of self.out_h. If return_pd == True, this function returns a pandas.DataFrame instead.

mean_log_halo_mass(log_mstar, z=0)

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

Parameters:

log_mstar : {float, numpy.ndarray, list}

Logarithmic 10-base stellar mass array of the galaxies.

z : {float, int}, optional

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

Returns:

mass_dict : dict

Dictionary with the logarithmic 10-base stellar mass and halo mass arrays in the same units as self.out_h.