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

imap_processing/ultra/l1b/lookup_utils.py

@@ -23,7 +23,21 @@ _BACK_POS_DF_ULTRA90 = pd.read_csv(
     BASE_PATH / "ultra90_back-pos-luts.csv", index_col="Index_offset"
 )
 _ENERGY_NORM_DF = pd.read_csv(BASE_PATH / "EgyNorm.mem.csv")
-_IMAGE_PARAMS_DF = pd.read_csv(BASE_PATH / "FM45_Startup1_ULTRA_IMGPARAMS_20240719.csv")
+_IMAGE_PARAMS_DF = {
+    "ultra45": pd.read_csv(BASE_PATH / "FM45_Startup1_ULTRA_IMGPARAMS_20240719.csv"),
+    "ultra90": pd.read_csv(BASE_PATH / "FM90_Startup1_ULTRA_IMGPARAMS_20240719.csv"),
+}
+
+_FWHM_TABLES = {
+    ("left", "ultra45"): pd.read_csv(BASE_PATH / "Angular_Profiles_FM45_LeftSlit.csv"),
+    ("right", "ultra45"): pd.read_csv(
+        BASE_PATH / "Angular_Profiles_FM45_RightSlit.csv"
+    ),
+    ("left", "ultra90"): pd.read_csv(BASE_PATH / "Angular_Profiles_FM90_LeftSlit.csv"),
+    ("right", "ultra90"): pd.read_csv(
+        BASE_PATH / "Angular_Profiles_FM90_RightSlit.csv"
+    ),
+}
 
 
 def get_y_adjust(dy_lut: np.ndarray) -> npt.NDArray:
@@ -32,7 +46,7 @@ def get_y_adjust(dy_lut: np.ndarray) -> npt.NDArray:
 
     Instead of using trigonometry, this function utilizes a 256-element lookup table
     to find the Y adjustment. For more details, refer to pages 37-38 of the
-    IMAP-Ultra Flight Software Specification document (7523-9009_Rev_-.pdf).
+    IMAP-Ultra Flight Software Specification document.
 
     Parameters
     ----------
@@ -56,7 +70,7 @@ def get_norm(dn: xr.DataArray, key: str, file_label: str) -> npt.NDArray:
     using lookup tables.
 
     Further description is available on pages 31-32 of the IMAP-Ultra Flight Software
-    Specification document (7523-9009_Rev_-.pdf). This will work for both Tp{key}Norm,
+    Specification document. This will work for both Tp{key}Norm,
     Bt{key}Norm. This is for getStopNorm and getCoinNorm.
 
     Parameters
@@ -92,7 +106,7 @@ def get_back_position(back_index: np.ndarray, key: str, file_label: str) -> npt.
     instead of linear equations is necessary. The computation will use different
     tables to accommodate variations between the top and bottom anodes.
     Further description is available on page 32 of the
-    IMAP-Ultra Flight Software Specification document (7523-9009_Rev_-.pdf).
+    IMAP-Ultra Flight Software Specification document.
 
     Parameters
     ----------
@@ -122,8 +136,8 @@ def get_energy_norm(ssd: np.ndarray, composite_energy: np.ndarray) -> npt.NDArra
     Normalize composite energy per SSD using a lookup table.
 
     Further description is available on page 41 of the
-    IMAP-Ultra Flight Software Specification document
-    (7523-9009_Rev_-.pdf). Note : There are 8 SSDs containing
+    IMAP-Ultra Flight Software Specification document.
+    Note : There are 8 SSDs containing
     4096 composite energies each.
 
     Parameters
@@ -143,23 +157,72 @@ def get_energy_norm(ssd: np.ndarray, composite_energy: np.ndarray) -> npt.NDArra
     return _ENERGY_NORM_DF["NormEnergy"].iloc[row_number]
 
 
-def get_image_params(image: str) -> np.float64:
+def get_image_params(image: str, sensor: str) -> np.float64:
     """
     Lookup table for image parameters.
 
     Further description is available starting on
     page 30 of the IMAP-Ultra Flight Software
-    Specification document (7523-9009_Rev_-.pdf).
+    Specification document.
 
     Parameters
     ----------
     image : str
         The column name to lookup in the CSV file, e.g., 'XFTLTOFF' or 'XFTRTOFF'.
+    sensor : str
+        Sensor name: "ultra45" or "ultra90".
 
     Returns
     -------
     value : np.float64
         Image parameter value from the CSV file.
     """
-    value: np.float64 = _IMAGE_PARAMS_DF[image].values[0]
+    lookup_table = _IMAGE_PARAMS_DF[sensor]
+    value: np.float64 = lookup_table[image].values[0]
     return value
