Skip to content

brahmap.lbsim.LBSimGLSParameters

Bases: GLSParameters

A data class encapsulating the configuration parameters for the Generalized Least Squares (GLS) map-making algorithm with litebird_sim data.

Attributes:

Name Type Description
solver_type SolverType

The map-making solver configuration to use (e.g. \(I\), \(QU\), \(IQU\))
use_iterative_solver bool

Whether to enforce the use of an iterative solver (like PCG) for map-making
isolver_threshold float

The numerical tolerance threshold for the iterative solver to declare convergence
isolver_max_iterations int

The maximum number of iterations allowed for the iterative solver
callback_function Callable

A callable function executed at each iteration of the solver
return_processed_samples bool

Whether the GLS solver function should return the processed time samples container
return_hit_map bool

Whether the function should return the pixel hit map
output_coordinate_system CoordinateSystem

The celestial coordinate system to use for the generated output maps
Source code in brahmap/lbsim/lbsim_GLS.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@dataclass
class LBSimGLSParameters(GLSParameters):
    """A data class encapsulating the configuration parameters for the
    Generalized Least Squares (GLS) map-making algorithm with `litebird_sim` data.

    Attributes
    ----------
    solver_type : SolverType
        The map-making solver configuration to use (e.g. $I$, $QU$, $IQU$)
    use_iterative_solver : bool
        Whether to enforce the use of an iterative solver (like PCG) for map-making
    isolver_threshold : float
        The numerical tolerance threshold for the iterative solver to
        declare convergence
    isolver_max_iterations : int
        The maximum number of iterations allowed for the iterative solver
    callback_function : Callable
        A callable function executed at each iteration of the solver
    return_processed_samples : bool
        Whether the GLS solver function should return the processed time
        samples container
    return_hit_map : bool
        Whether the function should return the pixel hit map
    output_coordinate_system : lbs.CoordinateSystem
        The celestial coordinate system to use for the generated output maps
    """

    return_processed_samples: bool = False
    output_coordinate_system: lbs.CoordinateSystem = lbs.CoordinateSystem.Galactic