firecrown.models.cluster.abundance
==================================

.. py:module:: firecrown.models.cluster.abundance

.. autoapi-nested-parse::

   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
-------

.. autoapisummary::

   firecrown.models.cluster.abundance.ClusterAbundance


Module Contents
---------------

.. py:class:: ClusterAbundance(mass_interval, z_interval, halo_mass_function)

   Bases: :py:obj:`firecrown.updatable.Updatable`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.abundance.ClusterAbundance
      :parts: 1


   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.


   .. py:property:: cosmo
      :type: pyccl.cosmology.Cosmology | None


      The cosmology used to predict the cluster number count.



   .. py:attribute:: kernels
      :type:  firecrown.updatable.UpdatableCollection


   .. py:attribute:: halo_mass_function


   .. py:attribute:: min_mass


   .. py:attribute:: max_mass


   .. py:attribute:: min_z


   .. py:attribute:: max_z


   .. py:method:: update_ingredients(cosmo)

      Update the cluster abundance calculation with a new cosmology.



   .. py:method:: comoving_volume(z, sky_area = 0)

      The differential comoving volume given area sky_area at redshift z.

      :param sky_area: The area of the survey on the sky in square degrees.



   .. py:method:: mass_function(mass, z)

      The mass function at z and mass.