+
+
+def get_angular_profiles(start_type: str, sensor: str) -> pd.DataFrame:
+    """
+    Lookup table for FWHM for theta and phi.
+
+    Further description is available starting on
+    page 18 of the Algorithm Document.
+
+    Parameters
+    ----------
+    start_type : str
+       Start Type: Left, Right.
+    sensor : str
+        Sensor name: "ultra45" or "ultra90".
+
+    Returns
+    -------
+    lookup_table : DataFrame
+        Angular profile lookup table for a given start_type and sensor.
+    """
+    lookup_table = _FWHM_TABLES[(start_type.lower(), sensor)]
+
+    return lookup_table
+
+
+def get_energy_efficiencies() -> pd.DataFrame:
+    """
+    Lookup table for efficiencies for theta and phi.
+
+    Further description is available starting on
+    page 18 of the Algorithm Document.
+
+    Returns
+    -------
+    lookup_table : DataFrame
+        Efficiencies lookup table for a given sensor.
+    """
+    # TODO: Move this out of tests directory once we have the aux api
+    # TODO: ultra90 efficiencies
+    path = imap_module_directory / "tests" / "ultra" / "data" / "l1"
+    lookup_table = pd.read_csv(
+        path / "Ultra_efficiencies_45_combined_logistic_interpolation.csv"
+    )
+
+    return lookup_table

imap_processing/ultra/l1b/ultra_l1b.py

@@ -8,7 +8,7 @@ from imap_processing.ultra.l1b.de import calculate_de
 from imap_processing.ultra.l1b.extendedspin import calculate_extendedspin
 
 
-def ultra_l1b(data_dict: dict, data_version: str) -> list[xr.Dataset]:
+def ultra_l1b(data_dict: dict) -> list[xr.Dataset]:
     """
     Will process ULTRA L1A data into L1B CDF files at output_filepath.
 
@@ -16,8 +16,6 @@ def ultra_l1b(data_dict: dict, data_version: str) -> list[xr.Dataset]:
     ----------
     data_dict : dict
         The data itself and its dependent data.
-    data_version : str
-        Version of the data product being created.
 
     Returns
     -------
@@ -39,16 +37,16 @@ def ultra_l1b(data_dict: dict, data_version: str) -> list[xr.Dataset]:
         de_dataset = calculate_de(
             data_dict[f"imap_ultra_l1a_{instrument_id}sensor-de"],
             f"imap_ultra_l1b_{instrument_id}sensor-de",
-            data_version,
         )
         output_datasets.append(de_dataset)
     # L1b extended data will be created if L1a hk, rates,
-    # aux and l1b de data are available
+    # aux, params, and l1b de data are available
     elif (
         f"imap_ultra_l1a_{instrument_id}sensor-hk" in data_dict
         and f"imap_ultra_l1b_{instrument_id}sensor-de" in data_dict
         and f"imap_ultra_l1a_{instrument_id}sensor-rates" in data_dict
         and f"imap_ultra_l1a_{instrument_id}sensor-aux" in data_dict
+        and f"imap_ultra_l1a_{instrument_id}sensor-params" in data_dict
     ):
         extendedspin_dataset = calculate_extendedspin(
             {
@@ -66,19 +64,16 @@ def ultra_l1b(data_dict: dict, data_version: str) -> list[xr.Dataset]:
                 ],
             },
             f"imap_ultra_l1b_{instrument_id}sensor-extendedspin",
-            data_version,
             instrument_id,
         )
         cullingmask_dataset = calculate_cullingmask(
             extendedspin_dataset,
             f"imap_ultra_l1b_{instrument_id}sensor-cullingmask",
-            data_version,
         )
         badtimes_dataset = calculate_badtimes(
             extendedspin_dataset,
             cullingmask_dataset["spin_number"].values,
             f"imap_ultra_l1b_{instrument_id}sensor-badtimes",
-            data_version,
         )
         output_datasets.extend(
             [extendedspin_dataset, cullingmask_dataset, badtimes_dataset]

imap_processing/ultra/l1b/ultra_l1b_culling.py

@@ -89,7 +89,7 @@ def flag_attitude(
     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
@@ -210,10 +210,10 @@ def compare_aux_univ_spin_table(
     mismatch_indices = np.zeros(len(spins), dtype=bool)
 
     fields_to_compare = [
-        ("TIMESPINSTART", "spin_start_sec"),
-        ("TIMESPINSTARTSUB", "spin_start_subsec"),
+        ("TIMESPINSTART", "spin_start_sec_sclk"),
+        ("TIMESPINSTARTSUB", "spin_start_subsec_sclk"),
         ("DURATION", "spin_period_sec"),
-        ("TIMESPINDATA", "spin_start_time"),
+        ("TIMESPINDATA", "spin_start_met"),
         ("SPINPERIOD", "spin_period_sec"),
     ]