imap-processing 0.17.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

imap_processing/cdf/config/imap_hit_l2_variable_attrs.yaml

@@ -8,7 +8,7 @@ default_particle_attrs: &default_particle
   VALIDMAX: 10000000000.0
   FORMAT: F14.3
   UNITS: 1/(cm^2 s MeV/nuc sr)
-  SCALE_TYP: log
+  SCALETYP: log
   SCALEMIN: 0.0001
   SCALEMAX: 1000.0
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:NumberFlux,Qualifier:Differential
@@ -21,7 +21,7 @@ default_energy_attrs: &default_energy
   VALIDMAX: 1000.0
   FORMAT: F6.1
   UNITS: MeV/nuc
-  SCALE_TYP: log
+  SCALETYP: log
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge,Qualifier:Characteristic
 
 default_energy_delta_attrs: &default_energy_delta
@@ -45,7 +45,7 @@ default_angle_attrs: &default_angle
   VALIDMAX: 1000.0
   FORMAT: F12.2
   UNITS: Deg
-  SCALE_TYP: linear
+  SCALETYP: linear
 
 # <=== Coordinates ===>
 zenith:
@@ -337,7 +337,7 @@ dynamic_threshold_state:
   DISPLAY_TYPE: time_series
   FORMAT: I1
   UNITS: " "
-  SCALE_TYP: linear
+  SCALETYP: linear
   SCALEMIN: 0
   SCALEMAX: 1000
   DICT_KEY: SPASE>Support>SupportQuantity:InstrumentMode

imap_processing/cdf/config/imap_ialirt_l1_variable_attrs.yaml

@@ -17,8 +17,16 @@ component:
   VAR_TYPE: metadata
   UNITS: " "
 
+RTN_component:
+  CATDESC: Component direction (radial, tangential, normal)
+  FIELDNAM: RTN_component
+  LABLAXIS: RTN_component
+  FORMAT: A3
+  VAR_TYPE: metadata
+  UNITS: " "
+
 esa_step:
-  CATDESC: ESA step number
+  CATDESC: ESA step number. The nominal central energies for the 8 i-ALiRT channels are 100.4, 140, 194, 270, 376, 523, 727, and 1011 eV.
   FIELDNAM: esa_step
   LABLAXIS: esa_step
   FORMAT: I2
@@ -27,30 +35,30 @@ esa_step:
   VAR_TYPE: metadata
   UNITS: " "
 
-energy_ranges:
+codice_hi_h_energy_ranges:
     CATDESC: CoDICE-Hi energy ranges
-    FIELDNAM: energy_ranges
-    LABLAXIS: energy_ranges
+    FIELDNAM: codice_hi_h_energy_ranges
+    LABLAXIS: codice_hi_h_energy_ranges
     FORMAT: I3
     VALIDMIN: 0
     VALIDMAX: 14
     VAR_TYPE: metadata
     UNITS: " "
 
-azimuth:
-    CATDESC: CoDICE-Hi azimuth
-    FIELDNAM: azimuth
-    LABLAXIS: azimuth
+codice_hi_h_elevation:
+    CATDESC: CoDICE-Hi elevation
+    FIELDNAM: codice_hi_h_elevation
+    LABLAXIS: codice_hi_h_elevation
     FORMAT: I3
     VALIDMIN: 0
     VALIDMAX: 4
     VAR_TYPE: metadata
     UNITS: " "
 
-spin_angle_bin:
-    CATDESC: CoDICE-Hi spin_angle_bin
-    FIELDNAM: spin_angle_bin
-    LABLAXIS: spin_angle_bin
+codice_hi_h_spin_angle:
+    CATDESC: CoDICE-Hi spin_angle
+    FIELDNAM: codice_hi_h_spin_angle
+    LABLAXIS: codice_hi_h_spin_angle
     FORMAT: I3
     VALIDMIN: 0
     VALIDMAX: 4
@@ -113,7 +121,7 @@ default_float64_attrs: &default_float64
   VALIDMAX: 1.7976931348623157e+308
   dtype: float64
 
-codicehi_h:
+codice_hi_h:
   <<: *default_float32
   CATDESC: H intensities in 15 energy ranges and binned into 4 azimuths and 4 spin angle bins
   FIELDNAM: H intensities
