PRBEM DataSet

el_paso.dataset.PRBEMDataSet

Bases: DataSet

A concrete implementation of DataSet for the PRBEMStandard.

Represents a dataset with variables defined by the PRBEMStandard, providing structured access to space physics measurements including particle fluxes, phase space densities, magnetic field data, and adiabatic invariants.

Attributes:

Name	Type	Description
datetime	list[datetime]	List of datetime objects corresponding to each time step.
Epoch	NDArray[float64]	Array of time values as POSIX timestamps (seconds since epoch).
FEDU	NDArray[float64]	Processed unidirectional differential electron flux, in (cm^2 s sr keV)^-1.
FEDO	NDArray[float64]	Processed omnidirectional differential electron flux.
FEIU	NDArray[float64]	Processed unidirectional integral electron flux.
Energy_FEDU	NDArray[float64]	Central energy of the FEDU channels, in MeV.
Alpha	NDArray[float64]	Local pitch angle the instrument is looking at, in degrees.
Alpha_Eq	NDArray[float64]	Computed equatorial pitch angle, in degrees.
Position	NDArray[float64]	Spacecraft position in geographic cartesian coordinates, in km.
B_Calc	NDArray[float64]	Calculated magnetic field strength at the spacecraft position, in nT.
B_Eq	NDArray[float64]	Calculated magnetic field strength at the magnetic equator, in nT.
L_star	NDArray[float64]	Calculated Roederer's L* parameter.
I	NDArray[float64]	Second adiabatic invariant integral, PRBEM standard name "I".
MLT	NDArray[float64]	Magnetic local time at the satellite location, in hours.
L_m	NDArray[float64]	Calculated McIlwain's L parameter.
PSD	NDArray[float64]	Calculated phase space density of particles.
R_Eq	NDArray[float64]	Radial distance of the satellite location mapped to the equator, in Earth radii.
InvMu	NDArray[float64]	Calculated first adiabatic invariant, in MeV/G.
InvK	NDArray[float64]	Calculated modified second adiabatic invariant, in Earth radii * G^0.5.
metadata	PRBEMMetaData	Metadata container for all loaded variables.

Source code in el_paso/dataset/dataset_implementations.py

class PRBEMDataSet(DataSet):
    """A concrete implementation of DataSet for the PRBEMStandard.

    Represents a dataset with variables defined by the PRBEMStandard,
    providing structured access to space physics measurements including
    particle fluxes, phase space densities, magnetic field data, and
    adiabatic invariants.

    Attributes:
        datetime (list[dt.datetime]): List of datetime objects corresponding to each time step.
        Epoch (NDArray[np.float64]): Array of time values as POSIX timestamps (seconds since epoch).
        FEDU (NDArray[np.float64]): Processed unidirectional differential electron flux,
            in (cm^2 s sr keV)^-1.
        FEDO (NDArray[np.float64]): Processed omnidirectional differential electron flux.
        FEIU (NDArray[np.float64]): Processed unidirectional integral electron flux.
        Energy_FEDU (NDArray[np.float64]): Central energy of the FEDU channels, in MeV.
        Alpha (NDArray[np.float64]): Local pitch angle the instrument is looking at, in degrees.
        Alpha_Eq (NDArray[np.float64]): Computed equatorial pitch angle, in degrees.
        Position (NDArray[np.float64]): Spacecraft position in geographic cartesian coordinates, in km.
        B_Calc (NDArray[np.float64]): Calculated magnetic field strength at the spacecraft position, in nT.
        B_Eq (NDArray[np.float64]): Calculated magnetic field strength at the magnetic equator, in nT.
        L_star (NDArray[np.float64]): Calculated Roederer's L* parameter.
        I (NDArray[np.float64]): Second adiabatic invariant integral, PRBEM standard name "I".
        MLT (NDArray[np.float64]): Magnetic local time at the satellite location, in hours.
        L_m (NDArray[np.float64]): Calculated McIlwain's L parameter.
        PSD (NDArray[np.float64]): Calculated phase space density of particles.
        R_Eq (NDArray[np.float64]): Radial distance of the satellite location mapped to the equator, in Earth radii.
        InvMu (NDArray[np.float64]): Calculated first adiabatic invariant, in MeV/G.
        InvK (NDArray[np.float64]): Calculated modified second adiabatic invariant, in Earth radii * G^0.5.
        metadata (PRBEMMetaData): Metadata container for all loaded variables.
    """

    datetime: list[dt.datetime]
    Epoch: NDArray[np.float64]
    FEDU: NDArray[np.float64]
    FEDO: NDArray[np.float64]
    FEIU: NDArray[np.float64]
    Energy_FEDU: NDArray[np.float64]
    Alpha: NDArray[np.float64]
    Alpha_Eq: NDArray[np.float64]
    Position: NDArray[np.float64]
    B_Calc: NDArray[np.float64]
    B_Eq: NDArray[np.float64]
    L_star: NDArray[np.float64]
    I: NDArray[np.float64]  # noqa: E741
    MLT: NDArray[np.float64]
    L_m: NDArray[np.float64]
    PSD: NDArray[np.float64]
    R_Eq: NDArray[np.float64]
    InvMu: NDArray[np.float64]
    InvK: NDArray[np.float64]
    metadata: PRBEMMetaData

    def __init__(
        self,
        saving_strategy: SavingStrategy,
        start_time: dt.datetime,
        end_time: dt.datetime,
        preferred_extension: MFSFormats = "nc",
        *,
        verbose: bool = True,
    ) -> None:
        """Initializes a PRBEMDataSet instance.

        Constructs the saving strategy, invokes the parent DataSet initializer,
        and populates the list of possible variables from class annotations.

        Args:
            saving_strategy (SavingStrategy): Instance of the saving strategy used to resolve file paths.
            start_time (dt.datetime): Beginning of the time range to load.
            end_time (dt.datetime): End of the time range to load.
            preferred_extension (MFSFormats): File format to prefer when reading
                and writing data. Defaults to ``"nc"`` (NetCDF).
            verbose (bool): If ``True``, print progress and diagnostic messages.
                Defaults to ``True``.
        """
        self.saving_strategy = saving_strategy
        self._start_time = start_time
        self._end_time = end_time
        self._preferred_ext = preferred_extension
        self._verbose = verbose

        if not isinstance(self.saving_strategy.data_standard, PRBEMStandard):
            msg = f"PRBEMDataSet requires a saving strategy with  `PRBEMStandard`, but got {type(self.saving_strategy.data_standard).__name__}"  # noqa: E501
            logger.error(msg)
            raise TypeError(msg)

        super().__init__(
            self.saving_strategy,
            self._start_time,
            self._end_time,
            self._preferred_ext,
            verbose=self._verbose,
        )

