Skip to content

brahmap.core.GLSParameters

A class to encapsulate the parameters used for GLS map-making

Attributes:

Name Type Description
solver_type SolverType

description
use_iterative_solver bool

description
isolver_threshold float

description
isolver_max_iterations int

description
callback_function Callable

description
return_processed_samples bool

description
return_hit_map bool

description
Source code in brahmap/core/GLS.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@dataclass
class GLSParameters:
    """A class to encapsulate the parameters used for GLS map-making

    Attributes
    ----------
    solver_type : SolverType
        _description_
    use_iterative_solver : bool
        _description_
    isolver_threshold : float
        _description_
    isolver_max_iterations : int
        _description_
    callback_function : Callable
        _description_
    return_processed_samples : bool
        _description_
    return_hit_map : bool
        _description_
    """

    solver_type: SolverType = SolverType.IQU
    use_iterative_solver: bool = True
    isolver_threshold: float = 1.0e-12
    isolver_max_iterations: int = 100
    callback_function: Callable = None
    return_processed_samples: bool = False
    return_hit_map: bool = False