@@ -121,11 +129,11 @@ codicehi_h:
   UNITS: "# / cm2-sr-s- MeV"
   VALIDMIN: 0
   VALIDMAX: 100000000.0
-  DEPEND_1: energy_ranges
-  DEPEND_2: azimuth
-  DEPEND_3: spin_angle_bin
+  DEPEND_1: codice_hi_h_energy_ranges
+  DEPEND_2: codice_hi_h_elevation
+  DEPEND_3: codice_hi_h_spin_angle
 
-codicelo_c_over_o_abundance:
+codice_lo_c_over_o_abundance:
   <<: *default_float32
   CATDESC: C/O abundance ratio
   FIELDNAM: C/O
@@ -134,7 +142,7 @@ codicelo_c_over_o_abundance:
   VALIDMIN: 0
   VALIDMAX: 100000000.0
 
-codicelo_mg_over_o_abundance:
+codice_lo_mg_over_o_abundance:
   <<: *default_float32
   CATDESC: Mg/O abundance ratio
   FIELDNAM: Mg/O
@@ -143,7 +151,7 @@ codicelo_mg_over_o_abundance:
   VALIDMIN: 0
   VALIDMAX: 100000000.0
 
-codicelo_fe_over_o_abundance:
+codice_lo_fe_over_o_abundance:
   <<: *default_float32
   CATDESC: Fe/O abundance ratio
   FIELDNAM: Fe/O
@@ -152,7 +160,7 @@ codicelo_fe_over_o_abundance:
   VALIDMIN: 0
   VALIDMAX: 100000000.0
 
-codicelo_c_plus_6_over_c_plus_5_ratio:
+codice_lo_c_plus_6_over_c_plus_5_ratio:
   <<: *default_float32
   CATDESC: C+6/C+5 charge state ratio
   FIELDNAM: C+6/C+5
@@ -161,7 +169,7 @@ codicelo_c_plus_6_over_c_plus_5_ratio:
   VALIDMIN: 0
   VALIDMAX: 100000000.0
 
-codicelo_o_plus_7_over_o_plus_6_ratio:
+codice_lo_o_plus_7_over_o_plus_6_ratio:
   <<: *default_float32
   CATDESC: O+7/O+6 charge state ratio
   FIELDNAM: O+7/O+6
@@ -170,7 +178,7 @@ codicelo_o_plus_7_over_o_plus_6_ratio:
   VALIDMIN: 0
   VALIDMAX: 100000000.0
 
-codicelo_fe_low_over_fe_high_ratio:
+codice_lo_fe_low_over_fe_high_ratio:
   <<: *default_float32
   CATDESC: Fe low/Fe high charge state ratio
   FIELDNAM: Fe low/Fe high
@@ -256,43 +264,89 @@ hit_he_omni_high_en:
   LABLAXIS: hit_he_omni_high_en
   UNITS: counts
 
-mag_4s_b_gse:
+mag_epoch:
+  <<: *default_float32
+  CATDESC: MAG instrument epoch
+  FIELDNAM: mag_epoch
+  LABLAXIS: mag_epoch
+  UNITS: ns
+  VALIDMIN: 0.0
+  VALIDMAX: 9223372036854775807
+
+mag_B_GSE:
   <<: *default_float32
   CATDESC: Magnetic field vector in GSE coordinates
-  FIELDNAM: mag_4s_b_gse
-  LABLAXIS: mag_4s_b_gse
+  FIELDNAM: mag_B_GSE
+  LABL_PTR_1: component
   UNITS: nT
   DEPEND_1: component
+  VALIDMIN: -65000
+  VALIDMAX: 65000
 
-mag_4s_b_gsm:
+mag_B_GSM:
   <<: *default_float32
   CATDESC: Magnetic field vector in GSM coordinates
-  FIELDNAM: mag_4s_b_gsm
-  LABLAXIS: mag_4s_b_gsm
+  FIELDNAM: mag_B_GSM
+  LABL_PTR_1: component
   UNITS: nT
   DEPEND_1: component
+  VALIDMIN: -65000
+  VALIDMAX: 65000
 
-mag_4s_b_rtn:
+mag_B_RTN:
   <<: *default_float32
   CATDESC: Magnetic field vector in RTN coordinates
