firecrown.models.cluster.mass_proxy
===================================

.. py:module:: firecrown.models.cluster.mass_proxy

.. autoapi-nested-parse::

   The mass richness kernel module.

   This module holds the classes that define the mass richness relations
   that can be included in the cluster abundance integrand.  These are
   implementations of Kernels.



Attributes
----------

.. autoapisummary::

   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_MU_P0
   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_MU_P1
   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_MU_P2
   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_SIGMA_P0
   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_SIGMA_P1
   firecrown.models.cluster.mass_proxy.MURATA_DEFAULT_SIGMA_P2


Classes
-------

.. autoapisummary::

   firecrown.models.cluster.mass_proxy.MassRichnessGaussian
   firecrown.models.cluster.mass_proxy.MurataBinned
   firecrown.models.cluster.mass_proxy.MurataUnbinned


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

.. py:class:: MassRichnessGaussian(parameter_prefix = None)

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

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.mass_proxy.MassRichnessGaussian
      :parts: 1


   The representation of mass richness relations that are of a gaussian form.


   .. py:method:: observed_value(p, mass, z, pivot_mass, log1p_pivot_redshift)
      :staticmethod:


      Return observed quantity corrected by redshift and mass.



   .. py:method:: get_proxy_mean(mass, z)
      :abstractmethod:


      Return observed quantity corrected by redshift and mass.



   .. py:method:: get_proxy_sigma(mass, z)
      :abstractmethod:


      Return observed scatter corrected by redshift and mass.



.. py:data:: MURATA_DEFAULT_MU_P0
   :value: 3.0


.. py:data:: MURATA_DEFAULT_MU_P1
   :value: 0.8


.. py:data:: MURATA_DEFAULT_MU_P2
   :value: -0.3


.. py:data:: MURATA_DEFAULT_SIGMA_P0
   :value: 0.3


.. py:data:: MURATA_DEFAULT_SIGMA_P1
   :value: 0.0


.. py:data:: MURATA_DEFAULT_SIGMA_P2
   :value: 0.0


.. py:class:: MurataBinned(pivot_mass, pivot_redshift)

   Bases: :py:obj:`MassRichnessGaussian`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.mass_proxy.MurataBinned
      :parts: 1


   The mass richness relation defined in Murata 19 for a binned data vector.


   .. py:attribute:: pivot_redshift


   .. py:attribute:: pivot_mass


   .. py:attribute:: log1p_pivot_redshift


   .. py:attribute:: mu_p0


   .. py:attribute:: mu_p1


   .. py:attribute:: mu_p2


   .. py:attribute:: sigma_p0


   .. py:attribute:: sigma_p1


   .. py:attribute:: sigma_p2


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

      Return observed quantity corrected by redshift and mass.



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

      Return observed scatter corrected by redshift and mass.



   .. py:method:: distribution(mass, z, mass_proxy_limits)

      Evaluates and returns the mass-richness contribution to the integrand.



.. py:class:: MurataUnbinned(pivot_mass, pivot_redshift)

   Bases: :py:obj:`MassRichnessGaussian`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.mass_proxy.MurataUnbinned
      :parts: 1


   The mass richness relation defined in Murata 19 for a unbinned data vector.


   .. py:attribute:: pivot_redshift


   .. py:attribute:: pivot_mass


   .. py:attribute:: log1p_pivot_redshift


   .. py:attribute:: mu_p0


   .. py:attribute:: mu_p1


   .. py:attribute:: mu_p2


   .. py:attribute:: sigma_p0


   .. py:attribute:: sigma_p1


   .. py:attribute:: sigma_p2


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

      Return observed quantity corrected by redshift and mass.



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

      Return observed scatter corrected by redshift and mass.



   .. py:method:: distribution(mass, z, mass_proxy)

      Evaluates and returns the mass-richness contribution to the integrand.