Skip to content

PRBEM Standard

el_paso.data_standards.prbem_standard.PRBEMStandard

Bases: DataStandard[PRBEMName]

A data standard of the Panel for Radiation Belt Environment Modeling (PRBEM).

This class defines and applies a specific set of data standards for variables defined by the PRBEM. It standardizes variables by converting them to canonical units and performing consistency checks on their dimensions and shapes, ensuring they conform to the expected format for each standard name.

Source code in el_paso/data_standards/prbem_standard.py 
16
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
46
47
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class PRBEMStandard(DataStandard[PRBEMName]):
    """A data standard of the Panel for Radiation Belt Environment Modeling (PRBEM).

    This class defines and applies a specific set of data standards for variables
    defined by the [PRBEM](https://prbem.github.io/documents/Standard_File_Format.pdf).
    It standardizes variables by converting them to canonical units and performing
    consistency checks on their dimensions and shapes, ensuring they conform to the
    expected format for each standard name.
    """

    def __init__(self) -> None:
        """Initializes the PRBEMStandard with a ConsistencyCheck object."""
        self.consistency_check = ConsistencyCheck()

        self.variable_infos: dict[str, VariableInfo[PRBEMName]] = {
            "Epoch": VariableInfo[PRBEMName]("Epoch", "Posix Time", ep.units.posixtime, dependencies=["Epoch"]),
            "FEDU": VariableInfo[PRBEMName](
                "FEDU",
                "Processed unidirectional differential electron flux",
                (u.cm**2 * u.s * u.sr * u.keV) ** (-1),
                dependencies=["Epoch", "Energy_FEDU", "Alpha"],
            ),
            "Alpha": VariableInfo[PRBEMName](
                "Alpha", "Local pitch angle the instrument is looking at", u.deg, dependencies=["Epoch", "Alpha"]
            ),
            "Alpha_Eq": VariableInfo[PRBEMName](
                "Alpha_Eq",
                "Computed equatorial pitch angle the instrument is looking from Alpha, B_Calc and B_Eq",
                u.deg,
                dependencies=["Epoch", "Alpha"],
            ),
            "Energy_FEDU": VariableInfo[PRBEMName](
                "Energy_FEDU",
                "Central energy of unidirectional differential electron flux",
                u.MeV,
                dependencies=["Epoch", "Energy_FEDU"],
            ),
            "Position": VariableInfo[PRBEMName](
                "Position",
                "Spacecraft position in geographic cartesian coordinates",
                u.km,
                dependencies=["Epoch", "Position_components"],
            ),
            "B_Calc": VariableInfo[PRBEMName](
                "B_Calc",
                "Calculated magnetic field strength at the spacecraft position",
                u.nT,
                dependencies=["Epoch"],
            ),
            "B_Eq": VariableInfo[PRBEMName](
                "B_Eq",
                "Calculated magnetic field strength at magnetic equator",
                u.nT,
                dependencies=["Epoch"],
            ),
            "L_m": VariableInfo[PRBEMName](
                "L_m",
                "Calculated L McIlwain's L parameter",
                u.dimensionless_unscaled,
                dependencies=["Epoch", "Alpha"],
            ),
            "L_star": VariableInfo[PRBEMName](
                "L_star",
                "Calculated Roederer's L* parameter",
                u.dimensionless_unscaled,
                dependencies=["Epoch", "Alpha"],
            ),
            "InvMu": VariableInfo[PRBEMName](
                "InvMu", "Calculated first adiabatic invariant.", u.MeV / u.G, ["Epoch", "Energy_FEDU", "Alpha"]
            ),
            "InvK": VariableInfo[PRBEMName](
                "InvK", "Calculated modified second adiabatic invariant.", ep.units.RE * u.G**0.5, ["Epoch", "Alpha"]
            ),
            "R_Eq": VariableInfo[PRBEMName](
                "R_Eq", "Radial distance of the satellite location mapped to the equator.", ep.units.RE, ["Epoch"]
            ),
            "PSD": VariableInfo[PRBEMName](
                "PSD",
                "Calculated phase space density of particles.",
                (u.m * u.kg * u.m / u.s) ** (-3),
                ["Epoch", "Energy_FEDU", "Alpha"],
            ),
            "MLT": VariableInfo[PRBEMName]("MLT", "Magnetic local time at the satellite location.", u.hour, ["Epoch"]),
        }

