Skip to content

Schemas

This page is generated from the SOPRAN schema definitions (InstrumentSchema). Do not edit it by hand: change the schema in code, then regenerate it with python -m sopran.schema_docs --language en docs/en/reference/schemas.md. The columns are the variable name, dimensions, units, data type, frame, aliases, and description.

kaguya / esa1

name dims units dtype frame aliases description
energy_flux time, energy, look eV/(cm^2 s sr eV) eflux, differential_energy_flux KAGUYA PACE ESA1 differential electron energy flux derived from counts with PACE INFO calibration tables.
counts time, energy, look count Raw ESA1 counts.
energy energy channel PACE ESA1 energy channel index by default; calibrated loads replace it with PACE INFO energy centers in eV.
quality time flag q, quality_flag Quality flag.

kaguya / esa2

name dims units dtype frame aliases description
energy_flux time, energy, look eV/(cm^2 s sr eV) eflux, differential_energy_flux KAGUYA PACE ESA2 differential electron energy flux derived from counts with PACE INFO calibration tables.
counts time, energy, look count Raw ESA2 counts.
energy energy channel PACE ESA2 energy channel index by default; calibrated loads replace it with PACE INFO energy centers in eV.
quality time flag q, quality_flag Quality flag.

kaguya / ima

name dims units dtype frame aliases description
energy_flux time, energy, look eV/(cm^2 s sr eV) eflux, differential_energy_flux KAGUYA PACE IMA differential ion energy flux derived from counts with PACE INFO calibration tables.
counts time, energy, look count Raw IMA counts.
energy energy channel PACE IMA energy channel index by default; calibrated loads replace it with PACE INFO energy centers in eV.
quality time flag q, quality_flag Quality flag.

kaguya / iea

name dims units dtype frame aliases description
energy_flux time, energy, look eV/(cm^2 s sr eV) eflux, differential_energy_flux KAGUYA PACE IEA differential ion energy flux derived from counts with PACE INFO calibration tables.
counts time, energy, look count Raw IEA counts.
energy energy channel PACE IEA energy channel index by default; calibrated loads replace it with PACE INFO energy centers in eV.
quality time flag q, quality_flag Quality flag.

kaguya / lmag

name dims units dtype frame aliases description
magnetic_field time, component nT MOON_ME b, lmag, bme, b_moon_me KAGUYA LMAG magnetic field vector in the Moon Mean Earth frame.
magnetic_field_gse time, component nT GSE bgse, b_gse KAGUYA LMAG magnetic field vector in the GSE frame.
magnetic_field_magnitude time nT bmag, magnetic_field_strength Magnitude of the KAGUYA LMAG magnetic field vector.

kaguya / lrs

name dims units dtype frame aliases description
npw_rx1 time, frequency dB kgy_lrs_npw_rx1 KAGUYA LRS NPW receiver 1 spectrum.
npw_rx2 time, frequency dB kgy_lrs_npw_rx2 KAGUYA LRS NPW receiver 2 spectrum.
npw_mode time flag kgy_lrs_npw_mode KAGUYA LRS NPW mode flag.
wfc_ex_db time, frequency dB kgy_lrs_wfc_ex_db, kgy_lrs_wfc_Ex, kgy_lrs_wfc_Ex_dB KAGUYA LRS WFC Ex raw electric-field spectrum in dB.
wfc_ey_db time, frequency dB kgy_lrs_wfc_ey_db, kgy_lrs_wfc_Ey, kgy_lrs_wfc_Ey_dB KAGUYA LRS WFC Ey raw electric-field spectrum in dB.
wfc_gain time dB kgy_lrs_wfc_gain KAGUYA LRS WFC gain decoded from the Gain flag.
wfc_mode time flag kgy_lrs_wfc_mode Raw KAGUYA LRS WFC Mode support byte.
wfc_ex_field time, frequency dB uV/m wfc_ex_physical, kgy_lrs_wfc_ex_phys, kgy_lrs_wfc_Ex_phys KAGUYA LRS WFC Ex field level after gain and band correction.
wfc_ey_field time, frequency dB uV/m wfc_ey_physical, kgy_lrs_wfc_ey_phys, kgy_lrs_wfc_Ey_phys KAGUYA LRS WFC Ey field level after gain and band correction.
wfc_ex_power_spectral_density time, frequency (V/m)^2/Hz wfc_ex_power, kgy_lrs_wfc_ex_phys2, kgy_lrs_wfc_Ex_phys2 KAGUYA LRS WFC Ex electric-field power spectral density.
wfc_ey_power_spectral_density time, frequency (V/m)^2/Hz wfc_ey_power, kgy_lrs_wfc_ey_phys2, kgy_lrs_wfc_Ey_phys2 KAGUYA LRS WFC Ey electric-field power spectral density.
wfc_xymode time flag kgy_lrs_wfc_xymode KAGUYA LRS WFC XY mode decoded from the Mode flag.
wfc_fband time flag kgy_lrs_wfc_fband KAGUYA LRS WFC frequency band decoded from the Mode flag.
wfc_omode time flag kgy_lrs_wfc_omode KAGUYA LRS WFC operation mode decoded from the Mode flag.
wfc_pdc_ti time count kgy_lrs_wfc_pdc_ti, kgy_lrs_wfc_pdc-ti KAGUYA LRS WFC PDC-TI 48-bit spacecraft observation-time counter; this is not UTC.
wfc_pdc_ti_words time, pdc_word counter word Raw high, middle, and low uint16 words of the KAGUYA LRS WFC PDC-TI counter.
wfc_postgap time flag kgy_lrs_wfc_postgap KAGUYA LRS WFC PostGap flag.

