imap-processing 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

imap_processing/cdf/config/imap_idex_l2a_variable_attrs.yaml

@@ -180,7 +180,7 @@ tof_peak_fit_parameters:
   LABL_PTR_2: peak_fit_parameter_labels
   VALIDMIN: 0
   VALIDMAX: *int_maxval
-  LABLAXIS: TOF Peak Fit Parameters
+  LABLAXIS: TOF Fit Parameters
   FORMAT: F20.6
   FILLVAL: *double_fillval
   DISPLAY_TYPE: no_plot
@@ -205,14 +205,16 @@ tof_peak_area_under_fit:
 tof_peak_chi_squared:
   <<: *chi_square_base
   DEPEND_1: mass_index
-  LABL_PTR_1: mass_labels
+  DISPLAY_TYPE: spectrogram
+  LABLAXIS: Chi Square (TOF)
   CATDESC: Chi squared value for the TOF peak emg fits.
-  FIELDNAM: Chi Square (TOF peak fits))
+  FIELDNAM: Chi Square (TOF peak fits)
 
 tof_peak_reduced_chi_squared:
   <<: *chi_square_base
   DEPEND_1: mass_index
-  LABL_PTR_1: mass_labels
+  DISPLAY_TYPE: spectrogram
+  LABLAXIS: Red Chi Square (TOF)
   CATDESC: Reduced chi squared value for the TOF peak emg fits.
   FIELDNAM: Reduced Chi Square (TOF peak fits)
 
@@ -240,37 +242,37 @@ target_low_fit_parameters:
 
 target_low_impact_charge:
   <<: *impact_charge_base
-  LABLAXIS: Target Low Impact Charge
-  CATDESC: Total charge from the dust impact on Target Low channel derived from the fitted curve.
+  LABLAXIS: TL Impact Charge
+  CATDESC: Total charge from the dust impact on Target Low (TL) channel derived from the fitted curve.
   FIELDNAM: Target Low Impact Charge
 
 target_low_dust_mass_estimate:
   <<: *mass_estimate_base
-  LABLAXIS: Target Low Dust Mass Estimate
+  LABLAXIS: TL Dust Mass Est
   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
+  LABLAXIS: TL Velocity Est
   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
+  LABLAXIS: TL Chi Square
   CATDESC: Chi squared value for the Target Low signal fit.
   FIELDNAM: Chi Square (Target Low)
 
 target_low_reduced_chi_squared:
   <<: *chi_square_base
-  LABLAXIS: Target Low Reduced Chi Square
+  LABLAXIS: TL Red Chi Square
   CATDESC: Reduced chi squared value for the Target Low signal fit.
   FIELDNAM: Reduced Chi Square (Target Low)
 
 target_low_fit_results:
   <<: *fit_results_base
-  LABLAXIS: Target Low Fit Results
+  LABLAXIS: TL Fit Results
   CATDESC: Values of Target Low signal fit evaluated at each time point.
   FIELDNAM: Target Low Fit results
 
@@ -282,37 +284,37 @@ target_high_fit_parameters:
 
 target_high_impact_charge:
   <<: *impact_charge_base
-  LABLAXIS: Target High Impact Charge
-  CATDESC: Charge from the dust impact on Target High derived from the fitted curve.
+  LABLAXIS: TH Impact Charge
+  CATDESC: Charge from the dust impact on Target High (TH) derived from the fitted curve.
   FIELDNAM: Target High Impact Charge
 
 target_high_dust_mass_estimate:
   <<: *mass_estimate_base
-  LABLAXIS: Target High Dust Mass Estimate
+  LABLAXIS: TH Dust Mass Est
   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
+  LABLAXIS: TH Velocity Est
   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
+  LABLAXIS: TH Chi Square
   CATDESC: Chi squared value for the Target High signal fit.
   FIELDNAM: Chi Square (Target High)
 
 target_high_reduced_chi_squared:
   <<: *chi_square_base
