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

imap_processing/hit/ancillary/imap_hit_l1b-to-l2-standard-dt3-factors_20250219_v002.csv

@@ -0,0 +1,205 @@
+Species,Lower Energy (MeV),Upper Energy (MeV),Delta E (MeV),Geometry Factor (cm2 sr),Efficiency,b
+H,1.8,2.2,0.4,0.034,1,0
+H,2.2,2.7,0.5,0.034,1,0
+H,2.7,3.2,0.5,0.034,1,0
+H,3.2,3.6,0.4,0.034,1,0
+H,3.6,4,0.4,0.035,1,0
+H,4,4.5,0.5,0.035,1,0
+H,4.5,5,0.5,0.035,1,0
+H,5,6,1,0.035,1,0
+H,6,8,2,0.035,1,0
+H,8,10,2,0.028,1,0
+H,10,12,2,0.011,1,0
+H,12,15,3,0.002,1,0
+He3,2.2,2.7,0.5,0.034,1,0
+He3,2.7,3.2,0.5,0.035,1,0
+He3,3.2,3.6,0.4,0.035,1,0
+He3,3.6,4,0.4,0.035,1,0
+He3,4,4.5,0.5,0.035,1,0
+He3,4.5,5,0.5,0.035,1,0
+He3,5,6,1,0.035,1,0
+He3,6,8,2,0.035,1,0
+He3,8,10,2,0.035,1,0
+He3,10,12,2,0.035,1,0
+He3,12,15,3,0.035,1,0
+He4,1.8,2.2,0.4,0.034,1,0
+He4,2.2,2.7,0.5,0.035,1,0
+He4,2.7,3.2,0.5,0.035,1,0
+He4,3.2,3.6,0.4,0.035,1,0
+He4,3.6,4,0.4,0.035,1,0
+He4,4,4.5,0.5,0.035,1,0
+He4,4.5,5,0.5,0.035,1,0
+He4,5,6,1,0.035,1,0
+He4,6,8,2,0.035,1,0
+He4,8,10,2,0.035,1,0
+He4,10,12,2,0.035,1,0
+He4,12,15,3,0.035,1,0
+He,2.2,2.7,0.5,0.035,1,0
+He,2.7,3.2,0.5,0.035,1,0
+He,3.2,3.6,0.4,0.035,1,0
+He,3.6,4,0.4,0.035,1,0
+He,4,4.5,0.5,0.035,1,0
+He,4.5,5,0.5,0.035,1,0
+He,5,6,1,0.035,1,0
+He,6,8,2,0.035,1,0
+He,8,10,2,0.035,1,0
+He,10,12,2,0.035,1,0
+He,12,15,3,0.035,1,0
+C,3.2,3.6,0.4,0.034,1,0
+C,3.6,4,0.4,0.034,1,0
+C,4,4.5,0.5,0.034,1,0
+C,4.5,5,0.5,0.035,1,0
+C,5,6,1,0.035,1,0
+C,6,8,2,0.035,1,0
+C,8,10,2,0.035,1,0
+C,10,12,2,0.035,1,0
+C,12,15,3,0.035,1,0
+C,15,21,6,0.035,1,0
+C,21,27,6,0.036,1,0
+C,27,33,6,0.039,1,0
+N,3.2,3.6,0.4,0.029,1,0
+N,3.6,4,0.4,0.034,1,0
+N,4,4.5,0.5,0.034,1,0
+N,4.5,5,0.5,0.035,1,0
+N,5,6,1,0.035,1,0
+N,6,8,2,0.035,1,0
+N,8,10,2,0.035,1,0
+N,10,12,2,0.035,1,0
+N,12,15,3,0.035,1,0
+N,15,21,6,0.035,1,0
+N,21,27,6,0.036,1,0
+N,27,33,6,0.037,1,0
+O,3.2,3.6,0.4,0.013,1,0
+O,3.6,4,0.4,0.034,1,0
+O,4,4.5,0.5,0.034,1,0
+O,4.5,5,0.5,0.035,1,0
+O,5,6,1,0.035,1,0
+O,6,8,2,0.035,1,0
+O,8,10,2,0.035,1,0
+O,10,12,2,0.035,1,0
+O,12,15,3,0.035,1,0
+O,15,21,6,0.035,1,0
+O,21,27,6,0.036,1,0
+O,27,33,6,0.036,1,0
+Ne,3.2,3.6,0.4,0,1,0
+Ne,3.6,4,0.4,0.018,1,0
+Ne,4,4.5,0.5,0.034,1,0
+Ne,4.5,5,0.5,0.034,1,0
+Ne,5,6,1,0.034,1,0
+Ne,6,8,2,0.035,1,0
+Ne,8,10,2,0.035,1,0
+Ne,10,12,2,0.035,1,0
+Ne,12,15,3,0.035,1,0
+Ne,15,21,6,0.035,1,0
+Ne,21,27,6,0.036,1,0
+Ne,27,33,6,0.036,1,0
+Ne,33,40,7,0.037,1,0
+Na,6,8,2,0.035,1,0
+Na,8,10,2,0.035,1,0
+Na,10,12,2,0.035,1,0
+Na,12,15,3,0.035,1,0
+Na,15,21,6,0.035,1,0
+Na,21,27,6,0.036,1,0
+Na,27,33,6,0.036,1,0
+Na,33,40,7,0.037,1,0
+Mg,3.2,3.6,0.4,0,1,0
+Mg,3.6,4,0.4,0,1,0
+Mg,4,4.5,0.5,0.027,1,0
+Mg,4.5,5,0.5,0.034,1,0
+Mg,5,6,1,0.034,1,0
+Mg,6,8,2,0.035,1,0
+Mg,8,10,2,0.035,1,0
+Mg,10,12,2,0.035,1,0
+Mg,12,15,3,0.035,1,0
+Mg,15,21,6,0.035,1,0
+Mg,21,27,6,0.036,1,0
+Mg,27,33,6,0.036,1,0
+Mg,33,40,7,0.036,1,0
+Mg,40,52,12,0.041,1,0
+Al,6,8,2,0.035,1,0
+Al,8,10,2,0.035,1,0
+Al,10,12,2,0.035,1,0
+Al,12,15,3,0.035,1,0
+Al,15,21,6,0.035,1,0
+Al,21,27,6,0.036,1,0
+Al,27,33,6,0.036,1,0
+Al,33,40,7,0.036,1,0
+Al,40,52,12,0.041,1,0
+Si,3.2,3.6,0.4,0,1,0
+Si,3.6,4,0.4,0,1,0
+Si,4,4.5,0.5,0.012,1,0
+Si,4.5,5,0.5,0.034,1,0
+Si,5,6,1,0.034,1,0
+Si,6,8,2,0.035,1,0
+Si,8,10,2,0.035,1,0
+Si,10,12,2,0.035,1,0
+Si,12,15,3,0.035,1,0
+Si,15,21,6,0.035,1,0
+Si,21,27,6,0.035,1,0
+Si,27,33,6,0.036,1,0
+Si,33,40,7,0.036,1,0
+Si,40,52,12,0.039,1,0
+S,3.6,4,0.4,0,1,0
+S,4,4.5,0.5,0.001,1,0
+S,4.5,5,0.5,0.03,1,0
+S,5,6,1,0.034,1,0
+S,6,8,2,0.035,1,0
+S,8,10,2,0.035,1,0
+S,10,12,2,0.035,1,0
+S,12,15,3,0.035,1,0
+S,15,21,6,0.035,1,0
+S,21,27,6,0.035,1,0
+S,27,33,6,0.036,1,0
+S,33,40,7,0.036,1,0
+S,40,52,12,0.038,1,0
+Ar,3.6,4,0.4,0,1,0
+Ar,4,4.5,0.5,0.01,1,0
+Ar,4.5,5,0.5,0.033,1,0
+Ar,5,6,1,0.034,1,0
+Ar,6,8,2,0.035,1,0
+Ar,8,10,2,0.035,1,0
+Ar,10,12,2,0.035,1,0
+Ar,12,15,3,0.035,1,0
+Ar,15,21,6,0.035,1,0
+Ar,21,27,6,0.035,1,0
+Ar,27,33,6,0.036,1,0
+Ar,33,40,7,0.036,1,0
+Ar,40,52,12,0.038,1,0
+Ca,3.6,4,0.4,0,1,0
+Ca,4,4.5,0.5,0,1,0
+Ca,4.5,5,0.5,0.01,1,0
+Ca,5,6,1,0.034,1,0
+Ca,6,8,2,0.035,1,0
+Ca,8,10,2,0.035,1,0
+Ca,10,12,2,0.035,1,0
+Ca,12,15,3,0.035,1,0
+Ca,15,21,6,0.035,1,0
+Ca,21,27,6,0.035,1,0
+Ca,27,33,6,0.036,1,0
+Ca,33,40,7,0.036,1,0
+Ca,40,52,12,0.037,1,0
+Fe,2.7,3.2,0.5,0,1,0
+Fe,3.2,3.6,0.4,0,1,0
+Fe,3.6,4,0.4,0,1,0
+Fe,4,4.5,0.5,0,1,0
+Fe,4.5,5,0.5,0.004,1,0
+Fe,5,6,1,0.033,1,0
+Fe,6,8,2,0.035,1,0
+Fe,8,10,2,0.035,1,0
+Fe,10,12,2,0.035,1,0
+Fe,12,15,3,0.035,1,0
+Fe,15,21,6,0.035,1,0
+Fe,21,27,6,0.035,1,0
+Fe,27,33,6,0.036,1,0
+Fe,33,40,7,0.036,1,0
+Fe,40,52,12,0.036,1,0
+Fe,52,70,18,0.04,1,0
+Ni,8,10,2,0.035,1,0
+Ni,10,12,2,0.035,1,0
+Ni,12,15,3,0.035,1,0
+Ni,15,21,6,0.035,1,0
+Ni,21,27,6,0.035,1,0
+Ni,27,33,6,0.036,1,0
+Ni,33,40,7,0.036,1,0
+Ni,40,52,12,0.036,1,0
+Ni,52,70,18,0.039,1,0

