imap-processing 0.11.0__py3-none-any.whl → 0.13.0__py3-none-any.whl

imap_processing/__init__.py

@@ -19,16 +19,16 @@ from imap_processing._version import __version__, __version_tuple__  # noqa: F40
 # Eg. imap_module_directory = /usr/local/lib/python3.11/site-packages/imap_processing
 imap_module_directory = Path(__file__).parent
 
-# TODO: should we move this to imap-data-access?
 PROCESSING_LEVELS = {
-    "codice": ["l0", "l1a", "l1b", "l2"],
-    "glows": ["l0", "l1a", "l1b", "l2"],
-    "hi": ["l0", "l1a", "l1b", "l1c", "l2"],
-    "hit": ["l0", "l1a", "l1b", "l2"],
-    "idex": ["l0", "l1a", "l1b", "l2a", "l2b"],
-    "lo": ["l0", "l1a", "l1b", "l1c", "l2"],
-    "mag": ["l0", "l1a", "l1b", "l1c", "l2pre", "l2"],
-    "swapi": ["l0", "l1", "l2", "l3a", "l3b"],
-    "swe": ["l0", "l1a", "l1b", "l2"],
-    "ultra": ["l0", "l1a", "l1b", "l1c", "l2"],
+    "codice": ["l1a", "l1b", "l2"],
+    "glows": ["l1a", "l1b", "l2"],
+    "hi": ["l1a", "l1b", "l1c", "l2"],
+    "hit": ["l1a", "l1b", "l2"],
+    "idex": ["l1a", "l1b", "l2a", "l2b"],
+    "lo": ["l1a", "l1b", "l1c", "l2"],
+    "mag": ["l1a", "l1b", "l1c", "l1d", "l2"],
+    "spacecraft": ["l1a"],
+    "swapi": ["l1", "l2", "l3a", "l3b"],
+    "swe": ["l1a", "l1b", "l2"],
+    "ultra": ["l1a", "l1b", "l1c", "l2"],
 }

imap_processing/_version.py

@@ -1,3 +1,3 @@
 # These version placeholders will be replaced later during substitution.
-__version__ = "0.11.0"
-__version_tuple__ = (0, 11, 0)
+__version__ = "0.13.0"
+__version_tuple__ = (0, 13, 0)

imap_processing/ccsds/ccsds_data.py

@@ -47,6 +47,5 @@ class CcsdsData:
                 setattr(self, key, value)
             else:
                 raise KeyError(
-                    f"Did not find matching attribute in Histogram data class for "
-                    f"{key}"
+                    f"Did not find matching attribute in Histogram data class for {key}"
                 )

imap_processing/ccsds/excel_to_xtce.py

@@ -44,8 +44,7 @@ _CCSDS_PARAMETERS = [
     {
         "name": "SRC_SEQ_CTR",
         "lengthInBits": 14,
-        "description": "CCSDS Packet Sequence Count "
-        "(increments with each new packet)",
+        "description": "CCSDS Packet Sequence Count (increments with each new packet)",
     },
     {
         "name": "PKT_LEN",
@@ -352,21 +351,70 @@ class XTCEGenerator:
         conversion = analog_conversion.loc[
             (analog_conversion["mnemonic"] == row["mnemonic"])
             & (analog_conversion["packetName"] == row["packetName"])
-        ].iloc[0]
+        ]
+        name = f"{row['packetName']}.{row['mnemonic']}"
 
-        # Create the Conversion element
-        default_calibrator = Et.SubElement(encoding, "xtce:DefaultCalibrator")
-        polynomial_calibrator = Et.SubElement(
-            default_calibrator, "xtce:PolynomialCalibrator"
-        )
-        # FIXME: Use lowValue / highValue from the conversion sheet
-        # FIXME: Handle segmented polynomials (only using first segment now)
-        for i in range(8):
-            col = f"c{i}"
-            if conversion[col] != 0:
-                term = Et.SubElement(polynomial_calibrator, "xtce:Term")
-                term.attrib["coefficient"] = str(conversion[col])
-                term.attrib["exponent"] = str(i)
+        def add_poly_calibrator(segment: pd.Series, calibrator: Et.Element) -> None:
+            """
+            Add a polynomial calibrator to the input calibrator element.
+
+            Parameters
+            ----------
+            segment : pandas.Series
+                Row from the AnalogConversions sheet.
+            calibrator : Element
+                The calibrator element to add the polynomial to.
+            """
+            polynomial_calibrator = Et.SubElement(
+                calibrator, "xtce:PolynomialCalibrator"
+            )
+            for i in range(8):
+                col = f"c{i}"
+                if segment[col] != 0:
+                    term = Et.SubElement(polynomial_calibrator, "xtce:Term")
+                    term.attrib["coefficient"] = str(segment[col])
+                    term.attrib["exponent"] = str(i)
+
+        if len(conversion) == 1:
+            # Unsegmented Polynomial has a single calibrator
+            # NOTE: We don't add the low/high limits to unsegmented polynomials
+            #       because some instruments haven't defined these
+            calibrator = Et.SubElement(encoding, "xtce:DefaultCalibrator")
+            # There is only one segment, so no need to iterate here
+            segment = conversion.iloc[0]
+            add_poly_calibrator(segment, calibrator)
+        else:
+            # Segmented Polynomial has a list of calibrators
+            context_calibrator_list = Et.SubElement(
+                encoding, "xtce:ContextCalibratorList"
+            )
+            # One context calibrator for each segment
+            for _, segment in conversion.iterrows():
+                context_calibrator = Et.SubElement(
+                    context_calibrator_list, "xtce:ContextCalibrator"
+                )
+
+                # The matching criteria for this calibrator
+                # >= lowValue and <= highValue
+                context_match = Et.SubElement(context_calibrator, "xtce:ContextMatch")
+                comparison_list = Et.SubElement(context_match, "xtce:ComparisonList")
+                comparison = Et.SubElement(comparison_list, "xtce:Comparison")
+                comparison.attrib["comparisonOperator"] = ">="
+                comparison.attrib["value"] = str(int(segment["lowValue"]))
+                comparison.attrib["parameterRef"] = name
+                # This references the parameter name itself, so we use the uncalibrated
+                # value for comparison
+                comparison.attrib["useCalibratedValue"] = "false"
+                comparison = Et.SubElement(comparison_list, "xtce:Comparison")
+                comparison.attrib["comparisonOperator"] = "<="
+                comparison.attrib["value"] = str(int(segment["highValue"]))
+                comparison.attrib["parameterRef"] = name
+                comparison.attrib["useCalibratedValue"] = "false"
+
+                # The calibrator for this segment
+                # (used if the matching criteria are met)
+                calibrator = Et.SubElement(context_calibrator, "xtce:Calibrator")
+                add_poly_calibrator(segment, calibrator)
 
     def _add_state_conversion(self, row: pd.Series, parameter_type: Et.Element) -> None:
         """
@@ -394,8 +442,8 @@ class XTCEGenerator:
         for _, state_row in state_sheet.iterrows():
             enumeration = Et.SubElement(enumeration_list, "xtce:Enumeration")
             valid_state = self._ensure_state_value_is_int(state_row)
-            enumeration.attrib["value"] = str(valid_state["value"])
-            enumeration.attrib["label"] = str(valid_state["state"])
+            enumeration.attrib["value"] = str(valid_state["value"]).strip()
+            enumeration.attrib["label"] = str(valid_state["state"]).strip()
 
     def _ensure_state_value_is_int(self, state: dict) -> dict:
         """

imap_processing/cdf/config/imap_codice_global_cdf_attrs.yaml

@@ -16,105 +16,96 @@ instrument_base: &instrument_base
 # L1a
 imap_codice_l1a_hskp:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hskp->Level-1A Housekeeping Data
     Logical_source: imap_codice_l1a_hskp
     Logical_source_description: IMAP Mission CoDICE Instrument Level-1A Housekeeping Data.
 
 imap_codice_l1a_hi-counters-aggregated:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hi-counters-aggregated->Level-1A Hi Aggregated Instrument Counts Data
     Logical_source: imap_codice_l1a_hi-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Aggregated Instrument Counts Data.
 
 imap_codice_l1a_hi-counters-singles:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hi-counters-singles->Level-1A Hi Single Instrument Counts Data
     Logical_source: imap_codice_l1a_hi-counters-singles
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Single Instrument Counts Data.
 
 imap_codice_l1a_hi-omni:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hi-omni->Level-1A Hi Omnidirectional Data
     Logical_source: imap_codice_l1a_hi-omni
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Omnidirectional Data.
 
+imap_codice_l1a_hi-priority:
+    <<: *instrument_base
+    Data_type: L1A_hi-priority->Level-1A Hi Priority Data
+    Logical_source: imap_codice_l1a_hi-priority
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1A Priority Data.
+
 imap_codice_l1a_hi-sectored:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hi-sectored->Level-1A Hi Sectored Data
     Logical_source: imap_codice_l1a_hi-sectored
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Sectored Data.
 
 imap_codice_l1a_hi-pha:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_hi-pha->Level-1A Hi Event Data
     Logical_source: imap_codice_l1a_hi-pha
     Logical_source_description: IMAP Mission CoDICE Hi Level-1A Event Data.
 
 imap_codice_l1a_lo-counters-aggregated:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-counters-aggregated->Level-1A Lo Aggregated Instrument Counts Data
     Logical_source: imap_codice_l1a_lo-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Aggregated Instrument Counts Data.
 
 imap_codice_l1a_lo-counters-singles:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-counters-singles->Level-1A Lo Single Instrument Counts Data
     Logical_source: imap_codice_l1a_lo-counters-singles
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Single Instrument Counts Data.
 
 imap_codice_l1a_lo-sw-angular:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-sw-angular->Level-1A Lo Sunward Angular Counts Data
     Logical_source: imap_codice_l1a_lo-sw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Angular Counts Data.
 
 imap_codice_l1a_lo-nsw-angular:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-nsw-angular->Level-1A Lo Non-Sunward Angular Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Angular Counts Data.
 
 imap_codice_l1a_lo-sw-priority:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-sw-priority->Level-1A Lo Sunward Priority Counts Data
     Logical_source: imap_codice_l1a_lo-sw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Priority Counts Data.
 
 imap_codice_l1a_lo-nsw-priority:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-nsw-priority->Level-1A Lo Non-Sunward Priority Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Priority Counts Data.
 
 imap_codice_l1a_lo-sw-species:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-sw-species->Level-1A Lo Sunward Species Counts Data
     Logical_source: imap_codice_l1a_lo-sw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Sunward Species Counts Data.
 
 imap_codice_l1a_lo-nsw-species:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-nsw-species->Level-1A Lo Non-Sunward Species Counts Data
     Logical_source: imap_codice_l1a_lo-nsw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Non-Sunward Species Counts Data.
 
 imap_codice_l1a_lo-pha:
     <<: *instrument_base
-    Data_level: 1A
     Data_type: L1A_lo-pha->Level-1A Lo Event Data
     Logical_source: imap_codice_l1a_lo-pha
     Logical_source_description: IMAP Mission CoDICE Lo Level-1A Event Data.
@@ -122,91 +113,84 @@ imap_codice_l1a_lo-pha:
 # L1b
 imap_codice_l1b_hskp:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_hskp->Level-1B Housekeeping Data
     Logical_source: imap_codice_l1b_hskp
     Logical_source_description: IMAP Mission CoDICE Instrument Level-1B Housekeeping Data.
 
-imap_codice_l1b_hi_counters_aggregated:
+imap_codice_l1b_hi-counters-aggregated:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_hi-counters-aggregated->Level-1B Hi Aggregated Instrument Rates Data
     Logical_source: imap_codice_l1b_hi-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Hi Level-1B Aggregated Instrument Rates Data.
 
-imap_codice_l1b_hi_counters_singles:
+imap_codice_l1b_hi-counters-singles:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_hi-counters-singles->Level-1B Hi Single Instrument Rates Data
     Logical_source: imap_codice_l1b_hi-counters-singles
     Logical_source_description: IMAP Mission CoDICE Hi Level-1B Single Instrument Rates Data.
 
-imap_codice_l1b_hi_omni:
+imap_codice_l1b_hi-omni:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_hi-omni->Level-1B Hi Omnidirectional Data
     Logical_source: imap_codice_l1b_hi-omni
     Logical_source_description: IMAP Mission CoDICE Hi Level-1B Omnidirectional Data.
 
-imap_codice_l1b_hi_sectored:
+imap_codice_l1b_hi-priority:
+    <<: *instrument_base
+    Data_type: L1B_hi-priority->Level-1B Hi Priority Data
+    Logical_source: imap_codice_l1b_hi-priority
+    Logical_source_description: IMAP Mission CoDICE Hi Level-1B Priority Data.
+
+imap_codice_l1b_hi-sectored:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_hi-sectored->Level-1B Hi Sectored Data
     Logical_source: imap_codice_l1b_hi-sectored
     Logical_source_description: IMAP Mission CoDICE Hi Level-1B Sectored Data.
 
-imap_codice_l1b_lo_counters_aggregated:
+imap_codice_l1b_lo-counters-aggregated:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-counters-aggregated->Level-1B Lo Aggregated Instrument Rates Data
     Logical_source: imap_codice_l1b_lo-counters-aggregated
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Aggregated Instrument Rates Data.
 
-imap_codice_l1b_lo_counters_singles:
+imap_codice_l1b_lo-counters-singles:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-counters-aggregated->Level-1B Lo Single Instrument Rates Data
     Logical_source: imap_codice_l1b_lo-counters-singles
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Single Instrument Rates Data.
 
-imap_codice_l1b_lo_sw_angular:
+imap_codice_l1b_lo-sw-angular:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-sw-angular->Level-1B Lo Sunward Angular Rates Data
     Logical_source: imap_codice_l1b_lo-sw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Angular Rates Data.
 
-imap_codice_l1b_lo_nsw_angular:
+imap_codice_l1b_lo-nsw-angular:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-nsw-angular->Level-1B Lo Non-Sunward Angular Rates Data
     Logical_source: imap_codice_l1b_lo-nsw-angular
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Angular Rates Data.
 
-imap_codice_l1b_lo_sw_priority:
+imap_codice_l1b_lo-sw-priority:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-sw-priority->Level-1B Lo Sunward Priority Rates Data
     Logical_source: imap_codice_l1b_lo-sw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Priority Rates Data.
 
-imap_codice_l1b_lo_nsw_priority:
+imap_codice_l1b_lo-nsw-priority:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-nsw-priority->Level-1B Lo Non-Sunward Priority Rates Data
     Logical_source: imap_codice_l1b_lo-nsw-priority
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Priority Rates Data.
 
-imap_codice_l1b_lo_sw_species:
+imap_codice_l1b_lo-sw-species:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-sw-species->Level-1B Lo Sunward Species Rates Data
     Logical_source: imap_codice_l1b_lo-sw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Sunward Species Rates Data.
 
-imap_codice_l1b_lo_nsw_species:
+imap_codice_l1b_lo-nsw-species:
     <<: *instrument_base
-    Data_level: 1B
     Data_type: L1B_lo-nsw-species->Level-1B Lo Non-Sunward Species Rates Data
     Logical_source: imap_codice_l1b_lo-nsw-species
     Logical_source_description: IMAP Mission CoDICE Lo Level-1B Non-Sunward Species Rates Data.