firecrown.likelihood.binned_cluster_number_counts
=================================================

.. py:module:: firecrown.likelihood.binned_cluster_number_counts

.. autoapi-nested-parse::

   Binned cluster number counts statistic support.



Classes
-------

.. autoapisummary::

   firecrown.likelihood.binned_cluster_number_counts.BinnedClusterNumberCounts


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

.. py:class:: BinnedClusterNumberCounts(cluster_properties, survey_name, cluster_recipe, systematics = None)

   Bases: :py:obj:`firecrown.likelihood.binned_cluster.BinnedCluster`

   .. autoapi-inheritance-diagram:: firecrown.likelihood.binned_cluster_number_counts.BinnedClusterNumberCounts
      :parts: 1


   A statistic representing the number of clusters in a z, mass bin.


   .. py:method:: read(sacc_data)

      Read the data for this statistic and mark it as ready for use.

      :param sacc_data: The data in the sacc format.



   .. py:method:: get_binned_cluster_property(tools, cluster_counts, cluster_properties)

      Computes the mean mass of clusters in each bin.

      Using the data from the sacc file, this function evaluates the likelihood for
      a single point of the parameter space, and returns the predicted mean mass of
      the clusters in each bin.

      :param cluster_counts: The number of clusters in each bin.
      :param cluster_properties: The cluster observables to use.



   .. py:method:: get_binned_cluster_counts(tools)

      Computes the number of clusters in each bin.

      Using the data from the sacc file, this function evaluates the likelihood for
      a single point of the parameter space, and returns the predicted number of
      clusters in each bin.

      :param tools: The modeling tools used to compute the statistic.
      :return: The number of clusters in each bin.