firecrown.models.cluster.abundance

The module responsible for building the cluster abundance calculation.

The galaxy cluster abundance integral is a combination of both theoretical and phenomenological predictions. This module contains the classes and functions that produce those predictions.

Classes

ClusterAbundance

The class that calculates the predicted number counts of galaxy clusters.

Module Contents

class firecrown.models.cluster.abundance.ClusterAbundance(mass_interval, z_interval, halo_mass_function)[source]

Bases: firecrown.updatable.Updatable

Inheritance diagram of firecrown.models.cluster.abundance.ClusterAbundance

The class that calculates the predicted number counts of galaxy clusters.

The abundance is a function of a specific cosmology, a mass and redshift range, an area on the sky, a halo mass function, as well as multiple kernels, where each kernel represents a different distribution involved in the final cluster abundance integrand.

Parameters:
  • mass_interval (tuple[float, float])

  • z_interval (tuple[float, float])

  • halo_mass_function (pyccl.halos.MassFunc)

property cosmo: pyccl.cosmology.Cosmology | None

The cosmology used to predict the cluster number count.

Return type:

pyccl.cosmology.Cosmology | None

kernels: firecrown.updatable.UpdatableCollection
halo_mass_function
min_mass
max_mass
min_z
max_z
update_ingredients(cosmo)[source]

Update the cluster abundance calculation with a new cosmology.

Parameters:

cosmo (pyccl.cosmology.Cosmology)

Return type:

None

comoving_volume(z, sky_area=0)[source]

The differential comoving volume given area sky_area at redshift z.

Parameters:
  • sky_area (float) – The area of the survey on the sky in square degrees.

  • z (numpy.typing.NDArray[numpy.float64])

Return type:

numpy.typing.NDArray[numpy.float64]

mass_function(mass, z)[source]

The mass function at z and mass.

Parameters:
  • mass (numpy.typing.NDArray[numpy.float64])

  • z (numpy.typing.NDArray[numpy.float64])

Return type:

numpy.typing.NDArray[numpy.float64]