-  FIELDNAM: mag_4s_b_rtn
-  LABLAXIS: mag_4s_b_rtn
+  FIELDNAM: mag_B_RTN
+  LABL_PTR_1: RTN_component
   UNITS: nT
-  DEPEND_1: component
+  DEPEND_1: RTN_component
+  VALIDMIN: -65000
+  VALIDMAX: 65000
 
-mag_phi_4s_b_gsm:
+mag_B_magnitude:
+  <<: *default_float32
+  CATDESC: Magnitude of the magnetic field vector
+  FIELDNAM: mag_B_magnitude
+  LABLAXIS: "|B|"
+  UNITS: nT
+  VALIDMIN: 0
+  VALIDMAX: 65000
+
+mag_phi_B_GSM:
   <<: *default_float32
   CATDESC: Azimuth angle (φ) of the magnetic field in GSM coordinates
-  FIELDNAM: mag_phi_4s_b_gsm
-  LABLAXIS: mag_phi_4s_b_gsm
+  FIELDNAM: mag_phi_B_GSM
+  LABLAXIS: mag_phi_B_GSM
   UNITS: degrees
+  VALIDMIN: 0
+  VALIDMAX: 360
 
-mag_theta_4s_b_gsm:
+mag_theta_B_GSM:
   <<: *default_float32
   CATDESC: Elevation angle (θ) of the magnetic field in GSM coordinates
-  FIELDNAM: mag_theta_4s_b_gsm
-  LABLAXIS: mag_theta_4s_b_gsm
+  FIELDNAM: mag_theta_B_GSM
+  LABLAXIS: mag_theta_B_GSM
   UNITS: degrees
+  VALIDMIN: -90
+  VALIDMAX: 90
+
+mag_phi_B_GSE:
+  <<: *default_float32
+  CATDESC: Azimuth angle (φ) of the magnetic field in GSE coordinates
+  FIELDNAM: mag_phi_B_GSE
+  LABLAXIS: mag_phi_B_GSE
+  UNITS: degrees
+  VALIDMIN: 0
+  VALIDMAX: 360
+
+mag_theta_B_GSE:
+  <<: *default_float32
+  CATDESC: Elevation angle (θ) of the magnetic field in GSE coordinates
+  FIELDNAM: mag_theta_B_GSE
+  LABLAXIS: mag_theta_B_GSE
+  UNITS: degrees
+  VALIDMIN: -90
+  VALIDMAX: 90
 
 swapi_pseudo_proton_density:
   <<: *default_float32
@@ -321,23 +375,12 @@ swapi_pseudo_proton_temperature:
   VALIDMIN: 0.0
   VALIDMAX: 50000000.0
 
-# SWE Normalized Counts, First Half Cycle
-swe_normalized_counts_half_1:
-  <<: *default_uint32
-  CATDESC: Normalized electron counts (Half Cycle 1, ESA step 0)
-  FIELDNAM: swe_normalized_counts_half_1
-  LABLAXIS: swe_norm_cts_q1_esa0
-  UNITS: Normalized counts
-  VALIDMIN: 0
-  VALIDMAX: 500000
-  DEPEND_1: esa_step
-
-# SWE Normalized Counts, Second Half Cycle
-swe_normalized_counts_half_2:
+# SWE Normalized Counts
+swe_normalized_counts:
   <<: *default_uint32
-  CATDESC: Normalized electron counts (Half Cycle 2, ESA step 0)
-  FIELDNAM: swe_normalized_counts_half_2
-  LABLAXIS: swe_norm_cts_q2_esa0
+  CATDESC: Normalized electron counts
+  FIELDNAM: swe_normalized_counts
+  LABLAXIS: swe_normalized_counts
   UNITS: Normalized counts
   VALIDMIN: 0
   VALIDMAX: 500000

imap_processing/cdf/config/imap_idex_l2a_variable_attrs.yaml

@@ -28,7 +28,7 @@ impact_charge_base: &impact_charge_base
   DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Current>Qualifier:Derived # TODO quantity should be charge but there is no SPASE charge
 
 mass_estimate_base: &mass_estimate_base
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: *int_maxval
   VAR_TYPE: data
@@ -38,6 +38,17 @@ mass_estimate_base: &mass_estimate_base
   FILLVAL: *double_fillval
   DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Mass>Qualifier:Derived
 
