Skip to content

brahmap.lbsim.LBSimGLSResult

Bases: GLSResult

A data class storing the output results of the GLS map-making done with litebird_sim data.

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 LBSimGLSParameters

The input parameters configuration used for the GLS map-making
nside int

The HEALPix resolution parameter defining the number of pixels
coordinate_system CoordinateSystem

The coordinate system to use for map-making (e.g., Galactic, Ecliptic)
GLSParameters GLSParameters

The input parameters configuration used for the GLS map-making
Source code in brahmap/lbsim/lbsim_GLS.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@dataclass
class LBSimGLSResult(GLSResult):
    """A data class storing the output results of the GLS map-making done with
    `litebird_sim` data.

    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 : LBSimGLSParameters
        The input parameters configuration used for the GLS map-making
    nside : int
        The HEALPix resolution parameter defining the number of pixels
    coordinate_system : lbs.CoordinateSystem
        The coordinate system to use for map-making (e.g., Galactic, Ecliptic)
    GLSParameters : GLSParameters
        The input parameters configuration used for the GLS map-making
    """

    nside: int
    coordinate_system: lbs.CoordinateSystem