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

imap_processing/ultra/l1b/ultra_l1b_culling.py

@@ -1,31 +1,15 @@
 """Culls Events for ULTRA L1b."""
 
 import numpy as np
+import pandas as pd
+import xarray as xr
 from numpy.typing import NDArray
 
 from imap_processing.quality_flags import ImapAttitudeUltraFlags, ImapRatesUltraFlags
-from imap_processing.spice.spin import get_spin_data, interpolate_spin_data
+from imap_processing.spice.spin import get_spin_data
 from imap_processing.ultra.constants import UltraConstants
 
 
-def get_spin(eventtimes_met: NDArray) -> NDArray:
-    """
-    Get spin number for each event.
-
-    Parameters
-    ----------
-    eventtimes_met : NDArray
-        Event Times in Mission Elapsed Time.
-
-    Returns
-    -------
-    spin_number : NDArray
-        Spin number at each event derived the from Universal Spin Table.
-    """
-    spin_df = interpolate_spin_data(eventtimes_met)
-    return spin_df["spin_number"].values
-
-
 def get_energy_histogram(
     spin_number: NDArray, energy: NDArray
 ) -> tuple[NDArray, NDArray, NDArray, float]:
@@ -77,14 +61,18 @@ def get_energy_histogram(
     return hist, spin_edges, counts, mean_duration
 
 
-def flag_attitude(eventtimes_met: NDArray) -> tuple[NDArray, NDArray, NDArray, NDArray]:
+def flag_attitude(
+    spin_number: NDArray, aux_dataset: xr.Dataset
+) -> tuple[NDArray, NDArray, NDArray, NDArray]:
     """
     Flag data based on attitude.
 
     Parameters
     ----------
-    eventtimes_met : NDArray
-        Event Times in Mission Elapsed Time.
+    spin_number : NDArray
+        Spin number at each direct event.
+    aux_dataset : xarray.Dataset
+        Auxiliary dataset.
 
     Returns
     -------
@@ -97,11 +85,11 @@ def flag_attitude(eventtimes_met: NDArray) -> tuple[NDArray, NDArray, NDArray, N
     spin_starttime : NDArray
         Spin start time.
     """
-    spins = np.unique(get_spin(eventtimes_met))  # Get unique spins
+    spins = np.unique(spin_number)  # Get unique spins
     spin_df = get_spin_data()  # Load spin data
 
     spin_period = spin_df.loc[spin_df.spin_number.isin(spins), "spin_period_sec"]
-    spin_starttime = spin_df.loc[spin_df.spin_number.isin(spins), "spin_start_time"]
+    spin_starttime = spin_df.loc[spin_df.spin_number.isin(spins), "spin_start_met"]
     spin_rates = 60 / spin_period  # 60 seconds in a minute
     bad_spin_rate_indices = (spin_rates < UltraConstants.CULLING_RPM_MIN) | (
         spin_rates > UltraConstants.CULLING_RPM_MAX
@@ -111,6 +99,8 @@ def flag_attitude(eventtimes_met: NDArray) -> tuple[NDArray, NDArray, NDArray, N
         spin_rates.shape, ImapAttitudeUltraFlags.NONE.value, dtype=np.uint16
     )
     quality_flags[bad_spin_rate_indices] |= ImapAttitudeUltraFlags.SPINRATE.value
+    mismatch_indices = compare_aux_univ_spin_table(aux_dataset, spins, spin_df)
+    quality_flags[mismatch_indices] |= ImapAttitudeUltraFlags.AUXMISMATCH.value
 
     return quality_flags, spin_rates, spin_period, spin_starttime
 
@@ -144,15 +134,15 @@ def get_n_sigma(count_rates: NDArray, mean_duration: float, sigma: int = 6) -> N
 
 
 def flag_spin(
-    eventtimes_met: NDArray, energy: NDArray, sigma: int = 6
+    spin_number: NDArray, energy: NDArray, sigma: int = 6
 ) -> tuple[NDArray, NDArray, NDArray, NDArray]:
     """
     Flag data based on counts and negative energies.
 
     Parameters
     ----------
-    eventtimes_met : NDArray
-        Event Times in Mission Elapsed Time.
+    spin_number : NDArray
+        Spin number at each direct event.
     energy : NDArray
         Energy data.
     sigma : int (default=6)
@@ -169,8 +159,9 @@ def flag_spin(
     n_sigma_per_energy_reshape : NDArray
         N sigma per energy.
     """
-    spin = get_spin(eventtimes_met)
-    count_rates, spin_edges, counts, duration = get_energy_histogram(spin, energy)
+    count_rates, spin_edges, counts, duration = get_energy_histogram(
+        spin_number, energy
+    )
     quality_flags = np.full(
         count_rates.shape, ImapRatesUltraFlags.NONE.value, dtype=np.uint16
     )
@@ -181,10 +172,55 @@ def flag_spin(
 
     bin_edges = np.array(UltraConstants.CULLING_ENERGY_BIN_EDGES)
     energy_midpoints = np.sqrt(bin_edges[:-1] * bin_edges[1:])
-    spin = np.unique(spin)
+    spin = np.unique(spin_number)
 
     # Indices where the counts exceed the threshold
     indices_n_sigma = count_rates > threshold[:, np.newaxis]
     quality_flags[indices_n_sigma] |= ImapRatesUltraFlags.HIGHRATES.value
 
     return quality_flags, spin, energy_midpoints, threshold
+
+
+def compare_aux_univ_spin_table(
+    aux_dataset: xr.Dataset, spins: NDArray, spin_df: pd.DataFrame
+) -> NDArray:
+    """
+    Compare the auxiliary and Universal Spin Table.
+
+    Parameters
+    ----------
+    aux_dataset : xarray.Dataset
+        Auxiliary dataset.
+    spins : np.ndarray
+        Array of spin numbers to compare.
+    spin_df : pd.DataFrame
+        Universal Spin Table.
+
+    Returns
+    -------
+    mismatch_indices : np.ndarray
+        Boolean array indicating which spins have mismatches.
+    """
+    univ_mask = np.isin(spin_df["spin_number"].values, spins)
+    aux_mask = np.isin(aux_dataset["SPINNUMBER"].values, spins)
+
+    filtered_univ = spin_df[univ_mask]
+    filtered_aux = {field: aux_dataset[field].values[aux_mask] for field in aux_dataset}
+
+    mismatch_indices = np.zeros(len(spins), dtype=bool)
+
+    fields_to_compare = [
+        ("TIMESPINSTART", "spin_start_sec_sclk"),
+        ("TIMESPINSTARTSUB", "spin_start_subsec_sclk"),
+        ("DURATION", "spin_period_sec"),
+        ("TIMESPINDATA", "spin_start_met"),
+        ("SPINPERIOD", "spin_period_sec"),
+    ]
+
+    for aux_field, spin_field in fields_to_compare:
+        aux_values = filtered_aux[aux_field]
+        spin_values = filtered_univ[spin_field].values
+
+        mismatch_indices |= aux_values != spin_values
+
+    return mismatch_indices