imap-processing 0.19.3__py3-none-any.whl → 0.19.4__py3-none-any.whl

imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "0.19.3"
-__version_tuple__ = (0, 19, 3)
+__version__ = "0.19.4"
+__version_tuple__ = (0, 19, 4)

imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml

@@ -413,16 +413,16 @@ hi-counters-aggregated-mst:
     FIELDNAM: Multi Start
     LABLAXIS: "events"
 
-hi-counters-aggregated-reserved2:
+hi-counters-aggregated-ssdo:
     <<: *events
-    CATDESC: Reserved 2
-    FIELDNAM: Reserved 2
+    CATDESC: Singles - Start
+    FIELDNAM: Singles - Start
     LABLAXIS: "events"
 
-hi-counters-aggregated-reserved3:
+hi-counters-aggregated-stssd:
     <<: *events
-    CATDESC: Reserved 3
-    FIELDNAM: Reserved 3
+    CATDESC: Singles - Stop
+    FIELDNAM: Singles - Stop
     LABLAXIS: "events"
 
 hi-counters-aggregated-reserved4:
@@ -1148,11 +1148,11 @@ lo-sw-angular-hplus:
     CATDESC: Sunward H+ Species
     FIELDNAM: SW - H+
     DEPEND_1: inst_az
-    DEPEND_2: spin_sector
-    DEPEND_3: esa_step
+    DEPEND_2: esa_step
+    DEPEND_3: spin_sector
     LABL_PTR_1: inst_az_label
-    LABL_PTR_2: spin_sector_label
-    LABL_PTR_3: esa_step_label
+    LABL_PTR_2: esa_step_label
+    LABL_PTR_3: spin_sector_label
 
 lo-sw-angular-heplusplus:
     <<: *counters
@@ -1268,152 +1268,151 @@ lo-sw-species-hplus:
     <<: *counters
     CATDESC: H+ Sunward Species
     FIELDNAM: SW - H+
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-heplusplus:
     <<: *counters
     CATDESC: He++ Sunward Species
     FIELDNAM: SW - He++
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-cplus4:
     <<: *counters
     CATDESC: C+4 Sunward Species
     FIELDNAM: SW - C+4
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-cplus5:
     <<: *counters
     CATDESC: C+5 Sunward Species
     FIELDNAM: SW - C+5
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-cplus6:
     <<: *counters
     CATDESC: C+6 Sunward Species
     FIELDNAM: SW - C+6
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-oplus5:
     <<: *counters
     CATDESC: O+5 Sunward Species
     FIELDNAM: SW - O+5
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-oplus6:
     <<: *counters
     CATDESC: O+6 Sunward Species
     FIELDNAM: SW - O+6
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-oplus7:
     <<: *counters
     CATDESC: O+7 Sunward Species
     FIELDNAM: SW - O+7
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-oplus8:
     <<: *counters
     CATDESC: O+8 Sunward Species
     FIELDNAM: SW - O+8
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-ne:
     <<: *counters
     CATDESC: Ne Sunward Species
     FIELDNAM: SW - Ne
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 lo-sw-species-mg:
     <<: *counters
     CATDESC: Mg Sunward Species
     FIELDNAM: SW - Mg
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-si:
     <<: *counters
     CATDESC: Si Sunward Species
     FIELDNAM: SW - Si
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
-
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 lo-sw-species-fe_loq:
     <<: *counters
     CATDESC: Fe lowQ Sunward Species
     FIELDNAM: SW - Fe lowQ
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-fe_hiq:
     <<: *counters
     CATDESC: Fe highQ Sunward Species
     FIELDNAM: SW - Fe highQ
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-heplus:
     <<: *counters
     CATDESC: He+ Pickup Ion Sunward Species
     FIELDNAM: SW - He+ (PUI)
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 lo-sw-species-cnoplus:
     <<: *counters
     CATDESC: CNO+ Pickup Ion Sunward Species
     FIELDNAM: SW - CNO+ (PUI)
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
-    LABL_PTR_1: spin_sector_label
-    LABL_PTR_2: esa_step_label
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
+    LABL_PTR_1: esa_step_label
+    LABL_PTR_2: spin_sector_label
 
 # lo-nsw-species
 lo-nsw-species-hplus:
     <<: *counters
     CATDESC: H+ Non-sunward Species
     FIELDNAM: NSW - H+
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1421,8 +1420,8 @@ lo-nsw-species-heplusplus:
     <<: *counters
     CATDESC: He++ Non-sunward Species
     FIELDNAM: NSW - He++
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1430,8 +1429,8 @@ lo-nsw-species-c:
     <<: *counters
     CATDESC: C Non-sunward Species
     FIELDNAM: NSW - C
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1439,8 +1438,8 @@ lo-nsw-species-o:
     <<: *counters
     CATDESC: O Non-sunward Species
     FIELDNAM: NSW - O
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1448,8 +1447,8 @@ lo-nsw-species-ne_si_mg:
     <<: *counters
     CATDESC: Ne-Si-Mg Non-sunward Species
     FIELDNAM: NSW - Ne_Si_Mg
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1457,8 +1456,8 @@ lo-nsw-species-fe:
     <<: *counters
     CATDESC: Fe Non-sunward Species
     FIELDNAM: NSW - Fe
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1466,8 +1465,8 @@ lo-nsw-species-heplus:
     <<: *counters
     CATDESC: He+ Non-sunward Species
     FIELDNAM: NSW - He+
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 
@@ -1475,8 +1474,8 @@ lo-nsw-species-cnoplus:
     <<: *counters
     CATDESC: CNO+ Non-sunward Species
     FIELDNAM: NSW - CNO+