kaguya / orbit

name dims units dtype frame aliases description
position time, component km MOON_ME rme, r_moon_me KAGUYA spacecraft position vector in the Moon Mean Earth frame.
position_gse time, component km GSE rgse, r_gse KAGUYA spacecraft position vector in the GSE frame.
radial_distance time km MOON_ME radius, r Distance from the Moon center to the KAGUYA spacecraft.
altitude time km MOON_ME KAGUYA altitude above a spherical Moon reference radius.
subpoint time, component deg MOON_ME Spherical Moon subpoint longitude and latitude.
sza time deg MOON_ME Solar zenith angle at the spherical Moon subpoint, computed from SPICE Sun geometry unless an explicit Sun direction vector is supplied.

kaguya / lmag / magnetic_connection

name dims units dtype frame aliases description
connected_any time flag bool Whether either magnetic-field direction intersects the sphere.
connected_plus time flag bool Whether the plus magnetic-field direction intersects the sphere.
connected_minus time flag bool Whether the minus magnetic-field direction intersects the sphere.
footpoint_plus_lon time deg MOON_ME Plus-direction spherical footpoint longitude.
footpoint_plus_lat time deg MOON_ME Plus-direction spherical footpoint latitude.
footpoint_minus_lon time deg MOON_ME Minus-direction spherical footpoint longitude.
footpoint_minus_lat time deg MOON_ME Minus-direction spherical footpoint latitude.
distance_plus_km time km Distance along the plus magnetic-field direction to the sphere.
distance_minus_km time km Distance along the minus magnetic-field direction to the sphere.
incidence_angle_plus_deg time deg Acute angle between plus field line and local surface normal.
incidence_angle_minus_deg time deg Acute angle between minus field line and local surface normal.
altitude_km time km Spacecraft altitude above the spherical reference radius.

artemis / fgm

name dims units dtype frame aliases description
magnetic_field time, component nT GSE b, fgm FGM spin-resolution (~3 s, FGS) magnetic field vector in GSE.

artemis / esa

name dims units dtype frame aliases description
ion_energy_flux time, energy_bin eV/(cm^2 s sr eV) ion_eflux, esa ESA ion differential energy flux; the energy table is the per-record (time, energy_bin) coordinate 'energy' in eV.
electron_energy_flux time, energy_bin eV/(cm^2 s sr eV) electron_eflux ESA electron differential energy flux; the energy table is the per-record (time, energy_bin) coordinate 'energy' in eV.
ion_density time cm^-3 ESA ground-processed ion density moment.
ion_velocity time, component km/s GSE ion_bulk_velocity ESA ground-processed ion bulk velocity moment in GSE.
electron_density time cm^-3 ESA ground-processed electron density moment.

lunar_prospector / mag

name dims units dtype frame aliases description
magnetic_field time, component nT SSE b 5-s magnetic field in selenocentric solar ecliptic (SSE) coordinates.
magnetic_field_sel time, component nT SEL 5-s magnetic field in selenographic (SEL) Cartesian coordinates.
magnetic_field_rms time nT RMS deviation of the field within each 5-s average.
position time, component km SSE Spacecraft position from the Moon centre in SSE.
position_sel time, component km SEL Spacecraft position from the Moon centre in SEL.

lunar_prospector / er

name dims units dtype frame aliases description
electron_flux time, energy_bin 1/(cm^2 s sr eV) ~80-s omnidirectional differential electron number flux in 15 energy bins; 'energy' is the (time, energy_bin) table in effect, in eV.
electron_flux_3d time, energy_bin, look 1/(cm^2 s sr eV) 3-D electron spectra (15 energies x 88 look directions per ~80-s spectrum) with theta, phi and the despun-spacecraft field as coordinates.

moon / surface

name dims units dtype frame aliases description
dem lat, lon m float64 Moon body-fixed elevation, height Digital elevation model on a body-fixed lunar grid.
svm lat, lon nT float64 Moon body-fixed surface_vector_map, svm_tsunakawa2015, tsunakawa_svm2015, svm_ravat2020, lunar_magnetic_anomaly Lunar crustal magnetic field at the surface: the Tsunakawa 2015 surface vector map (total field) or the Ravat 2020 model (selectable component).
shadow lat, lon fraction float64 Moon body-fixed shadow_map, shadow_fraction Shadow or shadow-fraction map computed with SZA-threshold or terrain-ray DEM horizon classification.
illumination lat, lon fraction float64 Moon body-fixed illumination_map, visibility Illumination or visibility fraction derived from solar geometry.
sza lat, lon deg float64 Moon body-fixed solar_zenith_angle Solar zenith angle on the lunar surface.

omni / hro_5min

name dims units dtype frame aliases description
velocity time, component km/s float64 GSE Solar-wind bulk velocity vector at the bow-shock nose; NASA removes the mean Earth aberration from Vy
magnetic_field time, component nT float64 GSE 5-minute mean interplanetary magnetic field vector
speed time km/s float64 Flow speed
density time cm^-3 float64 Proton density
pressure time nPa float64 Flow pressure
timeshift time s float64 Shift applied by NASA from the observing spacecraft to the bow-shock nose
bsn_x time Re float64 GSE Bow-shock nose x position used for the NASA time shift