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

imap_processing/ultra/l1c/pset.py

@@ -6,7 +6,9 @@ import xarray as xr
 from imap_processing.ultra.utils.ultra_l1_utils import create_dataset
 
 
-def calculate_pset(pset_dataset: xr.Dataset, name: str) -> xr.Dataset:
+def calculate_pset(
+    pset_dataset: xr.Dataset, name: str, data_version: str
+) -> xr.Dataset:
     """
     Create dictionary with defined datatype for Pointing Set Grid Data.
 
@@ -16,6 +18,8 @@ def calculate_pset(pset_dataset: xr.Dataset, name: str) -> xr.Dataset:
         Dataset containing histogram data.
     name : str
         Name of the dataset.
+    data_version : str
+        Version of the data.
 
     Returns
     -------
@@ -31,6 +35,6 @@ def calculate_pset(pset_dataset: xr.Dataset, name: str) -> xr.Dataset:
     pset_dict["epoch"] = epoch
     pset_dict["esa_step"] = np.zeros(len(epoch), dtype=np.uint8)
 
-    dataset = create_dataset(pset_dict, name, "l1c")
+    dataset = create_dataset(pset_dict, name, "l1c", data_version)
 
     return dataset

imap_processing/ultra/l1c/ultra_l1c.py

@@ -31,9 +31,8 @@ def ultra_l1c(data_dict: dict, data_version: str) -> list[xr.Dataset]:
         histogram_dataset = calculate_histogram(
             data_dict[f"imap_ultra_l1a_{instrument_id}sensor-histogram"],
             f"imap_ultra_l1c_{instrument_id}sensor-histogram",
+            data_version,
         )
-        # TODO: move these to use ImapCdfAttributes().add_global_attribute()
-        histogram_dataset.attrs["Data_version"] = data_version
         output_datasets = [histogram_dataset]
     elif (
         f"imap_ultra_l1b_{instrument_id}sensor-cullingmask" in data_dict
@@ -43,8 +42,8 @@ def ultra_l1c(data_dict: dict, data_version: str) -> list[xr.Dataset]:
         pset_dataset = calculate_pset(
             data_dict[f"imap_ultra_l1b_{instrument_id}sensor-de"],
             f"imap_ultra_l1c_{instrument_id}sensor-pset",
+            data_version,
         )
-        pset_dataset.attrs["Data_version"] = data_version
         output_datasets = [pset_dataset]
     else:
         raise ValueError("Data dictionary does not contain the expected keys.")

imap_processing/ultra/l1c/ultra_l1c_pset_bins.py

@@ -6,6 +6,7 @@ import cdflib
 import numpy as np
 from numpy.typing import NDArray
 
+from imap_processing.ena_maps.utils.spatial_utils import build_spatial_bins
 from imap_processing.spice.geometry import (
     SpiceFrame,
     cartesian_to_spherical,
@@ -13,7 +14,6 @@ from imap_processing.spice.geometry import (
     spherical_to_cartesian,
 )
 from imap_processing.ultra.constants import UltraConstants
-from imap_processing.ultra.utils.spatial_utils import build_spatial_bins
 
 # TODO: add species binning.
 
@@ -154,11 +154,12 @@ def get_helio_exposure_times(
     -----
     These calculations are performed once per pointing.
     """
-    # Get bins and midpoints.
+    # Get bins and midpoints, and convert from radians to degrees.
     _, energy_midpoints = build_energy_bins()
     az_bin_edges, el_bin_edges, az_bin_midpoints, el_bin_midpoints = (
-        build_spatial_bins()
+        np.rad2deg(angle_radians) for angle_radians in (build_spatial_bins())
     )