+velocity_estimate_base: &velocity_estimate_base
+  UNITS: km/s
+  VALIDMIN: 0.0
+  VALIDMAX: *int_maxval
+  VAR_TYPE: data
+  DEPEND_0: epoch
+  DISPLAY_TYPE: time_series
+  FORMAT: F20.4
+  FILLVAL: *double_fillval
+  DICT_KEY: SPASE>Particle>ParticleType:Dust>ParticleQuantity:Velocity>Qualifier:Derived
+
 chi_square_base: &chi_square_base
   UNITS: " "
   VALIDMIN: 0.0
@@ -116,7 +127,7 @@ target_fit_parameter_index:
 mass_index:
   CATDESC: Mass index values from 1 to 500
   FIELDNAM: Mass Index
-  UNITS: amu
+  UNITS: Kg
   FORMAT: I4
   VAR_TYPE: support_data
   SCALETYP: linear
@@ -146,7 +157,7 @@ tof_snr:
 tof_peak_kappa:
   CATDESC: TOF High spectrum with x-axis converted from time to mass.
   FIELDNAM: Mass Scale
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: 1.0
   VAR_TYPE: data
@@ -208,7 +219,7 @@ tof_peak_reduced_chi_squared:
 mass_scale:
   CATDESC: TOF High spectrum with x-axis converted from time to mass.
   FIELDNAM: Mass Scale
-  UNITS: amu
+  UNITS: Kg
   VALIDMIN: 0.0
   VALIDMAX: *int_maxval
   FILLVAL: *double_fillval
@@ -239,6 +250,12 @@ target_low_dust_mass_estimate:
   CATDESC: Estimated dust mass from Target Low signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Target Low)
 
+target_low_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Target Low Velocity Estimate
+  CATDESC: Estimated particle velocity from Target Low signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Target Low)
+
 target_low_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Target Low Chi Square
@@ -275,6 +292,12 @@ target_high_dust_mass_estimate:
   CATDESC: Estimated dust mass from Target High signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Target High)
 
+target_high_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Target High Velocity Estimate
+  CATDESC: Estimated particle velocity from Target High signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Target High)
+
 target_high_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Target High Chi Square
@@ -311,6 +334,12 @@ ion_grid_dust_mass_estimate:
   CATDESC: Estimated dust mass from Ion Grid signal based on impact charge.
   FIELDNAM: Estimated Dust Mass (Ion Grid)
 
+ion_grid_velocity_estimate:
+  <<: *velocity_estimate_base
+  LABLAXIS: Ion Grid Velocity Estimate
+  CATDESC: Estimated particle velocity from Ion Grid signal based on impact charge.
+  FIELDNAM: Estimated Velocity (Ion Grid)
+
 ion_grid_chi_squared:
   <<: *chi_square_base
   LABLAXIS: Ion Grid Chi Square

imap_processing/cdf/config/imap_idex_l2b_variable_attrs.yaml

@@ -4,81 +4,81 @@ double_fillval: &double_fillval -1.0E31
 
 # Label attributes
 mass_labels:
-  CATDESC: Labels for mass bins
-  FIELDNAM: Mass Bin Labels
+  CATDESC: Labels for Mass (kg)
+  FIELDNAM: Mass (kg)
   VAR_TYPE: metadata
   FORMAT: A8
-  DEPEND_1: mass_bins
+  DEPEND_1: mass
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
 charge_labels:
-  CATDESC: Labels for impact charge bins
-  FIELDNAM: Impact Charge Bin Labels
+  CATDESC: Labels for Impact Charge (fC)
+  FIELDNAM: Impact Charge (fC)
   VAR_TYPE: metadata
   FORMAT: A8
-  DEPEND_1: impact_charge_bins
+  DEPEND_1: impact_charge
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
 spin_phase_labels:
-    CATDESC: Labels for spin phase bins
-    FIELDNAM: Spin Phase Bin Labels
-    VAR_TYPE: metadata
-    FORMAT: A8
-    DEPEND_1: spin_phase_bins
-    DICT_KEY: SPASE>Support>SupportQuantity:Other
+  CATDESC: Labels for Spin Phase (deg)
+  FIELDNAM: Spin Phase (deg)
+  VAR_TYPE: metadata
+  FORMAT: A8
+  DEPEND_1: spin_phase
+  DICT_KEY: SPASE>Support>SupportQuantity:Other
 
 # Index attributes
