firecrown.models.cluster.binning
================================

.. py:module:: firecrown.models.cluster.binning

.. autoapi-nested-parse::

   Classes for defining bins used in the cluster likelihood.

   This module contains the classes that define the bins and binning
   used for cluster theoretical predictions within Firecrown.



Classes
-------

.. autoapisummary::

   firecrown.models.cluster.binning.NDimensionalBin
   firecrown.models.cluster.binning.SaccBin
   firecrown.models.cluster.binning.TupleBin


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

.. py:class:: NDimensionalBin

   Bases: :py:obj:`abc.ABC`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.binning.NDimensionalBin
      :parts: 1


   Class which defines the interface for an N dimensional bin.


   .. py:property:: z_edges
      :type: tuple[float, float]

      :abstractmethod:


      Redshift bin edges.



   .. py:property:: mass_proxy_edges
      :type: tuple[float, float]

      :abstractmethod:


      Mass proxy bin edges.



   .. py:property:: radius_edges
      :type: tuple[float, float]

      :abstractmethod:


      Radius bin edges.



   .. py:property:: radius_center
      :type: float

      :abstractmethod:


      Radius bin edges.



   .. py:method:: __str__()

      Returns a string representation of the bin edges.



.. py:class:: SaccBin(coordinate_bins)

   Bases: :py:obj:`NDimensionalBin`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.binning.SaccBin
      :parts: 1


   An implementation of the N dimensional bin using sacc tracers.


   .. py:attribute:: coordinate_bins


   .. py:attribute:: dimension


   .. py:property:: z_edges
      :type: tuple[float, float]


      Redshift bin edges.



   .. py:property:: mass_proxy_edges
      :type: tuple[float, float]


      Mass proxy bin edges.



   .. py:property:: radius_edges
      :type: tuple[float, float]


      Radius bin edges.



   .. py:property:: radius_center
      :type: float


      Radius bin center.



   .. py:method:: __eq__(other)

      Two bins are equal if they have the same lower/upper bound.



   .. py:method:: __hash__()

      One bin's hash is determined by the dimension and lower/upper bound.



.. py:class:: TupleBin(coordinate_bins)

   Bases: :py:obj:`NDimensionalBin`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.binning.TupleBin
      :parts: 1


   An implementation of the N dimensional bin using sacc tracers.


   .. py:attribute:: coordinate_bins


   .. py:property:: dimension
      :type: int


      Number of dimensions for this bin.



   .. py:property:: mass_proxy_edges
      :type: tuple[float, float]


      Mass proxy bin edges.



   .. py:property:: z_edges
      :type: tuple[float, float]


      Redshift bin edges.



   .. py:property:: radius_edges
      :type: tuple[float, float]


      Radius bin edges.



   .. py:property:: radius_center
      :type: float


      Radius bin center.



   .. py:method:: __eq__(other)

      Two bins are equal if they have the same lower/upper bound.



   .. py:method:: __hash__()

      One bin's hash is determined by the dimension and lower/upper bound.