firecrown.likelihood.cmb
========================

.. py:module:: firecrown.likelihood.cmb

.. autoapi-nested-parse::

   CMB source class and factory. Currently only supports CMB lensing convergence.



Classes
-------

.. autoapisummary::

   firecrown.likelihood.cmb.CMBConvergenceArgs
   firecrown.likelihood.cmb.CMBConvergence
   firecrown.likelihood.cmb.CMBConvergenceFactory


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

.. py:class:: CMBConvergenceArgs

   Class for CMB convergence tracer arguments.


   .. py:attribute:: scale
      :type:  float
      :value: 1.0



   .. py:attribute:: field
      :type:  str
      :value: 'delta_matter'



   .. py:attribute:: z_source
      :type:  float
      :value: 1100.0



.. py:class:: CMBConvergence(*, sacc_tracer, scale = 1.0, z_source = 1100.0)

   Bases: :py:obj:`firecrown.likelihood.source.Source`

   .. autoapi-inheritance-diagram:: firecrown.likelihood.cmb.CMBConvergence
      :parts: 1


   Source class for CMB convergence lensing.


   .. py:attribute:: sacc_tracer


   .. py:attribute:: scale
      :value: 1.0



   .. py:attribute:: z_source
      :value: 1100.0



   .. py:attribute:: current_tracer_args
      :type:  None | CMBConvergenceArgs
      :value: None



   .. py:attribute:: tracer_args
      :type:  CMBConvergenceArgs


   .. py:method:: read_systematics(sacc_data)

      Read the systematics for this source from the SACC file.

      For CMB sources, there are no systematics to read.



   .. py:method:: get_scale()

      Return the scale for this source.



   .. py:method:: create_tracers(tools)

      Create the CMB convergence tracer.



   .. py:method:: create_ready(sacc_tracer, scale = 1.0, z_source = 1100.0)
      :classmethod:


      Create a CMBConvergence object ready for use.



.. py:class:: CMBConvergenceFactory(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`

   .. autoapi-inheritance-diagram:: firecrown.likelihood.cmb.CMBConvergenceFactory
      :parts: 1


   Factory class for CMBConvergence objects.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].



   .. py:attribute:: type_source
      :type:  firecrown.metadata_types.TypeSource


   .. py:attribute:: z_source
      :type:  float
      :value: 1100.0



   .. py:attribute:: scale
      :type:  float
      :value: 1.0



   .. py:method:: model_post_init(_, /)

      Initialize the CMBConvergenceFactory.



   .. py:method:: create(inferred_galaxy_zdist)

      Create a CMBConvergence object with the given inferred galaxy z distribution.

      :param inferred_galaxy_zdist: the inferred galaxy redshift distribution
      :return: a fully initialized CMBConvergence object



   .. py:method:: create_from_metadata_only(sacc_tracer)

      Create a CMBConvergence object from metadata only.

      :param sacc_tracer: the name of the tracer
      :return: a fully initialized CMBConvergence object