Skip to content

API Reference

This section provides auto-generated API documentation for all public classes and functions in cloelike.

Module overview

cloelike

Classes

EuclidLikelihood_WL

Bases: WLMixin, PhotoLikelihoodBase

EuclidLikelihood_WL computes the weak lensing (WL) likelihood for photometric surveys using Euclid data.

Inherits from: PhotoLikelihoodBase: Base class for photometric likelihoods. WLMixin: Mixin providing weak lensing specific functionality.

Parameters:

Name Type Description Default
data dict

Input data required for likelihood computation, including observed ells and other relevant quantities.

 required
settings dict

Configuration settings for the likelihood calculation.

 required
Background object

Instance representing the cosmological background model.

 required
LinPerturbations object

Instance representing linear perturbations.

 required
NonLinPerturbations object

Instance representing non-linear perturbations.

 required
mode str

Mode of operation, default is "coupled".

 required
Source code in cloelike/EuclidLikelihood_photo_Cls.py 
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
class EuclidLikelihood_WL(WLMixin, PhotoLikelihoodBase):
    """
    EuclidLikelihood_WL computes the weak lensing (WL) likelihood for photometric surveys using Euclid data.

    Inherits from:
        PhotoLikelihoodBase: Base class for photometric likelihoods.
        WLMixin: Mixin providing weak lensing specific functionality.

    Parameters
    ----------
    data : dict
        Input data required for likelihood computation, including observed ells and other relevant quantities.
    settings : dict
        Configuration settings for the likelihood calculation.
    Background : object
        Instance representing the cosmological background model.
    LinPerturbations : object
        Instance representing linear perturbations.
    NonLinPerturbations : object
        Instance representing non-linear perturbations.
    mode : str, optional
        Mode of operation, default is "coupled".
    """

    pass

EuclidLikelihood_GCph

Bases: GCphMixin, PhotoLikelihoodBase

EuclidLikelihood_GCph computes the likelihood for galaxy clustering photometric (GCph) data using the Euclid survey specifications.

Inherits from: PhotoLikelihoodBase: Base class for photometric likelihoods. GCphMixin: Mixin providing GCph-specific functionality.

Parameters:

Name Type Description Default
data dict

Input data required for likelihood computation, including observed ells and other relevant quantities.

 required
settings dict

Configuration settings for the likelihood calculation.

 required
Background object

Instance representing the cosmological background model.

 required
LinPerturbations object

Instance representing linear perturbations.

 required
NonLinPerturbations object

Instance representing non-linear perturbations.

 required
mode str

Mode of operation, default is "coupled".

 required
Source code in cloelike/EuclidLikelihood_photo_Cls.py 
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
class EuclidLikelihood_GCph(GCphMixin, PhotoLikelihoodBase):
    """
    EuclidLikelihood_GCph computes the likelihood for galaxy clustering photometric (GCph) data
    using the Euclid survey specifications.

    Inherits from:
        PhotoLikelihoodBase: Base class for photometric likelihoods.
        GCphMixin: Mixin providing GCph-specific functionality.

    Parameters
    ----------
    data : dict
        Input data required for likelihood computation, including observed ells and other relevant quantities.
    settings : dict
        Configuration settings for the likelihood calculation.
    Background : object
        Instance representing the cosmological background model.
    LinPerturbations : object
        Instance representing linear perturbations.
    NonLinPerturbations : object
        Instance representing non-linear perturbations.
    mode : str, optional
        Mode of operation, default is "coupled".
    """

    pass

EuclidLikelihood_GGL

Bases: GGLMixin, PhotoLikelihoodBase

EuclidLikelihood_GGL class for galaxy-galaxy lensing likelihood computation.

This class combines the functionalities of PhotoLikelihoodBase and GGLMixin to compute the likelihood for galaxy-galaxy lensing (GGL) using photometric data. It initializes the necessary components and constructs a masking vector based on scale cuts for each GGL key.

Inherits from: PhotoLikelihoodBase: Base class for photometric likelihoods. GGLMixin: Mixin providing GGL-specific functionality.

Parameters:

Name Type Description Default
data dict

Input data required for likelihood computation, including observed ells and other relevant quantities.

 required
settings dict

Configuration settings for the likelihood calculation.

 required
Background object

Instance representing the cosmological background model.

 required
LinPerturbations object

Instance representing linear perturbations.

 required
NonLinPerturbations object

Instance representing non-linear perturbations.

 required
mode str

Mode of operation, default is "coupled".

 required
Source code in cloelike/EuclidLikelihood_photo_Cls.py 
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
class EuclidLikelihood_GGL(GGLMixin, PhotoLikelihoodBase):
    """
    EuclidLikelihood_GGL class for galaxy-galaxy lensing likelihood computation.

    This class combines the functionalities of PhotoLikelihoodBase and GGLMixin to compute
    the likelihood for galaxy-galaxy lensing (GGL) using photometric data. It initializes
    the necessary components and constructs a masking vector based on scale cuts for each
    GGL key.

    Inherits from:
        PhotoLikelihoodBase: Base class for photometric likelihoods.
        GGLMixin: Mixin providing GGL-specific functionality.

    Parameters
    ----------
    data : dict
        Input data required for likelihood computation, including observed ells and other relevant quantities.
    settings : dict
        Configuration settings for the likelihood calculation.
    Background : object
        Instance representing the cosmological background model.
    LinPerturbations : object
        Instance representing linear perturbations.
    NonLinPerturbations : object
        Instance representing non-linear perturbations.
    mode : str, optional
        Mode of operation, default is "coupled".
    """

    pass