-  LABLAXIS: Target High Reduced Chi Square
+  LABLAXIS: TH Red Chi Square
   CATDESC: Reduced chi squared value for the Target Low signal fit.
   FIELDNAM: Reduced Chi Square (Target High)
 
 target_high_fit_results:
   <<: *fit_results_base
-  LABLAXIS: Target High Fit Results
+  LABLAXIS: TH Fit Results
   CATDESC: Values of Target High signal fit evaluated at each time point.
   FIELDNAM: Target High Fit Results
 
@@ -324,36 +326,36 @@ ion_grid_fit_parameters:
 
 ion_grid_impact_charge:
   <<: *impact_charge_base
-  LABLAXIS: Ion Grid Impact Charge
-  CATDESC: Charge from the dust impact on Ion Grid channel derived from the fitted curve.
+  LABLAXIS: IG Impact Charge
+  CATDESC: Charge from the dust impact on Ion Grid (IG) channel derived from the fitted curve.
   FIELDNAM: Ion Grid Impact Charge
 
 ion_grid_dust_mass_estimate:
   <<: *mass_estimate_base
-  LABLAXIS: Ion Grid Dust Mass Estimate
+  LABLAXIS: IG Dust Mass Est
   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
+  LABLAXIS: IG Velocity Est
   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
+  LABLAXIS: IG Chi Square
   CATDESC: Chi squared value for the Ion Grid signal fit.
   FIELDNAM: Chi Square (Ion Grid)
 
 ion_grid_reduced_chi_squared:
   <<: *chi_square_base
-  LABLAXIS: Ion Grid Reduced Chi Square
+  LABLAXIS: IG Red Chi Square
   CATDESC: Reduced chi squared value for the Ion Grid signal fit.
   FIELDNAM: Reduced Chi Square (Ion Grid)
 
 ion_grid_fit_results:
   <<: *fit_results_base
-  LABLAXIS: Ion Grid Fit Results
+  LABLAXIS: IG Fit Results
   CATDESC: Values of Ion Grid signal fit evaluated at each time point.
   FIELDNAM: Ion Grid Fit Results

imap_processing/cdf/config/imap_idex_l2b_variable_attrs.yaml

@@ -4,8 +4,8 @@ double_fillval: &double_fillval -1.0E31
 
 # Label attributes
 mass_labels:
-  CATDESC: Labels for Mass (kg)
-  FIELDNAM: Mass (kg)
+  CATDESC: Labels for Mass
+  FIELDNAM: Mass
   VAR_TYPE: metadata
   FORMAT: A8
   DEPEND_1: mass
@@ -30,23 +30,23 @@ spin_phase_labels:
 # Index attributes
 mass:
   CATDESC: Log-spaced mass
-  FIELDNAM: Mass (kg)
+  FIELDNAM: Mass
   UNITS: kg
   FORMAT: E10.4
   VAR_TYPE: support_data
   SCALETYP: log
-  LABLAXIS: Mass (kg)
+  LABLAXIS: Mass
   VALIDMIN: 0.0
   VALIDMAX: 1.00e-14
   FILLVAL: *double_fillval
   LABL_PTR_1: mass_labels
-  DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:Mass
 
 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 (deg)
-    LABLAXIS: Spin Phase (deg)
+    FIELDNAM: Spin Phase
+    LABLAXIS: Spin Phase
     VAR_TYPE: support_data
     SCALETYP: linear
     FILLVAL: *int_fillval
@@ -55,12 +55,12 @@ spin_phase:
     VALIDMAX: 360
     LABL_PTR_1: spin_phase_labels
     UNITS: deg
-    DICT_KEY: SPASE>SupportQuantity:SpinPhase,Qualifier:Array
+    DICT_KEY: SPASE>Support>SupportQuantity:SpinPhase,Qualifier:Array
 
 impact_charge:
     CATDESC: Log-spaced impact charge