imap_processing/hit/ancillary/imap_hit_l1b-to-l2-summed-dt0-factors_20250219_v002.csv

@@ -0,0 +1,68 @@
+Species,Lower Energy (MeV),Upper Energy (MeV),Delta E (MeV),Geometry Factor (cm2 sr),Efficiency,b
+H,1.8,4,2.2,3.435,1,0
+H,4,6,2,3.465,1,0
+H,6,10,4,3.244,1,0
+H,10,15,5,0.673,1,0
+He3,4,6,2,3.461,1,0
+He3,6,10,4,3.488,1,0
+He3,10,15,5,3.524,1,0
+He4,1.8,4,2.2,3.454,1,0
+He4,4,6,2,3.473,1,0
+He4,6,10,4,3.495,1,0
+He4,10,15,5,3.53,1,0
+He,4,6,2,3.473,1,0
+He,6,10,4,3.495,1,0
+He,10,15,5,3.53,1,0
+C,4,6,2,3.458,1,0
+C,6,10,4,3.47,1,0
+C,10,15,5,3.491,1,0
+C,15,27,12,3.535,1,0
+N,4,6,2,3.453,1,0
+N,6,10,4,3.469,1,0
+N,10,15,5,3.497,1,0
+N,15,27,12,3.54,1,0
+O,4,6,2,3.452,1,0
+O,6,10,4,3.468,1,0
+O,10,15,5,3.487,1,0
+O,15,27,12,3.537,1,0
+Ne,4,6,2,3.437,1,0
+Ne,6,10,4,3.467,1,0
+Ne,10,15,5,3.483,1,0
+Ne,15,27,12,3.529,1,0
+Na,10,15,5,3.484,1,0
+Na,15,27,12,3.529,1,0
+Mg,4,6,2,3.167,1,0
+Mg,6,10,4,3.461,1,0
+Mg,10,15,5,3.488,1,0
+Mg,15,27,12,3.526,1,0
+Al,6,10,4,3.457,1,0
+Al,10,15,5,3.479,1,0
+Al,15,27,12,3.525,1,0
+Si,4,6,2,2.621,1,0
+Si,6,10,4,3.455,1,0
+Si,10,15,5,3.473,1,0
+Si,15,27,12,3.524,1,0
+Si,27,40,13,3.613,1,0
+S,4,6,2,2.157,1,0
+S,6,10,4,3.457,1,0
+S,10,15,5,3.481,1,0
+S,15,27,12,3.519,1,0
+S,27,40,13,3.607,1,0
+Ar,4,6,2,2.563,1,0
+Ar,6,10,4,3.464,1,0
+Ar,10,15,5,3.483,1,0
+Ar,15,27,12,3.521,1,0
+Ar,27,40,13,3.607,1,0
+Ca,4,6,2,1.522,1,0
+Ca,6,10,4,3.455,1,0
+Ca,10,15,5,3.474,1,0
+Ca,15,27,12,3.515,1,0
+Ca,27,40,13,3.601,1,0
+Fe,4,6,2,1.333,1,0
+Fe,6,10,4,3.454,1,0
+Fe,10,15,5,3.472,1,0
+Fe,15,27,12,3.506,1,0
+Fe,27,40,13,3.574,1,0
+Ni,10,15,5,3.474,1,0
+Ni,15,27,12,3.508,1,0
+Ni,27,40,13,3.576,1,0