Methods:

el_paso.dataset.PRBEMDataSet.__init__

__init__

Initializes a PRBEMDataSet instance.

Constructs the saving strategy, invokes the parent DataSet initializer, and populates the list of possible variables from class annotations.

Parameters:

Name	Type	Description	Default
saving_strategy	SavingStrategy	Instance of the saving strategy used to resolve file paths.	required
start_time	datetime	Beginning of the time range to load.	required
end_time	datetime	End of the time range to load.	required
preferred_extension	MFSFormats	File format to prefer when reading and writing data. Defaults to "nc" (NetCDF).	'nc'
verbose	bool	If True, print progress and diagnostic messages. Defaults to True.	True

Source code in el_paso/dataset/dataset_implementations.py

def __init__(
    self,
    saving_strategy: SavingStrategy,
    start_time: dt.datetime,
    end_time: dt.datetime,
    preferred_extension: MFSFormats = "nc",
    *,
    verbose: bool = True,
) -> None:
    """Initializes a PRBEMDataSet instance.

    Constructs the saving strategy, invokes the parent DataSet initializer,
    and populates the list of possible variables from class annotations.

    Args:
        saving_strategy (SavingStrategy): Instance of the saving strategy used to resolve file paths.
        start_time (dt.datetime): Beginning of the time range to load.
        end_time (dt.datetime): End of the time range to load.
        preferred_extension (MFSFormats): File format to prefer when reading
            and writing data. Defaults to ``"nc"`` (NetCDF).
        verbose (bool): If ``True``, print progress and diagnostic messages.
            Defaults to ``True``.
    """
    self.saving_strategy = saving_strategy
    self._start_time = start_time
    self._end_time = end_time
    self._preferred_ext = preferred_extension
    self._verbose = verbose

    if not isinstance(self.saving_strategy.data_standard, PRBEMStandard):
        msg = f"PRBEMDataSet requires a saving strategy with  `PRBEMStandard`, but got {type(self.saving_strategy.data_standard).__name__}"  # noqa: E501
        logger.error(msg)
        raise TypeError(msg)

    super().__init__(
        self.saving_strategy,
        self._start_time,
        self._end_time,
        self._preferred_ext,
        verbose=self._verbose,
    )