-    FIELDNAM: Impact Charge (fC)
-    LABLAXIS: Impact Charge (fC)
+    FIELDNAM: Impact Charge
+    LABLAXIS: Impact Charge
     VAR_TYPE: support_data
     SCALETYP: log
     FILLVAL: *int_fillval
@@ -106,18 +106,18 @@ base_mass: &base_mass
 rate_by_charge:
     <<: *base_charge
     CATDESC: Count rate per day by impact charge and spin phase.
-    FIELDNAM: Rate (day^-1) by Charge
+    FIELDNAM: Rate by Charge
     UNITS: day^-1
     FILLVAL: *double_fillval
-    DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
+    DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:CountRate,Qualifier:Array
 
 rate_by_mass:
     <<: *base_mass
     CATDESC: Count rate per day by mass and spin phase.
-    FIELDNAM: Rate (day^-1) by Mass
+    FIELDNAM: Rate by Mass
     UNITS: day^-1
     FILLVAL: *double_fillval
-    DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
+    DICT_KEY: SPASE>Particle>ParticleType:Dust,ParticleQuantity:CountRate,Qualifier:Array
 
 counts_by_charge:
     <<: *base_charge
@@ -147,7 +147,7 @@ impact_day_of_year:
     VALIDMAX: 366
     VAR_TYPE: data
     UNITS: days
-    DICT_KEY: SPASE>SupportQuantity:Temporal,Qualifier:Array
+    DICT_KEY: SPASE>Support>SupportQuantity:Temporal
 
 rate_calculation_quality_flags:
   CATDESC: Quality flag for rate calculation (1 = good, 0 = insufficient IDEX uptime data)
@@ -161,4 +161,4 @@ rate_calculation_quality_flags:
   VALIDMAX: 1
   VAR_TYPE: data
   UNITS: " "
-  DICT_KEY: SPASE>SupportQuantity:QualityFlag,Qualifier:Array
+  DICT_KEY: SPASE>Support>SupportQuantity:QualityFlag

imap_processing/cdf/config/imap_idex_l2c_variable_attrs.yaml

@@ -90,7 +90,7 @@ rectangular_lat_pixel:
 rate_by_charge_map:
   <<: *base_charge_map
   CATDESC: Count rate per day by impact charge, longitude, and latitude.
-  FIELDNAM: Rate (day^-1) by Charge Map
+  FIELDNAM: Rate by Charge Map
   UNITS: day^-1
   FILLVAL: *double_fillval
   DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array
@@ -114,7 +114,7 @@ counts_by_mass_map:
 rate_by_mass_map:
   <<: *base_mass_map
   CATDESC: Count rate per day by mass, longitude, and latitude.
-  FIELDNAM: Rate (day^-1) by Mass Map
+  FIELDNAM: Rate by Mass Map
   UNITS: day^-1
   FILLVAL: *double_fillval
   DICT_KEY: SPASE>SupportQuantity:CountRate,Qualifier:Array

imap_processing/cdf/config/imap_swapi_variable_attrs.yaml

@@ -129,22 +129,11 @@ metadata_default: &metadata_default
   DICT_KEY: SPASE>Support>SupportQuantity:Other
 
 sci_start_time:
-  CATDESC: Start time of sweep
+  CATDESC: Start time of sweep in UTC
   DEPEND_0: epoch
   FIELDNAM: Science Start time
-  LABLAXIS: sci_start_time
-  FILLVAL: -9223372036854775808
-  FORMAT: " " # Supposedly not required, fails in xarray_to_cdf
-  VALIDMIN: -9223372036854775808
-  VALIDMAX: 9223372036854775807
-  UNITS: ns
+  FORMAT: " "
   VAR_TYPE: support_data
-  SCALETYP: linear
-  MONOTON: INCREASE
-  TIME_BASE: J2000
-  TIME_SCALE: Terrestrial Time
-  REFERENCE_POSITION: Rotating Earth Geoid
-  RESOLUTION: ' '
   DICT_KEY: "SPASE>Support>SupportQantity:Temporal"
 
 # Minimum attrs setting for HK data

imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml

@@ -172,6 +172,18 @@ shcoarse:
   # TODO: come back to format
   UNITS: seconds
 
+epoch_delta:
+  <<: *default
+  CATDESC: Number of nanoseconds in spacecraft pointing covered by this pointing set product
+  FIELDNAM: epoch delta
+  UNITS: ns
+  VAR_TYPE: support_data
+  DISPLAY_TYPE: no_plot
+  TIME_SCALE: Terrestrial Time
+  SCALE_TYPE: linear
+  FORMAT: I20
+  dtype: int64
+
 energy_bin_delta:
   <<: *default_float32
   CATDESC: Difference between the energy bin edges.

imap_processing/cdf/utils.py

@@ -29,7 +29,7 @@ def load_cdf(
 
     Parameters
     ----------
-    file_path : Path or ImapFilePath or str
+    file_path : pathlib.Path or ImapFilePath or str
         The path to the CDF file or ImapFilePath object.
     remove_xarray_attrs : bool
         Whether to remove the xarray attributes that get injected by the
@@ -98,7 +98,7 @@ def write_cdf(
 
     Returns
     -------
-    file_path : Path
+    file_path : pathlib.Path
         Path to the file created.
     """
     # Create the filename from the global attributes

imap_processing/cli.py

@@ -49,7 +49,7 @@ from imap_processing.cdf.utils import load_cdf, write_cdf
 #   from imap_processing import cdf
 # In code:
 #   call cdf.utils.write_cdf
-from imap_processing.codice import codice_l1a, codice_l1b, codice_l2
+from imap_processing.codice import codice_l1b, codice_l2, codice_new_l1a
 from imap_processing.glows.l1a.glows_l1a import glows_l1a
 from imap_processing.glows.l1b.glows_l1b import glows_l1b, glows_l1b_de
 from imap_processing.glows.l2.glows_l2 import glows_l2
@@ -612,14 +612,8 @@ class Codice(ProcessInstrument):
         datasets: list[xr.Dataset] = []
 
         if self.data_level == "l1a":
-            science_files = dependencies.get_file_paths(source="codice")
-            if len(science_files) != 1:
-                raise ValueError(
-                    f"CoDICE L1A requires exactly one input science file, received: "
-                    f"{science_files}."
-                )
             # process data
-            datasets = codice_l1a.process_codice_l1a(science_files[0])
+            datasets = codice_new_l1a.process_l1a(dependencies)
 
         if self.data_level == "l1b":
             science_files = dependencies.get_file_paths(source="codice")
@@ -1435,7 +1429,7 @@ class Ultra(ProcessInstrument):
                     f"Unexpected science_files found for ULTRA L1A:"
                     f"{science_files}. Expected only one dependency."
                 )
-            datasets = ultra_l1a.ultra_l1a(science_files[0])
+            datasets = ultra_l1a.ultra_l1a(science_files[0], create_derived_l1b=True)
         elif self.data_level == "l1b":
             science_files = dependencies.get_file_paths(source="ultra", data_type="l1a")
             l1a_dict = {
@@ -1472,13 +1466,7 @@ class Ultra(ProcessInstrument):
             ancillary_files = {}
             for path in anc_paths:
                 ancillary_files[path.stem.split("_")[2]] = path
-            spice_paths = dependencies.get_file_paths(data_type="spice")
-            # Only the helio pset needs IMAP frames
-            if any("imap_frames" in path.as_posix() for path in spice_paths):
-                imap_frames = True
-            else:
-                imap_frames = False
-            datasets = ultra_l1c.ultra_l1c(combined, ancillary_files, imap_frames)
+            datasets = ultra_l1c.ultra_l1c(combined, ancillary_files, self.descriptor)
         elif self.data_level == "l2":
             all_pset_filepaths = dependencies.get_file_paths(
                 source="ultra", descriptor="pset"