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

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

.. autoapi-nested-parse::

   Module that contains the cluster model classes.



Classes
-------

.. autoapisummary::

   firecrown.models.cluster.AbundanceData
   firecrown.models.cluster.NDimensionalBin
   firecrown.models.cluster.SaccBin
   firecrown.models.cluster.TupleBin
   firecrown.models.cluster.ClusterData
   firecrown.models.cluster.ShearData


Package Contents
----------------

.. py:class:: AbundanceData(sacc_data)

   Bases: :py:obj:`firecrown.models.cluster._cluster_data.ClusterData`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.AbundanceData
      :parts: 1


   The class used to wrap a sacc file and return the cluster abundance data.

   The sacc file is a complicated set of tracers (bins) and surveys.  This class
   manipulates that data and returns only the data relevant for the cluster
   number count statistic.  The data in this class is specific to a single
   survey name.


   .. py:method:: get_observed_data_and_indices_by_survey(survey_nm, properties)

      Returns the observed data for the specified survey and properties.

      For example if the caller has enabled COUNTS then the observed cluster counts
      within each N dimensional bin will be returned.



   .. py:method:: get_bin_edges(survey_nm, properties)

      Returns the limits for all z, mass bins for the requested data type.



.. py:class:: NDimensionalBin

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

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.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.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.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.



.. py:class:: ClusterData(sacc_data)

   The class used to wrap a sacc file and return the cluster abundance data.

   The sacc file is a complicated set of tracers (bins) and surveys.  This class
   manipulates that data and returns only the data relevant for the cluster
   number count statistic.  The data in this class is specific to a single
   survey name.


   .. py:attribute:: sacc_data


   .. py:method:: get_survey_tracer(survey_nm)

      Returns the SurveyTracer for the specified survey name.



   .. py:method:: get_observed_data_and_indices_by_survey(survey_nm, properties)
      :abstractmethod:


      Returns the observed data for the specified survey and properties.

      For example if the caller has enabled COUNTS then the observed cluster counts
      within each N dimensional bin will be returned.



   .. py:method:: get_bin_edges(survey_nm, properties)
      :abstractmethod:


      Returns the limits for all z, mass bins for the requested data type.



.. py:class:: ShearData(sacc_data)

   Bases: :py:obj:`firecrown.models.cluster._cluster_data.ClusterData`

   .. autoapi-inheritance-diagram:: firecrown.models.cluster.ShearData
      :parts: 1


   The class used to wrap a sacc file and return the cluster deltasigma data.

   The sacc file is a complicated set of tracers (bins) and surveys.  This class
   manipulates that data and returns only the data relevant for the cluster
   number count statistic.  The data in this class is specific to a single
   survey name.


   .. py:method:: get_observed_data_and_indices_by_survey(survey_nm, properties)

      Returns the observed data for the specified survey and properties.

      For example if the caller has enabled DELTASIGMA then the observed
      cluster profile within each N dimensional bin will be returned.



   .. py:method:: get_bin_edges(survey_nm, properties)

      Returns the limits for all z, mass bins for the shear data type.