firecrown.likelihood.cmb

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

Classes

CMBConvergenceArgs

Class for CMB convergence tracer arguments.

CMBConvergence

Source class for CMB convergence lensing.

CMBConvergenceFactory

Factory class for CMBConvergence objects.

Module Contents

class firecrown.likelihood.cmb.CMBConvergenceArgs[source]

Class for CMB convergence tracer arguments.

scale: float = 1.0
field: str = 'delta_matter'
z_source: float = 1100.0
class firecrown.likelihood.cmb.CMBConvergence(*, sacc_tracer, scale=1.0, z_source=1100.0)[source]

Bases: firecrown.likelihood.source.Source

Inheritance diagram of firecrown.likelihood.cmb.CMBConvergence

Source class for CMB convergence lensing.

Parameters:
  • sacc_tracer (str)

  • scale (float)

  • z_source (float)

sacc_tracer
scale = 1.0
z_source = 1100.0
current_tracer_args: None | CMBConvergenceArgs = None
tracer_args: CMBConvergenceArgs
read_systematics(sacc_data)[source]

Read the systematics for this source from the SACC file.

For CMB sources, there are no systematics to read.

Parameters:

sacc_data (sacc.Sacc)

Return type:

None

get_scale()[source]

Return the scale for this source.

Return type:

float

create_tracers(tools)[source]

Create the CMB convergence tracer.

Parameters:

tools (firecrown.modeling_tools.ModelingTools)

classmethod create_ready(sacc_tracer, scale=1.0, z_source=1100.0)[source]

Create a CMBConvergence object ready for use.

Parameters:
  • sacc_tracer (str)

  • scale (float)

  • z_source (float)

Return type:

CMBConvergence

class firecrown.likelihood.cmb.CMBConvergenceFactory(/, **data)[source]

Bases: pydantic.BaseModel

Inheritance diagram of firecrown.likelihood.cmb.CMBConvergenceFactory

Factory class for CMBConvergence objects.

Parameters:

data (Any)

model_config

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

type_source: firecrown.metadata_types.TypeSource
z_source: float = 1100.0
scale: float = 1.0
model_post_init(_, /)[source]

Initialize the CMBConvergenceFactory.

Return type:

None

create(inferred_galaxy_zdist)[source]

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

Parameters:

inferred_galaxy_zdist (firecrown.metadata_types.InferredGalaxyZDist) – the inferred galaxy redshift distribution

Returns:

a fully initialized CMBConvergence object

Return type:

CMBConvergence

create_from_metadata_only(sacc_tracer)[source]

Create a CMBConvergence object from metadata only.

Parameters:

sacc_tracer (str) – the name of the tracer

Returns:

a fully initialized CMBConvergence object

Return type:

CMBConvergence