+
     # Initialize the exposure grid.
     exposure_3d = np.zeros(
         (len(el_bin_midpoints), len(az_bin_midpoints), len(energy_midpoints))

imap_processing/ultra/utils/ultra_l1_utils.py

@@ -5,7 +5,9 @@ import xarray as xr
 from imap_processing.cdf.imap_cdf_manager import ImapCdfAttributes
 
 
-def create_dataset(data_dict: dict, name: str, level: str) -> xr.Dataset:
+def create_dataset(
+    data_dict: dict, name: str, level: str, data_version: str
+) -> xr.Dataset:
     """
     Create xarray for L1b data.
 
@@ -17,6 +19,8 @@ def create_dataset(data_dict: dict, name: str, level: str) -> xr.Dataset:
         Name of the dataset.
     level : str
         Level of the dataset.
+    data_version : str
+        Version of the data.
 
     Returns
     -------
@@ -26,25 +30,77 @@ def create_dataset(data_dict: dict, name: str, level: str) -> xr.Dataset:
     cdf_manager = ImapCdfAttributes()
     cdf_manager.add_instrument_global_attrs("ultra")
     cdf_manager.add_instrument_variable_attrs("ultra", level)
-    epoch_time = xr.DataArray(
-        data_dict["epoch"],
-        name="epoch",
-        dims=["epoch"],
-        attrs=cdf_manager.get_variable_attributes("epoch"),
-    )
+    cdf_manager.add_global_attribute("Data_version", data_version)
+
+    if "spin_number" in data_dict.keys():
+        coords = {
+            "spin_number": data_dict["spin_number"],
+            "energy_bin_geometric_mean": data_dict["energy_bin_geometric_mean"],
+        }
+        default_dimension = "spin_number"
+
+    else:
+        epoch_time = xr.DataArray(
+            data_dict["epoch"],
+            name="epoch",
+            dims=["epoch"],
+            attrs=cdf_manager.get_variable_attributes("epoch"),
+        )
+        if "sensor-de" in name:
+            component = xr.DataArray(
+                ["vx", "vy", "vz"],
+                name="component",
+                dims=["component"],
+                attrs=cdf_manager.get_variable_attributes("component"),
+            )
+            coords = {"epoch": epoch_time, "component": component}
+        else:
+            coords = {"epoch": epoch_time}
+        default_dimension = "epoch"
 
     dataset = xr.Dataset(
-        coords={"epoch": epoch_time},
+        coords=coords,
         attrs=cdf_manager.get_global_attributes(name),
     )
 
+    velocity_keys = {
+        "direct_event_velocity",
+        "velocity_sc",
+        "velocity_dps_sc",
+        "velocity_dps_helio",
+    }
+    rates_keys = {
+        "ena_rates",
+        "ena_rates_threshold",
+        "quality_ena_rates",
+    }
+
     for key in data_dict.keys():
-        if key == "epoch":
+        if key in ["epoch", "spin_number", "energy_bin_geometric_mean"]:
             continue
-        dataset[key] = xr.DataArray(
-            data_dict[key],
-            dims=["epoch"],
-            attrs=cdf_manager.get_variable_attributes(key),
-        )
+        elif key in velocity_keys:
+            dataset[key] = xr.DataArray(
+                data_dict[key],
+                dims=["epoch", "component"],
+                attrs=cdf_manager.get_variable_attributes(key),
+            )
+        elif key == "ena_rates_threshold":
+            dataset[key] = xr.DataArray(
+                data_dict[key],
+                dims=["energy_bin_geometric_mean"],
+                attrs=cdf_manager.get_variable_attributes(key),
+            )
+        elif key in rates_keys:
+            dataset[key] = xr.DataArray(
+                data_dict[key],
+                dims=["energy_bin_geometric_mean", "spin_number"],
+                attrs=cdf_manager.get_variable_attributes(key),
+            )
+        else:
+            dataset[key] = xr.DataArray(
+                data_dict[key],
+                dims=[default_dimension],
+                attrs=cdf_manager.get_variable_attributes(key),
+            )
 
     return dataset

imap_processing/utils.py

@@ -10,7 +10,7 @@ import pandas as pd
 import xarray as xr
 from space_packet_parser import definitions, encodings, parameters
 
-from imap_processing.spice.time import met_to_j2000ns
+from imap_processing.spice.time import met_to_ttj2000ns
 
 logger = logging.getLogger(__name__)
 
@@ -295,7 +295,7 @@ def packet_file_to_datasets(
         # The time key is always the first key in the data dictionary on IMAP
         time_key = next(iter(data.keys()))
         # Convert to J2000 time and use that as our primary dimension
-        time_data = met_to_j2000ns(data[time_key])
+        time_data = met_to_ttj2000ns(data[time_key])
         ds = xr.Dataset(
             {
                 key.lower(): (

{imap_processing-0.9.0.dist-info → imap_processing-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imap-processing
-Version: 0.9.0
+Version: 0.11.0
 Summary: IMAP Science Operations Center Processing
 License: MIT
 Keywords: IMAP,SDC,SOC,Science Operations
@@ -41,7 +41,7 @@ Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "test"
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0) ; extra == "test"
 Requires-Dist: ruff (==0.2.1) ; extra == "dev"
-Requires-Dist: sammi-cdf (>=0.1.2,<0.2.0)
+Requires-Dist: sammi-cdf (>=1.0,<2.0)
 Requires-Dist: space_packet_parser (>=5.0.1,<6.0.0)
 Requires-Dist: sphinx ; extra == "doc"
 Requires-Dist: sphinxcontrib-openapi (>=0.8.3,<0.9.0) ; extra == "doc"
@@ -98,7 +98,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/subagonsouth"><img src="https://avatars.githubusercontent.com/u/16110870?v=4?s=100" width="100px;" alt="Tim Plummer"/><br /><sub><b>Tim Plummer</b></sub></a><br /></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/daralynnrhode"><img src="https://avatars.githubusercontent.com/u/143308810?v=4?s=100" width="100px;" alt="Daralynn Rhode"/><br /><sub><b>Daralynn Rhode</b></sub></a><br /></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/anamanica"><img src="https://avatars.githubusercontent.com/u/171708990?v=4?s=100" width="100px;" alt="Ana Manica"/><br /><sub><b>Ana Manica</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lacoak21"><img src="https://avatars.githubusercontent.com/u/48064300?v=4?s=100" width="100px;" alt="Luisa Coakley"/><br /><sub><b>Luisa Coakley</b></sub></a><br /></td>
     </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/nkerman"><img src="https://avatars.githubusercontent.com/u/13221946?v=4?s=100" width="100px;" alt="Nat Kerman"/><br /><sub><b>Nat Kerman</b></sub></a><br /></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/torimarbois"><img src="https://avatars.githubusercontent.com/u/65727848?v=4?s=100" width="100px;" alt="Tori Marbois"/><br /><sub><b>Tori Marbois</b></sub></a><br /></td>
+</tr>
   </tbody>
 </table>