EuclidLikelihood_3x2pt

Bases: GCphMixin, GGLMixin, WLMixin, PhotoLikelihoodBase

EuclidLikelihood_3x2pt combines weak lensing (WL), galaxy clustering (GCph), and galaxy-galaxy lensing (GGL) likelihoods for photometric cosmological analyses, supporting scale cuts and masking.

Inherits from: PhotoLikelihoodBase: Base class for photometric likelihoods. GCphMixin: Mixin providing galaxy clustering specific functionality. GGLMixin: Mixin providing galaxy-galaxy lensing specific functionality. WLMixin: Mixin providing weak lensing specific functionality.

Note: The order of inheritance matters due to the method resolution order (MRO) in Python and how mixins extend the base class functionality. Also, the order of the mixins assumes the ordering of the covariance matrix blocks is GCph, GGL and WL.

Parameters:

Name Type Description Default
data dict

Dictionary containing observational data vectors and related metadata.

 required
settings dict

Configuration settings for the likelihood calculation.

 required
Background object

Instance providing background cosmology calculations.

 required
LinPerturbations object

Instance for linear perturbation theory calculations.

 required
NonLinPerturbations object

Instance for non-linear perturbation theory calculations.

 required
mode str

Mode for likelihood calculation, default is "coupled".

 required
Source code in cloelike/EuclidLikelihood_photo_Cls.py 
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
class EuclidLikelihood_3x2pt(GCphMixin, GGLMixin, WLMixin, PhotoLikelihoodBase):
    """
    EuclidLikelihood_3x2pt combines weak lensing (WL), galaxy clustering (GCph), and galaxy-galaxy lensing (GGL)
    likelihoods for photometric cosmological analyses, supporting scale cuts and masking.

    Inherits from:
        PhotoLikelihoodBase: Base class for photometric likelihoods.
        GCphMixin: Mixin providing galaxy clustering specific functionality.
        GGLMixin: Mixin providing galaxy-galaxy lensing specific functionality.
        WLMixin: Mixin providing weak lensing specific functionality.

    Note: The order of inheritance matters due to the method resolution order (MRO) in Python
    and how mixins extend the base class functionality. Also, the order of the mixins assumes
    the ordering of the covariance matrix blocks is GCph, GGL and WL.

    Parameters
    ----------
    data : dict
        Dictionary containing observational data vectors and related metadata.
    settings : dict
        Configuration settings for the likelihood calculation.
    Background : object
        Instance providing background cosmology calculations.
    LinPerturbations : object
        Instance for linear perturbation theory calculations.
    NonLinPerturbations : object
        Instance for non-linear perturbation theory calculations.
    mode : str, optional
        Mode for likelihood calculation, default is "coupled".
    """

    pass

EuclidLikelihood_2x2pt

Bases: GCphMixin, GGLMixin, PhotoLikelihoodBase

Likelihood class for Euclid 2x2pt photometric clustering and galaxy-galaxy lensing analysis.

This class combines galaxy clustering (GCph) and galaxy-galaxy lensing (GGL) likelihoods, providing methods to compute the full data and theory vectors for both probes.

Note: The order of inheritance matters due to the method resolution order (MRO) in Python and how mixins extend the base class functionality. The order of the mixins assumes the ordering of the covariance matrix blocks is GCph, GGL.

Parameters:

Name Type Description Default
data dict

Input data dictionary containing observed power spectra and related quantities.

 required
settings dict

Configuration settings for the likelihood analysis.

 required
Background object

Cosmological background model instance.

 required
LinPerturbations object

Linear perturbations model instance.

 required
NonLinPerturbations object

Non-linear perturbations model instance.

 required
mode str

Mode for likelihood computation, default is "coupled".

 required
Source code in cloelike/EuclidLikelihood_photo_Cls.py 
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
class EuclidLikelihood_2x2pt(GCphMixin, GGLMixin, PhotoLikelihoodBase):
    """
    Likelihood class for Euclid 2x2pt photometric clustering and galaxy-galaxy lensing analysis.

    This class combines galaxy clustering (GCph) and galaxy-galaxy lensing (GGL) likelihoods,
    providing methods to compute the full data and theory vectors for both probes.

    Note: The order of inheritance matters due to the method resolution order (MRO) in Python
    and how mixins extend the base class functionality. The order of the mixins assumes
    the ordering of the covariance matrix blocks is GCph, GGL.

    Parameters
    ----------
    data : dict
        Input data dictionary containing observed power spectra and related quantities.
    settings : dict
        Configuration settings for the likelihood analysis.
    Background : object
        Cosmological background model instance.
    LinPerturbations : object
        Linear perturbations model instance.
    NonLinPerturbations : object
        Non-linear perturbations model instance.
    mode : str, optional
        Mode for likelihood computation, default is "coupled".
    """

    pass

options: show_source: false show_root_heading: true members: - EuclidLikelihood_WL - EuclidLikelihood_GCph - EuclidLikelihood_GGL - EuclidLikelihood_3x2pt - EuclidLikelihood_2x2pt - EuclidLikelihood_GCspectro_Pls - EuclidLikelihood_BAO