Skip to content

brahmap.core.GLSResult

A data class storing the output results of the Generalized Least Squares (GLS) map-making algorithm.

Attributes:

Name Type Description
solver_type SolverType

The map-making solver configuration (e.g. \(I\), \(QU\), \(IQU\))
npix int

The number of pixels in the sky map
new_npix int

The number of valid pixels actually observed and processed
GLS_maps NDArray[number]

The final Generalized Least Squares (GLS) estimated sky maps
hit_map NDArray[number] | None

The array representing the total number of hits per pixel
convergence_status bool

A boolean indicating whether the iterative solver successfully converged
num_iterations int

The total number of iterations actually performed by the solver before stopping
GLSParameters GLSParameters

The input parameters configuration used for the GLS map-making
Source code in brahmap/core/GLS.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
@dataclass
class GLSResult:
    """A data class storing the output results of the Generalized Least
    Squares (GLS) map-making algorithm.

    Attributes
    ----------
    solver_type : SolverType
        The map-making solver configuration (e.g. $I$, $QU$, $IQU$)
    npix : int
        The number of pixels in the sky map
    new_npix : int
        The number of valid pixels actually observed and processed
    GLS_maps : npt.NDArray[np.number]
        The final Generalized Least Squares (GLS) estimated sky maps
    hit_map : npt.NDArray[np.number] | None
        The array representing the total number of hits per pixel
    convergence_status : bool
        A boolean indicating whether the iterative solver successfully converged
    num_iterations : int
        The total number of iterations actually performed by the solver before stopping
    GLSParameters : GLSParameters
        The input parameters configuration used for the GLS map-making
    """

    solver_type: SolverType
    npix: int
    new_npix: int
    GLS_maps: npt.NDArray[np.number]
    hit_map: npt.NDArray[np.number] | None
    convergence_status: bool
    num_iterations: int
    GLSParameters: GLSParameters