imap-processing 1.0.32__tar.gz → 1.0.34__tar.gz

{imap_processing-1.0.32 → imap_processing-1.0.34}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: imap-processing
-Version: 1.0.32
+Version: 1.0.34
 Summary: IMAP Science Operations Center Processing
-License: MIT
+License-Expression: MIT
 License-File: LICENSE
 Keywords: IMAP,SDC,SOC,Science Operations
 Author: IMAP SDC Developers
@@ -10,7 +10,6 @@ Author-email: imap-sdc@lists.lasp.colorado.edu
 Requires-Python: >=3.10,<3.13
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -28,7 +27,7 @@ Provides-Extra: map-visualization
 Provides-Extra: test
 Provides-Extra: tools
 Requires-Dist: astropy-healpix (>=1.0)
-Requires-Dist: cdflib (>=1.3.6)
+Requires-Dist: cdflib (>=1.3.11)
 Requires-Dist: healpy (>=1.18.0,<2) ; extra == "map-visualization"
 Requires-Dist: imap-data-access (>=0.37.0)
 Requires-Dist: mypy (==1.10.1) ; extra == "dev"

{imap_processing-1.0.32 → imap_processing-1.0.34}/imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "1.0.32"
-__version_tuple__ = (1, 0, 32)
+__version__ = "1.0.34"
+__version_tuple__ = (1, 0, 34)

{imap_processing-1.0.32 → imap_processing-1.0.34}/imap_processing/cdf/config/imap_codice_l1a_variable_attrs.yaml

@@ -14,25 +14,25 @@ max_epoch: &max_epoch 3155630469184000000
 epoch_delta_minus:
     CATDESC: Time from acquisition start to acquisition center
     FIELDNAM: epoch_delta_minus
-    FILLVAL: *real_fillval
-    FORMAT: F30.9
+    FILLVAL: *int_fillval
+    FORMAT: I19
     LABLAXIS: epoch_delta_minus
     SCALETYP: linear
     UNITS: ns
-    VALIDMAX: *max_int
-    VALIDMIN: *min_int
+    VALIDMAX: 128000000000
+    VALIDMIN: 0
     VAR_TYPE: support_data
 
 epoch_delta_plus:
     CATDESC: Time from acquisition center to acquisition end
     FIELDNAM: epoch_delta_plus
-    FILLVAL: *real_fillval
-    FORMAT: F30.9
+    FILLVAL: *int_fillval
+    FORMAT: I19
     LABLAXIS: epoch_delta_plus
     SCALETYP: linear
     UNITS: ns
-    VALIDMAX: *max_epoch
-    VALIDMIN: *min_epoch
+    VALIDMAX: 128000000000
+    VALIDMIN: 0
     VAR_TYPE: support_data
 
 esa_step:
@@ -264,7 +264,7 @@ nso_half_spin:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the half spin when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 nso_spin_sector:
     CATDESC: Spin Sector When No Scan Operation (NSO) was activated
@@ -279,7 +279,7 @@ nso_spin_sector:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the spin sector when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 nso_esa_step:
     CATDESC: Energy Step When No Scan Operation (NSO) was activated
@@ -294,7 +294,7 @@ nso_esa_step:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the energy step when No Scan Operation (NSO) was activated. In NSO, the ESA voltage is set to the first step in the scan and remains fixed until the next cycle boundary.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 rgfo_half_spin:
     CATDESC: Half Spin When Reduced Gain Factor Operation (RGFO) was activated
@@ -309,7 +309,7 @@ rgfo_half_spin:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the half spin when Reduced Gain Factor Operation (RGFO) was activated. In RGFO, the Entrance ESA voltage is reduced in order to limit the number of ions that reach the detectors.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 rgfo_spin_sector:
     CATDESC: Spin Sector When Reduced Gain Factor Operation (RGFO) was activated
@@ -324,7 +324,7 @@ rgfo_spin_sector:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the spin sector when Reduced Gain Factor Operation (RGFO) was activated. In RGFO, the Entrance ESA voltage is reduced in order to limit the number of ions that reach the detectors.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 rgfo_esa_step:
     CATDESC: Energy Step When Reduced Gain Factor Operation (RGFO) was activated