imap_processing/hit/hit_utils.py

@@ -159,7 +159,6 @@ def process_housekeeping_data(
     # Drop keys that are not CDF data variables
     drop_keys = [
         "pkt_apid",
-        "sc_tick",
         "version",
         "type",
         "sec_hdr_flg",
@@ -219,3 +218,176 @@ def process_housekeeping_data(
     dataset.epoch.attrs = attr_mgr.get_variable_attributes("epoch")
 
     return dataset
+
+
+def initialize_particle_data_arrays(
+    dataset: xr.Dataset,
+    particle: str,
+    num_energy_ranges: int,
+    epoch_size: int,
+) -> xr.Dataset:
+    """
+    Create empty data arrays for a given particle.
+
+    Valid particle names:
+        h
+        he3
+        he4
+        he
+        c
+        n
+        o
+        ne
+        na
+        mg
+        al
+        si
+        s
+        ar
+        ca
+        fe
+        ni
+
+    Parameters
+    ----------
+    dataset : xr.Dataset
+        The dataset to add the data arrays to.
+
+    particle : str
+        The abbreviated particle name.
+
+    num_energy_ranges : int
+        Number of energy ranges for the particle.
+        Used to define the shape of the data arrays.
+
+    epoch_size : int
+        Used to define the shape of the data arrays.
+
+    Returns
+    -------
+    dataset : xr.Dataset
+        The dataset with the added empty data arrays.
+    """
+    dataset[f"{particle}"] = xr.DataArray(
+        data=np.zeros((epoch_size, num_energy_ranges), dtype=np.float32),
+        dims=["epoch", f"{particle}_energy_mean"],
+        name=f"{particle}",
+    )
+    dataset[f"{particle}_delta_minus"] = xr.DataArray(
+        data=np.zeros((epoch_size, num_energy_ranges), dtype=np.float32),
+        dims=["epoch", f"{particle}_energy_mean"],
+        name=f"{particle}_delta_minus",
+    )
+    dataset[f"{particle}_delta_plus"] = xr.DataArray(
+        data=np.zeros((epoch_size, num_energy_ranges), dtype=np.float32),
+        dims=["epoch", f"{particle}_energy_mean"],
+        name=f"{particle}_delta_plus",
+    )
+
+    dataset.coords[f"{particle}_energy_mean"] = xr.DataArray(
+        np.zeros(num_energy_ranges, dtype=np.int8),
+        dims=[f"{particle}_energy_mean"],
+        name=f"{particle}_energy_mean",
+    )
+    return dataset
+
+
+def sum_particle_data(
+    dataset: xr.Dataset, indices: dict
+) -> tuple[xr.DataArray, xr.DataArray, xr.DataArray]:
+    """
+    Sum particle data for a given energy range.
+
+    Parameters
+    ----------
+    dataset : xr.Dataset
+        A dataset containing particle data to sum in the l2fgrates, l3fgrates,
+        penfgrates data variables. If it's an L1A dataset, these variables
+        contain particle counts. If it's an L1B dataset, these variables
+        contain particle rates.
+
+    indices : dict
+        A dictionary containing the indices for particle data to sum for a given
+        energy range. The dictionary should have the following keys:
+            R2 = indices for l2fgrates
+            R3 = indices for l3fgrates
+            R4 = indices for penfgrates
+
+    Returns
+    -------
+    summed_data : xr.DataArray
+        The summed data for the given energy range.
+
+    summed_uncertainty_delta_minus : xr.DataArray
+        The summed data for delta minus statistical uncertainty.
+
+    summed_uncertainty_delta_plus : xr.DataArray
+        The summed data for delta plus statistical uncertainty.
+    """
+    summed_data = (
+        dataset["l2fgrates"][:, indices["R2"]].sum(axis=1)
+        + dataset["l3fgrates"][:, indices["R3"]].sum(axis=1)
+        + dataset["penfgrates"][:, indices["R4"]].sum(axis=1)
+    )
+
+    summed_uncertainty_delta_minus = (
+        dataset["l2fgrates_delta_minus"][:, indices["R2"]].sum(axis=1)
+        + dataset["l3fgrates_delta_minus"][:, indices["R3"]].sum(axis=1)
+        + dataset["penfgrates_delta_minus"][:, indices["R4"]].sum(axis=1)
+    )
+
+    summed_uncertainty_delta_plus = (
+        dataset["l2fgrates_delta_plus"][:, indices["R2"]].sum(axis=1)
+        + dataset["l3fgrates_delta_plus"][:, indices["R3"]].sum(axis=1)
+        + dataset["penfgrates_delta_plus"][:, indices["R4"]].sum(axis=1)
+    )
+
+    return summed_data, summed_uncertainty_delta_minus, summed_uncertainty_delta_plus
+
+
+def add_energy_variables(
+    dataset: xr.Dataset,
+    particle: str,
+    energy_min_values: np.ndarray,
+    energy_max_values: np.ndarray,
+) -> xr.Dataset:
+    """
+    Add energy min and max variables to the dataset.
+
+    Parameters
+    ----------
+    dataset : xr.Dataset
+        The dataset to add the energy variables to.
+    particle : str
+        The particle name.
+    energy_min_values : np.ndarray
+        The minimum energy values for each energy range.
+    energy_max_values : np.ndarray
+        The maximum energy values for each energy range.
+
+    Returns
+    -------
+    xr.Dataset
+        The dataset with the added energy variables.
+    """
+    energy_mean = np.mean(
+        np.array([energy_min_values, energy_max_values]), axis=0
+    ).astype(np.float32)
+
+    dataset[f"{particle}_energy_mean"] = xr.DataArray(
+        data=energy_mean,
+        dims=[f"{particle}_energy_mean"],
+        name=f"{particle}_energy_mean",
+    )
+    dataset[f"{particle}_energy_delta_minus"] = xr.DataArray(
+        data=np.array(energy_mean - np.array(energy_min_values), dtype=np.float32),
+        dims=[f"{particle}_energy_mean"],
+        name=f"{particle}_energy_delta_minus",
+    )
+    dataset[f"{particle}_energy_delta_plus"] = xr.DataArray(
+        data=np.array(energy_max_values - energy_mean, dtype=np.float32),
+        dims=[f"{particle}_energy_mean"],
+        name=f"{particle}_energy_delta_plus",
+    )
+
+    return dataset

imap_processing/hit/l0/constants.py

@@ -6,16 +6,16 @@ import numpy as np
 
 # energy_units: MeV/n
 MOD_10_MAPPING = {
-    0: {"species": "H", "energy_min": 1.8, "energy_max": 3.6},
-    1: {"species": "H", "energy_min": 4, "energy_max": 6},
-    2: {"species": "H", "energy_min": 6, "energy_max": 10},
-    3: {"species": "He4", "energy_min": 4, "energy_max": 6},
-    4: {"species": "He4", "energy_min": 6, "energy_max": 12},
-    5: {"species": "CNO", "energy_min": 4, "energy_max": 6},
-    6: {"species": "CNO", "energy_min": 6, "energy_max": 12},
-    7: {"species": "NeMgSi", "energy_min": 4, "energy_max": 6},
-    8: {"species": "NeMgSi", "energy_min": 6, "energy_max": 12},
-    9: {"species": "Fe", "energy_min": 4, "energy_max": 12},
+    0: {"species": "h", "energy_min": 1.8, "energy_max": 3.6},
+    1: {"species": "h", "energy_min": 4, "energy_max": 6},
+    2: {"species": "h", "energy_min": 6, "energy_max": 10},
+    3: {"species": "he4", "energy_min": 4, "energy_max": 6},
+    4: {"species": "he4", "energy_min": 6, "energy_max": 12},
+    5: {"species": "cno", "energy_min": 4, "energy_max": 6},
+    6: {"species": "cno", "energy_min": 6, "energy_max": 12},
+    7: {"species": "nemgsi", "energy_min": 4, "energy_max": 6},
+    8: {"species": "nemgsi", "energy_min": 6, "energy_max": 12},
+    9: {"species": "fe", "energy_min": 4, "energy_max": 12},
 }
 
 # Structure to hold binary details for a
@@ -100,7 +100,7 @@ COUNTS_DATA_STRUCTURE = {
     "penfgrates": HITPacking(16, 528, (33,)),  # range 4 foreground rates
     "penbgrates": HITPacking(16, 240, (15,)),  # range 4 background rates
     "ialirtrates": HITPacking(16, 320, (20,)),  # ialirt rates
-    "sectorates": HITPacking(16, 1920, (8, 15)),  # sectored rates
+    "sectorates": HITPacking(16, 1920, (15, 8)),  # sectored rates
     "l4fgrates": HITPacking(16, 768, (48,)),  # all range foreground rates
     "l4bgrates": HITPacking(16, 384, (24,)),  # all range foreground rates
 }
@@ -116,3 +116,12 @@ FRAME_SIZE = len(FLAG_PATTERN)
 # decompressing data
 MANTISSA_BITS = 12
 EXPONENT_BITS = 4
+
+# Define sectorate angles
+DECLINATION_ANGLES = np.array(
+    [11.25, 33.75, 56.25, 78.75, 101.25, 123.75, 146.25, 168.75], dtype=np.float32
+)
+AZIMUTH_ANGLES = np.array(
+    [12, 36, 60, 84, 108, 132, 156, 180, 204, 228, 252, 276, 300, 324, 348],
+    dtype=np.float32,
+)

imap_processing/hit/l0/decom_hit.py

@@ -4,7 +4,9 @@ import numpy as np
 import xarray as xr
 
 from imap_processing.hit.l0.constants import (
+    AZIMUTH_ANGLES,
     COUNTS_DATA_STRUCTURE,
+    DECLINATION_ANGLES,
     EXPONENT_BITS,
     FLAG_PATTERN,
     FRAME_SIZE,
@@ -90,9 +92,20 @@ def parse_count_rates(sci_dataset: xr.Dataset) -> None:
         # Get dims for data variables (yaml file not created yet)
         if len(field_meta.shape) > 1:
             if "sectorates" in field:
-                # Reshape data to 8x15 for declination and azimuth look directions
+                # Reshape data to 15x8 for azimuth and declination look directions
                 parsed_data = np.array(parsed_data).reshape((-1, *field_meta.shape))
-                dims = ["epoch", "declination", "azimuth"]
+                dims = ["epoch", "azimuth", "declination"]
+                # Add angle values to coordinates
+                sci_dataset.coords["declination"] = xr.DataArray(
+                    data=DECLINATION_ANGLES,
+                    dims=["declination"],
+                    name="declination",
+                )
+                sci_dataset.coords["azimuth"] = xr.DataArray(
+                    data=AZIMUTH_ANGLES,
+                    dims=["azimuth"],
+                    name="azimuth",
+                )
             elif "sngrates" in field:
                 dims = ["epoch", "gain", f"{field}_index"]
         elif field_meta.shape[0] > 1:
@@ -102,11 +115,12 @@ def parse_count_rates(sci_dataset: xr.Dataset) -> None:
 
         sci_dataset[field] = xr.DataArray(parsed_data, dims=dims, name=field)
         # Add dimensions to coordinates
-        # TODO: confirm that dtype int16 is correct
         for dim in dims:
             if dim not in sci_dataset.coords:
                 sci_dataset.coords[dim] = xr.DataArray(
-                    np.arange(sci_dataset.sizes[dim], dtype=np.int16),
+                    np.arange(sci_dataset.sizes[dim], dtype=np.int16)
+                    if dim == "gain"
+                    else np.arange(sci_dataset.sizes[dim], dtype=np.int32),
                     dims=[dim],
                     name=dim,
                 )