-mass_bins:
-  CATDESC: Log-spaced mass bins
-  FIELDNAM: Mass Bins
-  UNITS: " "
-  FORMAT: I4
+mass:
+  CATDESC: Log-spaced mass
+  FIELDNAM: Mass (kg)
+  UNITS: kg
+  FORMAT: E10.4
   VAR_TYPE: support_data
-  SCALETYP: linear
-  LABLAXIS: Mass Bins
-  VALIDMIN: 0
-  VALIDMAX: 10
-  FILLVAL: *int_fillval
+  SCALETYP: log
+  LABLAXIS: Mass (kg)
+  VALIDMIN: 0.0
+  VALIDMAX: 1.00e-14
+  FILLVAL: *double_fillval
   LABL_PTR_1: mass_labels
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
-spin_phase_bins:
+spin_phase:
     CATDESC: The spacecraft spin phase at the time of detection
     VAR_NOTES: This is given in 4 bins [315-45, 45-135, 135-225, 225-315] degrees.
-    FIELDNAM: Spin Phase Bins
-    LABLAXIS: Spin Phase Bins
+    FIELDNAM: Spin Phase (deg)
+    LABLAXIS: Spin Phase (deg)
     VAR_TYPE: support_data
     SCALETYP: linear
     FILLVAL: *int_fillval
     FORMAT: I4
-    VALIDMIN: 0
-    VALIDMAX: 3
+    VALIDMIN: 0.0
+    VALIDMAX: 360
     LABL_PTR_1: spin_phase_labels
-    UNITS: " "
+    UNITS: deg
     DICT_KEY: SPASE>SupportQuantity:SpinPhase,Qualifier:Array
 
-impact_charge_bins:
-    CATDESC: Log-spaced impact charge bins
-    VAR_NOTES: Impact Charge Bins
-    FIELDNAM: Impact Charge Bins
-    LABLAXIS: Impact Charge Bins
+impact_charge:
+    CATDESC: Log-spaced impact charge
+    FIELDNAM: Impact Charge (fC)
+    LABLAXIS: Impact Charge (fC)
     VAR_TYPE: support_data
-    SCALETYP: linear
+    SCALETYP: log
     FILLVAL: *int_fillval
-    FORMAT: I4
-    VALIDMIN: 0
-    VALIDMAX: 10
+    FORMAT: E10.3
+    VALIDMIN: 0.0
+    VALIDMAX: 1.00e04
     LABL_PTR_1: spin_phase_labels
-    UNITS: " "
+    UNITS: fC
     DICT_KEY: SPASE>Support>SupportQuantity:Other
 
+
 # Base attributes for charge and mass variables
 base_charge: &base_charge
     CATDESC: " "
     FIELDNAM: " "
     DEPEND_0: epoch
-    DEPEND_1: impact_charge_bins
-    DEPEND_2: spin_phase_bins
+    DEPEND_1: impact_charge
+    DEPEND_2: spin_phase
     LABL_PTR_1: charge_labels
     LABL_PTR_2: spin_phase_labels
     DISPLAY_TYPE: spectrogram
@@ -92,8 +92,8 @@ base_mass: &base_mass
     CATDESC: " "
     FIELDNAM: " "
     DEPEND_0: epoch
-    DEPEND_1: mass_bins
-    DEPEND_2: spin_phase_bins
+    DEPEND_1: mass
+    DEPEND_2: spin_phase
     LABL_PTR_1: mass_labels
     LABL_PTR_2: spin_phase_labels
     DISPLAY_TYPE: spectrogram
@@ -106,7 +106,7 @@ base_mass: &base_mass
 rate_by_charge:
     <<: *base_charge
     CATDESC: Count rate per day by impact charge and spin phase.
-    FIELDNAM: Rate by Charge
+    FIELDNAM: Rate (day^-1) by Charge
     UNITS: day^-1
     FILLVAL: *double_fillval
     DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
@@ -114,7 +114,7 @@ rate_by_charge:
 rate_by_mass:
     <<: *base_mass
     CATDESC: Count rate per day by mass and spin phase.
-    FIELDNAM: Rate by Mass
+    FIELDNAM: Rate (day^-1) by Mass
     UNITS: day^-1
     FILLVAL: *double_fillval
     DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array