@@ -339,7 +339,7 @@ rgfo_esa_step:
     VALIDMAX: 255
     VALIDMIN: 0
     VAR_NOTES: Indicates the energy step when Reduced Gain Factor Operation (RGFO) was activated. In RGFO, the Entrance ESA voltage is reduced in order to limit the number of ions that reach the detectors.
-    VAR_TYPE: data
+    VAR_TYPE: support_data
 
 spin_period:
     CATDESC: The spin period as reported by the spacecraft.

{imap_processing-1.0.32 → imap_processing-1.0.34}/imap_processing/cdf/config/imap_codice_l2-hi-direct-events_variable_attrs.yaml

@@ -5,17 +5,24 @@ min_int: &min_int -9223372036854775808
 max_int: &max_int 9223372036854775807
 
 # ------------------------------- Coordinates -------------------------------
+epoch:
+  DELTA_MINUS_VAR: epoch_delta_minus
+  DELTA_PLUS_VAR: epoch_delta_plus
+
 priority:
-  CATDESC: Priority Level
+  CATDESC: Direct-event telemetry priority level (0-5)
   DICT_KEY: SPASE>Support>SupportQuantity:Other
-  FIELDNAM: Priority Level
+  FIELDNAM: Event Priority Level
   FILLVAL: *uint8_fillval
   FORMAT: I1
   LABLAXIS: Priority
   SCALETYP: linear
   UNITS: " "
-  VALIDMAX: 7
+  VALIDMAX: 5
   VALIDMIN: 0
+  VAR_NOTES: >
+    Hi direct-event telemetry priority level. 0 = unused, 1 = DCR, 2 =
+    SSD-only, 3 = Protons, 4 = Helium, 5 = Heavies.
   VAR_TYPE: support_data
 
 event_num:
@@ -38,12 +45,12 @@ epoch_delta_minus:
   DISPLAY_TYPE: 'no_plot'
   FIELDNAM: epoch delta minus
   FILLVAL: -9223372036854775808
-  FORMAT: I18
+  FORMAT: I19
   LABLAXIS: Epoch Delta Minus
   SCALETYP: linear
   UNITS: ns
-  VALIDMAX: *max_int
-  VALIDMIN: *min_int
+  VALIDMAX: 128000000000
+  VALIDMIN: 0
   VAR_TYPE: support_data
 
 epoch_delta_plus:
@@ -53,12 +60,12 @@ epoch_delta_plus:
   DISPLAY_TYPE: 'no_plot'
   FIELDNAM: epoch delta plus
   FILLVAL: -9223372036854775808
-  FORMAT: I18
+  FORMAT: I19
   LABLAXIS: Epoch Delta Plus
   SCALETYP: linear
   UNITS: ns
-  VALIDMAX: *max_int
-  VALIDMIN: *min_int
+  VALIDMAX: 128000000000
+  VALIDMIN: 0
   VAR_TYPE: support_data
 
 # ------------------------------- Data Variables -------------------------------
@@ -67,10 +74,10 @@ num_events:
   DEPEND_0: epoch
   DEPEND_1: priority
   DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DISPLAY_TYPE: time_series
   FIELDNAM: Number of Events
   FILLVAL: *uint16_fillval
   FORMAT: I5
-  LABLAXIS: Number of Events
   LABL_PTR_1: priority_label
   SCALETYP: linear
   UNITS: " "
@@ -79,19 +86,24 @@ num_events:
   VAR_TYPE: data
 
 data_quality:
-  CATDESC: Data Quality Flag per Priority
+  CATDESC: Data Quality Flag per Priority (0=good, 1=suspect)
   DEPEND_0: epoch
   DEPEND_1: priority
   DICT_KEY: SPASE>Support>SupportQuantity:DataQuality
-  FIELDNAM: Data Quality
-  FILLVAL: *uint8_fillval
-  FORMAT: I3
-  LABLAXIS: Data Quality
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: Data Quality Flag
+  FILLVAL: *uint16_fillval
+  FORMAT: I5
   LABL_PTR_1: priority_label
   SCALETYP: linear
-  UNITS: " "
+  UNITS: 0=good
   VALIDMAX: 255
   VALIDMIN: 0