-    DEPEND_1: spin_sector
-    DEPEND_2: esa_step
+    DEPEND_1: esa_step
+    DEPEND_2: spin_sector
     LABL_PTR_1: spin_sector_label
     LABL_PTR_2: esa_step_label
 

imap_processing/cdf/config/imap_codice_l1b_variable_attrs.yaml

@@ -411,16 +411,16 @@ hi-counters-aggregated-mst:
     FIELDNAM: Multi Start
     LABLAXIS: "events"
 
-hi-counters-aggregated-reserved2:
+hi-counters-aggregated-ssdo:
     <<: *events
-    CATDESC: Reserved 2
-    FIELDNAM: Reserved 2
+    CATDESC: Singles - Start
+    FIELDNAM: Singles - Start
     LABLAXIS: "events"
 
-hi-counters-aggregated-reserved3:
+hi-counters-aggregated-stssd:
     <<: *events
-    CATDESC: Reserved 3
-    FIELDNAM: Reserved 3
+    CATDESC: Singles - Stop
+    FIELDNAM: Singles - Stop
     LABLAXIS: "events"
 
 hi-counters-aggregated-reserved4:

imap_processing/cdf/config/imap_enamaps_l2-common_variable_attrs.yaml

@@ -163,7 +163,7 @@ ena_rate:
   DISPLAY_TYPE: image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:NumberFlux,Qualifier:Incident,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
-background_rates:
+bg_rate:
   <<: *default_float32
   CATDESC: Estimated background count rate.
   FIELDNAM: Background Rate
@@ -187,11 +187,10 @@ ena_count:
 
 sensitivity:
   <<: *default_float32
-  CATDESC: Calibration/sensitivity factor calculated from multiple pointing sets.
-  FIELDNAM: sensitivity
-  UNITS: cm^-3
-  DEPEND_0: epoch
-  VAR_TYPE: data
+  CATDESC: Averaged instrument sensitive area.
+  FIELDNAM: Sensitivity
+  UNITS: cm^2
+  VAR_TYPE: support_data
   LABLAXIS: sensitivity
   DISPLAY_TYPE: image
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:GeometricFactor,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
@@ -209,44 +208,40 @@ exposure_factor: &exposure_factor
 
 geometric_function:
   <<: *default_float32
-  CATDESC: The geometric function calculated from multiple pointing sets.
-  FIELDNAM: geometric_function
+  CATDESC: Averaged aperture area as seen by the backstop.
+  FIELDNAM: Geometric Function
   UNITS: cm^2 sr
-  DEPEND_0: epoch
-  VAR_TYPE: data
-  LABLAXIS: Geometric Factor
+  VAR_TYPE: support_data
+  LABLAXIS: Geometric Function
   DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:GeometricFactor,Qualifier:Directional,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 efficiency:
   <<: *default_float32
-  CATDESC: Event efficiency calculated from multiple pointing sets.
-  FIELDNAM: efficiency
+  CATDESC: Efficiency of the instrument in converting ENAs to valid events.
+  FIELDNAM: Efficiency
   UNITS: " "
-  DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: Efficiency
   DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:Other
 
 positional_uncert_theta:
   <<: *default_float32
-  CATDESC: Positional uncertainty in theta direction calculated from multiple pointing sets.
-  FIELDNAM: positional_uncertainty_theta
+  CATDESC: Averaged position uncertainty along the theta dimension of the instrument.
+  FIELDNAM: Positional Uncertainty Theta
   UNITS: degrees
-  DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: Position Uncertainty Theta
   DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:ArrivalDirection,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical
 
 positional_uncert_phi:
   <<: *default_float32
-  CATDESC: Positional uncertainty in phi direction calculated from multiple pointing sets.
-  FIELDNAM: positional_uncertainty_phi
+  CATDESC: Averaged position uncertainty along the phi dimension of the instrument.
+  FIELDNAM: Positional Uncertainty Phi
   UNITS: degrees
