swvo.io.RBMDataSet.scripts.create_RBSP_line_data#
Functions
|
Create RBSP line data for given time, energy, and alpha local targets. |
- swvo.io.RBMDataSet.scripts.create_RBSP_line_data.create_RBSP_line_data(start_time: datetime, end_time: datetime, data_server_path: Path, target_en: float | Iterable[float], target_al: float | Iterable[float], target_type: TargetType | Literal['TargetPairs', 'TargetMeshGrid'], energy_offset_threshold: float = 0.1, instruments: list[InstrumentEnum] | None = None, satellites: list[Literal['RBSPA', 'RBSPB', 'GOES13', 'GOES14', 'GOES15', 'GOESPrimary', 'GOESSecondary', 'ARASE', 'NOAA15', 'NOAA16', 'NOAA18', 'NOAA19', 'METOP1', 'METOP2', 'DSX'] | SatelliteEnum | Satellite] | Literal['RBSPA', 'RBSPB', 'GOES13', 'GOES14', 'GOES15', 'GOESPrimary', 'GOESSecondary', 'ARASE', 'NOAA15', 'NOAA16', 'NOAA18', 'NOAA19', 'METOP1', 'METOP2', 'DSX'] | SatelliteEnum | Satellite | None = None, mfm: MfmEnum = MfmEnum.T89, *, adjust_targets: bool = True, verbose: bool = True) tuple[list[RBMDataSet], list[InstrumentEnum]][source]#
Create RBSP line data for given time, energy, and alpha local targets.
- Parameters:
- start_timedatetime
Start time of the data to be loaded.
- end_timedatetime
End time of the data to be loaded.
- data_server_pathPath
Path to the data server where the RBSP data is stored.
- target_enfloat or Iterable[float]
Target energy in MeV or list of target energies in MeV.
- target_alfloat or Iterable[float]
Target alpha local in degrees or list of target alpha locals in degrees.
- target_typeTargetType or Literal[“TargetPairs”, “TargetMeshGrid”]
Type of target data to create. Can be either TargetPairs or TargetMeshGrid.
- energy_offset_thresholdfloat, optional
Threshold for the energy offset in relative units (default is 0.1).
- instrumentslist[InstrumentEnum] or None, optional
List of instruments to use for the data. If None, defaults to HOPE, MAGEIS, and REPT.
- satelliteslist[SatelliteLike] or SatelliteLike or None, optional
List of satellites to use for the data. If None, defaults to RBSPA and RBSPB.
- mfmMfmEnum, optional
Magnetic field model to use for the data. Default is MfmEnum.T89.
- adjust_targetsbool, optional
If True, the targets will be adjusted to the closest available energy and alpha local values. If False, the targets will be interpolated from the available data. Default is True.
- verbosebool, optional
If True, print verbose output during processing. Default is True.
- Returns:
- tuple[list[RBMDataSet], list[InstrumentEnum]]
A tuple containing a list of RBMDataSet objects with the line data and a list of instruments used.