firecrown.likelihood.binned_cluster_number_counts_deltasigma
============================================================

.. py:module:: firecrown.likelihood.binned_cluster_number_counts_deltasigma

.. autoapi-nested-parse::

   This module holds classes needed to predict the binned cluster shear profile.

   The binned cluster shear profile statistic predicts the excess density
   surface mass of clusters within a single redshift and mass bin.



Classes
-------

.. autoapisummary::

   firecrown.likelihood.binned_cluster_number_counts_deltasigma.BinnedClusterDeltaSigma


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

.. py:class:: BinnedClusterDeltaSigma(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_deltasigma.BinnedClusterDeltaSigma
      :parts: 1


   The Binned Cluster Delta Sigma statistic.

   This class will make a prediction for the deltasigma of clusters in a z, mass,
   radial bin and compare that prediction to the data provided in the sacc file.


   .. 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_properties)

      Computes the mean deltasigma 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 deltasigma of the clusters in each bin.