Methods:

el_paso.data_standards.prbem_standard.PRBEMStandard.__init__ 

__init__

Initializes the PRBEMStandard with a ConsistencyCheck object.

Source code in el_paso/data_standards/prbem_standard.py 
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
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def __init__(self) -> None:
    """Initializes the PRBEMStandard with a ConsistencyCheck object."""
    self.consistency_check = ConsistencyCheck()

    self.variable_infos: dict[str, VariableInfo[PRBEMName]] = {
        "Epoch": VariableInfo[PRBEMName]("Epoch", "Posix Time", ep.units.posixtime, dependencies=["Epoch"]),
        "FEDU": VariableInfo[PRBEMName](
            "FEDU",
            "Processed unidirectional differential electron flux",
            (u.cm**2 * u.s * u.sr * u.keV) ** (-1),
            dependencies=["Epoch", "Energy_FEDU", "Alpha"],
        ),
        "Alpha": VariableInfo[PRBEMName](
            "Alpha", "Local pitch angle the instrument is looking at", u.deg, dependencies=["Epoch", "Alpha"]
        ),
        "Alpha_Eq": VariableInfo[PRBEMName](
            "Alpha_Eq",
            "Computed equatorial pitch angle the instrument is looking from Alpha, B_Calc and B_Eq",
            u.deg,
            dependencies=["Epoch", "Alpha"],
        ),
        "Energy_FEDU": VariableInfo[PRBEMName](
            "Energy_FEDU",
            "Central energy of unidirectional differential electron flux",
            u.MeV,
            dependencies=["Epoch", "Energy_FEDU"],
        ),
        "Position": VariableInfo[PRBEMName](
            "Position",
            "Spacecraft position in geographic cartesian coordinates",
            u.km,
            dependencies=["Epoch", "Position_components"],
        ),
        "B_Calc": VariableInfo[PRBEMName](
            "B_Calc",
            "Calculated magnetic field strength at the spacecraft position",
            u.nT,
            dependencies=["Epoch"],
        ),
        "B_Eq": VariableInfo[PRBEMName](
            "B_Eq",
            "Calculated magnetic field strength at magnetic equator",
            u.nT,
            dependencies=["Epoch"],
        ),
        "L_m": VariableInfo[PRBEMName](
            "L_m",
            "Calculated L McIlwain's L parameter",
            u.dimensionless_unscaled,
            dependencies=["Epoch", "Alpha"],
        ),
        "L_star": VariableInfo[PRBEMName](
            "L_star",
            "Calculated Roederer's L* parameter",
            u.dimensionless_unscaled,
            dependencies=["Epoch", "Alpha"],
        ),
        "InvMu": VariableInfo[PRBEMName](
            "InvMu", "Calculated first adiabatic invariant.", u.MeV / u.G, ["Epoch", "Energy_FEDU", "Alpha"]
        ),
        "InvK": VariableInfo[PRBEMName](
            "InvK", "Calculated modified second adiabatic invariant.", ep.units.RE * u.G**0.5, ["Epoch", "Alpha"]
        ),
        "R_Eq": VariableInfo[PRBEMName](
            "R_Eq", "Radial distance of the satellite location mapped to the equator.", ep.units.RE, ["Epoch"]
        ),
        "PSD": VariableInfo[PRBEMName](
            "PSD",
            "Calculated phase space density of particles.",
            (u.m * u.kg * u.m / u.s) ** (-3),
            ["Epoch", "Energy_FEDU", "Alpha"],
        ),
        "MLT": VariableInfo[PRBEMName]("MLT", "Magnetic local time at the satellite location.", u.hour, ["Epoch"]),
    }