firecrown.models.cluster.kernel
===============================

.. py:module:: firecrown.models.cluster.kernel

.. autoapi-nested-parse::

   The cluster kernel module.

   This module holds the classes that define the kernels that can be included
   in the cluster abundance integrand.



Attributes
----------

.. autoapisummary::

   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_AC_NC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_BC_NC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_AC_MC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_BC_MC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_AP_NC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_BP_NC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_AP_RC
   firecrown.models.cluster.kernel.REDMAPPER_DEFAULT_BP_RC


Classes
-------

.. autoapisummary::

   firecrown.models.cluster.kernel.KernelType
   firecrown.models.cluster.kernel.Completeness
   firecrown.models.cluster.kernel.Purity
   firecrown.models.cluster.kernel.TrueMass
   firecrown.models.cluster.kernel.SpectroscopicRedshift


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

.. py:data:: REDMAPPER_DEFAULT_AC_NC
   :value: 0.38


.. py:data:: REDMAPPER_DEFAULT_BC_NC
   :value: 1.2634


.. py:data:: REDMAPPER_DEFAULT_AC_MC
   :value: 13.31


.. py:data:: REDMAPPER_DEFAULT_BC_MC
   :value: 0.2025


.. py:class:: KernelType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.kernel.KernelType
      :parts: 1


   The kernels that can be included in the cluster abundance integrand.


   .. py:attribute:: MASS
      :value: 1



   .. py:attribute:: Z
      :value: 2



   .. py:attribute:: MASS_PROXY
      :value: 3



   .. py:attribute:: Z_PROXY
      :value: 4



   .. py:attribute:: COMPLETENESS
      :value: 5



   .. py:attribute:: PURITY
      :value: 6



.. py:class:: Completeness

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

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.kernel.Completeness
      :parts: 1


   The completeness kernel for the numcosmo simulated survey.

   This kernel will affect the integrand by accounting for the incompleteness
   of a cluster selection.


   .. py:attribute:: ac_nc


   .. py:attribute:: bc_nc


   .. py:attribute:: ac_mc


   .. py:attribute:: bc_mc


   .. py:method:: distribution(log_mass, z)

      Evaluates and returns the completeness contribution to the integrand.



.. py:data:: REDMAPPER_DEFAULT_AP_NC
   :value: 3.9193


.. py:data:: REDMAPPER_DEFAULT_BP_NC
   :value: -0.3323


.. py:data:: REDMAPPER_DEFAULT_AP_RC
   :value: 1.1839


.. py:data:: REDMAPPER_DEFAULT_BP_RC
   :value: -0.4077


.. py:class:: Purity

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

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.kernel.Purity
      :parts: 1


   The purity kernel for the numcosmo simulated survey.

   This kernel will affect the integrand by accounting for the purity
   of a cluster selection.


   .. py:attribute:: ap_nc


   .. py:attribute:: bp_nc


   .. py:attribute:: ap_rc


   .. py:attribute:: bp_rc


   .. py:method:: distribution(z, mass_proxy, mass_proxy_limits = None)

      Evaluates and returns the purity contribution to the integrand.



.. py:class:: TrueMass

   The true mass kernel.

   Assuming we measure the true mass, this will always be 1.


   .. py:method:: distribution()

      Evaluates and returns the mass distribution contribution to the integrand.

      We have set this to 1.0 (i.e. it does not affect the mass distribution)



.. py:class:: SpectroscopicRedshift

   The spec-z kernel.

   Assuming the spectroscopic redshift has no uncertainties, this is akin to
   multiplying by 1.


   .. py:method:: distribution()

      Evaluates and returns the z distribution contribution to the integrand.

      We have set this to 1.0 (i.e. it does not affect the redshift distribution)