+  VAR_NOTES: >
+    Quality flag propagated from the packet-level suspect bit for each
+    direct-event priority bin. 0 = good packet group. 1 = suspect packet
+    group. 65535 = fill when no direct-event data are present for the priority
+    bin.
   VAR_TYPE: data
 
 energy_step:
@@ -100,10 +112,10 @@ energy_step:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DISPLAY_TYPE: no_plot
   FIELDNAM: Energy Step
   FILLVAL: *uint8_fillval
   FORMAT: I3
-  LABLAXIS: Energy Step
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -118,10 +130,10 @@ energy_per_charge:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:EnergyPerCharge
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: Energy per Charge
   FILLVAL: *real_fillval
   FORMAT: F12.4
-  LABLAXIS: Energy per Charge
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -136,10 +148,10 @@ gain:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DISPLAY_TYPE: no_plot
   FIELDNAM: Gain
   FILLVAL: *uint8_fillval
   FORMAT: I1
-  LABLAXIS: Gain
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -154,10 +166,10 @@ multi_flag:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:DataQuality
+  DISPLAY_TYPE: no_plot
   FIELDNAM: Multi Flag
   FILLVAL: *uint8_fillval
   FORMAT: I1
-  LABLAXIS: Multi Flag
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -167,21 +179,25 @@ multi_flag:
   VAR_TYPE: data
 
 type:
-  CATDESC: Event Type
+  CATDESC: "PHA type code: 0=TCR, 1=DCR, 2=SSD-only"
   DEPEND_0: epoch
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:Other
-  FIELDNAM: Type
+  DISPLAY_TYPE: no_plot
+  FIELDNAM: PHA Type Code
   FILLVAL: *uint8_fillval
   FORMAT: I1
-  LABLAXIS: Type
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
   UNITS: " "
-  VALIDMAX: 4
+  VALIDMAX: 2
   VALIDMIN: 0
+  VAR_NOTES: >
+    PHA type code for CoDICE-Hi direct events. 0 = TCR (Triple Coincidence
+    Rate; ST+SP+APD), 1 = DCR (Double Coincidence Rate; ST+SP), 2 = SSD-only
+    energy event (SSD only or ST+SSD only).
   VAR_TYPE: data
 
 tof:
@@ -190,10 +206,10 @@ tof:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:TimeOfFlight
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: Time of Flight
   FILLVAL: *real_fillval
   FORMAT: F12.4
-  LABLAXIS: TOF
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -226,6 +242,7 @@ spin_angle:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:ArrivalDirection,Qualifier:DirectionAngle.AzimuthAngle
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: Spin Angle
   FILLVAL: *real_fillval
   FORMAT: F8.2
@@ -243,10 +260,10 @@ elevation_angle:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:ArrivalDirection,Qualifier:DirectionAngle.ElevationAngle
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: Elevation Angle
   FILLVAL: *real_fillval
   FORMAT: F8.2
-  LABLAXIS: Elevation Angle
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -261,10 +278,10 @@ ssd_energy:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Particle>ParticleType:Ion,ParticleQuantity:Energy
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: SSD Energy
   FILLVAL: *real_fillval
   FORMAT: F12.4
-  LABLAXIS: SSD Energy
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -276,13 +293,13 @@ ssd_energy:
 energy_per_nuc:
   CATDESC: Energy per Nucleon
   DEPEND_0: epoch
-  DEPEND_1: priority_label
+  DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DISPLAY_TYPE: spectrogram
   FIELDNAM: Energy per Nucleon
   FILLVAL: *real_fillval
   FORMAT: F12.4
-  LABLAXIS: Energy per Nucleon
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear
@@ -297,10 +314,10 @@ ssd_id:
   DEPEND_1: priority
   DEPEND_2: event_num
   DICT_KEY: SPASE>Support>SupportQuantity:Other
+  DISPLAY_TYPE: no_plot
   FIELDNAM: SSD ID
   FILLVAL: *uint8_fillval
   FORMAT: I2
-  LABLAXIS: SSD ID
   LABL_PTR_1: priority_label
   LABL_PTR_2: event_num_label
   SCALETYP: linear