skypy.halos.mass.colossus_mass_sampler

skypy.halos.mass.colossus_mass_sampler(redshift, model, mdef, m_min, m_max, cosmology, sigma8, ns, size=None, resolution=1000)

Colossus halo mass sampler.

This function generate a sample of halos from a mass function which is available in COLOSSUS [1].

Parameters:

redshiftfloat

The redshift values at which to sample the halo mass.

modelstring

Mass function model which is available in colossus.

mdefstr

Halo mass definition for spherical overdensities used by colossus.

m_min, m_maxfloat

Lower and upper bounds for halo mass in units of Solar mass, Msun.

cosmologyastropy.cosmology.Cosmology

Astropy cosmology object

sigma8float

Cosmology parameter, amplitude of the (linear) power spectrum on the scale of 8 Mpc/h.

nsfloat

Cosmology parameter, spectral index of scalar perturbation power spectrum.

sizeint, optional

Number of halos to sample. If size is None (default), a single value is returned.

resolutionint, optional

Resolution of the inverse transform sampling spline. Default is 1000.

Returns:

sample(size,) array_like

Samples drawn from the mass function, in units of solar masses.

References

[1]

Diemer B., 2018, ApJS, 239, 35