-  DEPEND_0: epoch
-  VAR_TYPE: data
+  VAR_TYPE: support_data
   LABLAXIS: Position Uncertainty Phi
   DISPLAY_TYPE: no_plot
   DICT_KEY: SPASE>Particle>ParticleType:Atom,ParticleQuantity:ArrivalDirection,Qualifier:Uncertainty,CoordinateSystemName:HAE,CoordinateRepresentation:Spherical

imap_processing/cdf/config/imap_hi_global_cdf_attrs.yaml

@@ -54,8 +54,7 @@ imap_hi_l1c_pset_attrs:
     Logical_source: imap_hi_l1c_{sensor}-pset
     Logical_source_description: IMAP-Hi Instrument Level-1C Pointing Set Data.
 
-# TODO: Finalize these global attributes
-imap_hi_l2_enamap-sf:
+imap_hi_l2_enamap:
     Data_type: L2_{descriptor}>Level-2 ENA Intensity Map for Hi{sensor}
     Logical_source: imap_hi_l2_{descriptor}
     Logical_source_description: IMAP-Hi Instrument Level-2 ENA Intensity Map Data for Hi{sensor} on rectangular tiling.

imap_processing/cdf/config/imap_hi_variable_attrs.yaml

@@ -252,6 +252,7 @@ hi_de_ccsds_index:
 # LABL_PTR_i expects VAR_TYPE of metadata with char data type
 hi_hist_angle_label:
   CATDESC: Angle bin centers for histogram data.
+  DEPEND_1: angle
   FIELDNAM: ANGLE
   FORMAT: A5
   VAR_TYPE: metadata

imap_processing/cdf/config/imap_ultra_l1c_variable_attrs.yaml

@@ -65,15 +65,15 @@ dead_time_ratio:
 
 sensitivity:
   <<: *energy_dependent
-  CATDESC: Calibration/sensitivity factor.
+  CATDESC: Averaged instrument sensitive area.
   FIELDNAM: sensitivity
   LABLAXIS: sensitivity
   # TODO: come back to format
-  UNITS: counts/second
+  UNITS: cm^2
 
 geometric_function:
   <<: *energy_dependent
-  CATDESC: The effective sensitive area as a function of theta and phi in instrument frame (energy independent).
+  CATDESC: Averaged aperture area as seen by the backstop.
   FIELDNAM: geometric_function
   LABLAXIS: Geometric Factor
   UNITS: cm^2
@@ -81,7 +81,7 @@ geometric_function:
 
 efficiency:
   <<: *energy_dependent
-  CATDESC: Estimated event efficiency for particles path through the instrument.
+  CATDESC: Efficiency of the instrument in converting ENAs to valid events.
   FIELDNAM: efficiency
   LABLAXIS: Efficiency
   UNITS: " "
@@ -90,6 +90,7 @@ efficiency:
 
 exposure_factor:
   <<: *energy_dependent
+  DEPEND_0: epoch
   CATDESC: Exposure time with the deadtime correction applied for a pointing.
   FIELDNAM: exposure_factor
   LABLAXIS: exposure factor
@@ -101,19 +102,20 @@ helio_exposure_factor:
   CATDESC: Exposure time with the deadtime correction applied for a pointing.
   FIELDNAM: exposure_factor
   LABLAXIS: exposure factor
+  DEPEND_0: epoch
   # TODO: come back to format
   UNITS: seconds
 
 scatter_theta:
   <<: *energy_dependent
-  CATDESC: Scattering theta values for a pointing.
+  CATDESC: Scattering theta values for a pointing (reported as gaussian uncertainty).
   FIELDNAM: scatter_theta
   LABLAXIS: scatter theta
   UNITS: degrees
 
 scatter_phi:
   <<: *energy_dependent
-  CATDESC: Scattering phi values for a pointing.
+  CATDESC: Scattering phi values for a pointing (reported as gaussian uncertainty).
   FIELDNAM: scatter_phi
   LABLAXIS: scatter phi
   UNITS: degrees

imap_processing/cdf/utils.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import datetime
 import logging
 import re
 import warnings
@@ -148,6 +149,10 @@ def write_cdf(
     dataset.attrs["Logical_file_id"] = file_path.stem
     # Add the processing version to the dataset attributes
     dataset.attrs["ground_software_version"] = imap_processing._version.__version__
+    dataset.attrs["Generation_date"] = datetime.datetime.now(
+        datetime.timezone.utc
+    ).strftime("%Y%m%d")
+    dataset.attrs["Generated_by"] = "IMAP Science Data Center"
 
     # Convert the xarray object to a CDF
     if "l1" in data_level: