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

imap_processing/codice/constants.py

@@ -214,17 +214,17 @@ HI_COUNTERS_AGGREGATED_ACTIVE_VARIABLES = {
     "spo": True,
     "reserved1": False,
     "mst": True,
-    "reserved2": False,
-    "reserved3": False,
+    "ssdo": True,
+    "stssd": True,
     "reserved4": False,
     "reserved5": False,
-    "low_tof_cutoff": False,
+    "low_tof_cutoff": True,
     "reserved6": False,
     "reserved7": False,
     "asic1_flag_invalid": True,
     "asic2_flag_invalid": True,
-    "asic1_channel_invalid": False,
-    "asic_2_channel_invalid": False,
+    "asic1_channel_invalid": True,
+    "asic2_channel_invalid": True,
 }
 HI_COUNTERS_AGGREGATED_VARIABLE_NAMES = [
     name
@@ -236,8 +236,9 @@ HI_COUNTERS_AGGREGATED_VARIABLE_NAMES = [
 REQUIRES_DESPINNING = [
     "imap_codice_l1a_lo-sw-angular",
     "imap_codice_l1a_lo-nsw-angular",
-    "imap_codice_l1a_lo-sw-priority",
-    "imap_codice_l1a_lo-nsw-priority",
+    # TBD if this requires despinning
+    # "imap_codice_l1a_lo-sw-priority",
+    # "imap_codice_l1a_lo-nsw-priority",
 ]
 
 # Energy tables for CoDICE-Hi data products. These values represent the edges
@@ -268,149 +269,158 @@ IALIRT_ENERGY_TABLE = {
 
 OMNI_ENERGY_TABLE = {
     "h": [
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
-        9.050966799,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
     ],
     "he3": [
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
     ],
     "he4": [
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
     ],
     "c": [
-        0.025,
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
-        9.050966799,
-        12.8,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
+        5.1200000000,
+        7.2407734394,
+        10.2400000000,
     ],
     "o": [
-        0.025,
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
-        9.050966799,
-        12.8,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
+        5.1200000000,
+        7.2407734394,
+        10.2400000000,
     ],
     "ne_mg_si": [
-        0.01767767,
-        0.025,
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
     ],
     "fe": [
-        0.01767767,
-        0.025,
-        0.035355339,
-        0.05,
-        0.070710678,
-        0.1,
-        0.141421356,
-        0.2,
-        0.282842712,
-        0.4,
-        0.565685425,
-        0.8,
-        1.13137085,
-        1.6,
-        2.2627417,
-        3.2,
-        4.5254834,
-        6.4,
-        9.050966799,
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
+        0.1600000000,
+        0.2262741700,
+        0.3200000000,
+        0.4525483400,
+        0.6400000000,
+        0.9050966799,
+        1.2800000000,
+        1.8101933598,
+        2.5600000000,
+        3.6203867197,
+        5.1200000000,
+        7.2407734394,
+        10.2400000000,
+    ],
+    "uh": [
+        0.0200000000,
+        0.0282842712,
+        0.0400000000,
+        0.0565685425,
+        0.0800000000,
+        0.1131370850,
     ],
-    "uh": [0.01767767, 0.025, 0.035355339, 0.05, 0.070710678, 0.1],
-    "junk": [0.05, 0.070710678],
+    "junk": [0.0200000000, 0.0282842712],
 }
 
+# In the future, we get csv file with these column:
+# species, min_energy, max_energy, product (descriptor of the product)
 SECTORED_ENERGY_TABLE = {
-    "h": [0.05, 0.1, 0.2, 0.4, 0.8, 1.6, 3.2, 6.4, 12.8],
-    "he3he4": [0.025, 0.05, 0.1, 0.2, 0.4, 0.8, 1.6, 3.2, 6.4],
-    "cno": [0.025, 0.05, 0.1, 0.2, 0.4, 0.8, 1.6, 3.2, 6.4],
-    "fe": [0.0125, 0.025, 0.05, 0.1, 0.2, 0.4, 0.8, 1.6, 3.2],
+    "h": [0.020, 0.040, 0.080, 0.160, 0.320, 0.640, 1.280, 2.560, 5.120],
+    "he3he4": [0.020, 0.040, 0.080, 0.160, 0.320, 0.640, 1.280, 2.560, 5.120],
+    "cno": [0.020, 0.040, 0.080, 0.160, 0.320, 0.640, 1.280, 2.560, 5.120],
+    "fe": [0.020, 0.040, 0.080, 0.160, 0.320, 0.640, 1.280, 2.560, 5.120],
 }
 
 # Various configurations to support processing of individual data products
@@ -961,7 +971,11 @@ ESA_SWEEP_TABLE_ID_LOOKUP = {
 # use. Currently, LO Stepping table 0 is used for every plan_id/plan_step
 # combination, but may change in the future. These are defined in the "Lo
 # Stepping" tab of the "*-SCI-LUT-*.xml" spreadsheet that largely defines CoDICE
-# processing.
+# processing. Eg.
+#   (plan_id, plan_step) -> id of acquisition time
+#   (0, 0) -> 0
+
+
 LO_STEPPING_TABLE_ID_LOOKUP = {
     (0, 0): 0,
     (0, 1): 0,
@@ -2181,6 +2195,30 @@ ACQUISITION_TIMES = {
     ],
 }
 
+# These are for product that requires despinning in l1b.
+SW_INDEX_TO_POSITION = [1, 2, 3, 23, 24]
+NSW_INDEX_TO_POSITION = [
+    4,
+    5,
+    6,
+    7,
+    8,
+    9,
+    10,
+    11,
+    12,
+    13,
+    14,
+    15,
+    16,
+    17,
+    18,
+    19,
+    20,
+    21,
+    22,
+]
+
 # TODO: Update EFFICIENCY value when better information is available.
 # Constant for CoDICE Intensity calculations.
 EFFICIENCY = 1

imap_processing/ena_maps/ena_maps.py

@@ -1222,7 +1222,6 @@ class RectangularSkyMap(AbstractSkyMap):
         self,
         instrument: str,
         level: str,
-        frame: str,
         descriptor: str,
         sensor: str | None = None,
     ) -> xr.Dataset:
@@ -1235,8 +1234,6 @@ class RectangularSkyMap(AbstractSkyMap):
             Instrument name. "hi", "lo", "ultra".
         level : str
             Product level. "l2" or "l3".
-        frame : str
-            Map frame. "sf", "hf" or "hk".
         descriptor : str
             Descriptor for filename.
         sensor : str, optional
@@ -1318,16 +1315,14 @@ class RectangularSkyMap(AbstractSkyMap):
         )
 
         # Now set global attributes
-        map_attrs = cdf_attrs.get_global_attributes(
-            f"imap_{instrument}_{level}_enamap-{frame}"
-        )
+        map_attrs = cdf_attrs.get_global_attributes(f"imap_{instrument}_{level}_enamap")
         map_attrs["Spacing_degrees"] = str(self.spacing_deg)
         for key in ["Data_type", "Logical_source", "Logical_source_description"]:
             map_attrs[key] = map_attrs[key].format(
                 descriptor=descriptor,
                 sensor=sensor,
             )
-            # Always add the following attributes to the map
+        # Always add the following attributes to the map
         map_attrs.update(
             {
                 "Sky_tiling_type": self.tiling_type.value,
@@ -1336,25 +1331,28 @@ class RectangularSkyMap(AbstractSkyMap):
         )
         cdf_ds.attrs.update(map_attrs)
 
-        # Set the variable attributes
-        for var in [*cdf_ds.data_vars, *cdf_ds.coords]:
+        # Set the variable and coordinate attributes
+        for name, data_array in {**cdf_ds.data_vars, **cdf_ds.coords}.items():
             try:
-                # Don't check schema on label or delta variables
-                ignore_schema_substrings = ["_label", "_delta"]
-                check_schema = (
-                    False if any(s in var for s in ignore_schema_substrings) else True
-                )
+                # We only check the schema on data variables that include "epoch"
+                # in their list of dimensions (But not epoch itself).
+                check_schema = name != "epoch" and "epoch" in data_array.dims
                 var_attrs = cdf_attrs.get_variable_attributes(
-                    variable_name=var,
+                    variable_name=name,
                     check_schema=check_schema,
                 )
             except KeyError as e:
                 raise KeyError(
-                    f"Attributes for variable {var} not found in "
+                    f"Attributes for variable {name} not found in "
                     f"loaded variable attributes."
                 ) from e
 
-            cdf_ds[var].attrs.update(var_attrs)
+            cdf_ds[name].attrs.update(var_attrs)
+
+        # Manually adjust epoch attributes
+        cdf_ds["epoch"].attrs.update(
+            {"DELTA_PLUS_VAR": "epoch_delta", "BIN_LOCATION": 0}
+        )
 
         return cdf_ds
 

imap_processing/glows/l1b/glows_l1b.py

@@ -28,12 +28,12 @@ def glows_l1b(
     pipeline_settings_dataset: xr.Dataset,
 ) -> xr.Dataset:
     """
-    Will process the GLOWS L1B data and format the output datasets.
+    Will process the histogram GLOWS L1B data and format the output datasets.
 
     Parameters
     ----------
     input_dataset : xr.Dataset
-        Dataset of input values.
+        Dataset of input values for L1A histogram data.
     excluded_regions : xr.Dataset
         Dataset containing excluded sky regions with ecliptic coordinates. This
         is the output from GlowsAncillaryCombiner.
@@ -77,29 +77,37 @@ def glows_l1b(
     ) as f:
         ancillary_parameters = AncillaryParameters(json.loads(f.read()))
 
-    logical_source = (
-        input_dataset.attrs["Logical_source"][0]
-        if isinstance(input_dataset.attrs["Logical_source"], list)
-        else input_dataset.attrs["Logical_source"]
+    output_dataarrays = process_histogram(
+        input_dataset, ancillary_exclusions, ancillary_parameters, pipeline_settings
+    )
+    output_dataset = create_l1b_hist_output(
+        output_dataarrays, input_dataset["epoch"], input_dataset["bins"], cdf_attrs
     )
 
-    if "hist" in logical_source:
-        output_dataarrays = process_histogram(
-            input_dataset, ancillary_exclusions, ancillary_parameters, pipeline_settings
-        )
-        output_dataset = create_l1b_hist_output(
-            output_dataarrays, input_dataset["epoch"], input_dataset["bins"], cdf_attrs
-        )
+    return output_dataset
 
-    elif "de" in logical_source:
-        output_dataset = create_l1b_de_output(input_dataset, cdf_attrs)
 
-    else:
-        raise ValueError(
-            f"Logical_source {input_dataset.attrs['Logical_source']} for input file "
-            f"does not match histogram "
-            "('hist') or direct event ('de')."
-        )
+def glows_l1b_de(
+    input_dataset: xr.Dataset,
+) -> xr.Dataset:
+    """
+    Process GLOWS L1B direct events data.
+
+    Parameters
+    ----------
+    input_dataset : xr.Dataset
+        The input dataset to process.
+
+    Returns
+    -------
+    xr.Dataset
+        The processed L1B direct events dataset.
+    """
+    cdf_attrs = ImapCdfAttributes()
+    cdf_attrs.add_instrument_global_attrs("glows")
+    cdf_attrs.add_instrument_variable_attrs("glows", "l1b")
+
+    output_dataset = create_l1b_de_output(input_dataset, cdf_attrs)
 
     return output_dataset
 

imap_processing/hi/hi_l1a.py

@@ -57,23 +57,23 @@ TOTAL_COUNTERS = ("a_total", "b_total", "c_total", "fee_de_recd", "fee_de_sent")
 # This is a mapping of variable name to index when the dump_data in the
 # HVSCI MEMDMP packet is interpreted as an array of uint32 values.
 MEMDMP_DATA_INDS = {
-    "lastbin_shorten": 9,
+    "lastbin_shorten": 10,
     "coinc_length": 60,
     "de_timetag": 65,
-    "ab_min": 67,
-    "ab_max": 68,
-    "ac_min": 69,
-    "ac_max": 70,
-    "ba_min": 71,
-    "ba_max": 72,
-    "bc_min": 73,
-    "bc_max": 74,
-    "ca_min": 75,
-    "ca_max": 76,
-    "cb_min": 77,
-    "cb_max": 78,
-    "cc_min": 79,
-    "cc_max": 80,
+    "ab_max": 67,
+    "ab_min": 68,
+    "ac_max": 69,
+    "ac_min": 70,
+    "ba_max": 71,
+    "ba_min": 72,
+    "bc_max": 73,
+    "bc_min": 74,
+    "ca_max": 75,
+    "ca_min": 76,
+    "cb_max": 77,
+    "cb_min": 78,
+    "cc_max": 79,
+    "cc_min": 80,
     "cfd_dac_a": 82,
     "cfd_dac_b": 83,
     "cfd_dac_c": 84,
@@ -264,25 +264,40 @@ def create_de_dataset(de_data_dict: dict[str, npt.ArrayLike]) -> xr.Dataset:
         attrs=epoch_attrs,
     )
 
-    event_met_attrs = attr_mgr.get_variable_attributes(
-        "hi_de_event_met", check_schema=False
-    )
-    # For L1A DE, event_met is its own dimension, so we remove the DEPEND_0 attribute
-    _ = event_met_attrs.pop("DEPEND_0")
-
     # Compute the meta-event MET in seconds
     meta_event_met = (
         np.array(de_data_dict["esa_step_seconds"]).astype(np.float64)
         + np.array(de_data_dict["esa_step_milliseconds"]) * MILLISECOND_TO_S
     )
-    # Compute the MET of each event in seconds
-    # event MET = meta_event_met + de_clock
-    # See Hi Algorithm Document section 2.2.5
-    event_met_array = np.array(
-        meta_event_met[de_data_dict["ccsds_index"]]
-        + np.array(de_data_dict["de_tag"]) * DE_CLOCK_TICK_S,
-        dtype=event_met_attrs.pop("dtype"),
+
+    event_met_attrs = attr_mgr.get_variable_attributes(
+        "hi_de_event_met", check_schema=False
     )
+    # For L1A DE, event_met is its own dimension, so we remove the DEPEND_0 attribute
+    _ = event_met_attrs.pop("DEPEND_0")
+    event_met_dtype = event_met_attrs.pop("dtype")
+
+    # If there are no events, add a single event with fill values
+    if len(de_data_dict["de_tag"]) == 0:
+        logger.warning(
+            "No direct events found in SCIDE packets. "
+            "Creating a false DE entry with fill values."
+        )
+        for key in ["de_tag", "trigger_id", "tof_1", "tof_2", "tof_3", "ccsds_index"]:
+            attrs = attr_mgr.get_variable_attributes(f"hi_de_{key}", check_schema=False)
+            de_data_dict[key] = [attrs["FILLVAL"]]
+        event_met_array = np.array([event_met_attrs["FILLVAL"]], dtype=event_met_dtype)
+    else:
+        # Compute the MET of each event in seconds
+        # event MET = meta_event_met + de_clock
+        # See Hi Algorithm Document section 2.2.5
+        event_met_array = np.array(
+            meta_event_met[de_data_dict["ccsds_index"]]
+            + np.array(de_data_dict["de_tag"]) * DE_CLOCK_TICK_S,
+            dtype=event_met_dtype,
+        )
+
+    # Create the event_met coordinate
     event_met = xr.DataArray(
         event_met_array,
         name="event_met",
@@ -290,10 +305,12 @@ def create_de_dataset(de_data_dict: dict[str, npt.ArrayLike]) -> xr.Dataset:
         attrs=event_met_attrs,
     )
 
+    # Create a dataset with only coordinates
     dataset = xr.Dataset(
         coords={"epoch": epoch, "event_met": event_met},
     )
 
+    # Add variable to the dataset
     for var_name, data in de_data_dict.items():
         attrs = attr_mgr.get_variable_attributes(
             f"hi_de_{var_name}", check_schema=False
@@ -557,9 +574,12 @@ def finish_memdmp_dataset(input_ds: xr.Dataset) -> xr.Dataset:
         # offset index with a stride of the number of bytes in the dump
         # data divided by 4 (32-bit values).
         new_vars[new_var] = xr.DataArray(
-            data=full_uint32_data[offset::index_stride],
+            data=full_uint32_data[offset::index_stride].astype(np.uint32),
             dims=["epoch"],
         )
+        # Need to add one to de_timetag value
+        if new_var == "de_timetag":
+            new_vars[new_var].data += 1
 
     # Remove binary memory dump data and add parsed variables
     dataset = dataset.drop("dump_data")