imap-processing 0.6.0__py3-none-any.whl

imap_processing/ultra/l1c/histogram.py

@@ -0,0 +1,36 @@
+"""Calculate Histogram."""
+
+import numpy as np
+import xarray as xr
+
+from imap_processing.ultra.utils.ultra_l1_utils import create_dataset
+
+
+def calculate_histogram(histogram_dataset: xr.Dataset, name: str) -> xr.Dataset:
+    """
+    Create dictionary with defined datatype for Histogram Data.
+
+    Parameters
+    ----------
+    histogram_dataset : xarray.Dataset
+        Dataset containing histogram data.
+    name : str
+        Name of dataset.
+
+    Returns
+    -------
+    dataset : xarray.Dataset
+        Dataset containing the data.
+    """
+    histogram_dict = {}
+
+    # Placeholder for calculations
+    # TODO: come back and update this data structure.
+    epoch = histogram_dataset.coords["epoch"].values
+
+    histogram_dict["epoch"] = epoch
+    histogram_dict["sid"] = np.zeros(len(epoch), dtype=np.uint8)
+
+    dataset = create_dataset(histogram_dict, name, "l1c")
+
+    return dataset

imap_processing/ultra/l1c/pset.py

@@ -0,0 +1,36 @@
+"""Calculate Pointing Set Grids."""
+
+import numpy as np
+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:
+    """
+    Create dictionary with defined datatype for Pointing Set Grid Data.
+
+    Parameters
+    ----------
+    pset_dataset : xarray.Dataset
+        Dataset containing histogram data.
+    name : str
+        Name of the dataset.
+
+    Returns
+    -------
+    dataset : xarray.Dataset
+        Dataset containing the data.
+    """
+    pset_dict = {}
+
+    # Placeholder for calculations
+    # TODO: come back and update this data structure.
+    epoch = pset_dataset.coords["epoch"].values
+
+    pset_dict["epoch"] = epoch
+    pset_dict["esa_step"] = np.zeros(len(epoch), dtype=np.uint8)
+
+    dataset = create_dataset(pset_dict, name, "l1c")
+
+    return dataset

imap_processing/ultra/l1c/ultra_l1c.py

@@ -0,0 +1,52 @@
+"""Calculate ULTRA L1c."""
+
+import xarray as xr
+
+from imap_processing.ultra.l1c.histogram import calculate_histogram
+from imap_processing.ultra.l1c.pset import calculate_pset
+
+
+def ultra_l1c(data_dict: dict, data_version: str) -> list[xr.Dataset]:
+    """
+    Will process ULTRA L1A and L1B data into L1C CDF files at output_filepath.
+
+    Parameters
+    ----------
+    data_dict : dict
+        The data itself and its dependent data.
+    data_version : str
+        Version of the data product being created.
+
+    Returns
+    -------
+    output_datasets : list[xarray.Dataset]
+        List of xarray.Dataset.
+    """
+    instrument_id = 45 if any("45" in key for key in data_dict.keys()) else 90
+
+    if (
+        f"imap_ultra_l1a_{instrument_id}sensor-histogram" in data_dict
+        and f"imap_ultra_l1b_{instrument_id}sensor-cullingmask" in data_dict
+    ):
+        histogram_dataset = calculate_histogram(
+            data_dict[f"imap_ultra_l1a_{instrument_id}sensor-histogram"],
+            f"imap_ultra_l1c_{instrument_id}sensor-histogram",
+        )
+        # 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
+        and f"imap_ultra_l1b_{instrument_id}sensor-de" in data_dict
+        and f"imap_ultra_l1b_{instrument_id}sensor-extendedspin" in data_dict
+    ):
+        pset_dataset = calculate_pset(
+            data_dict[f"imap_ultra_l1b_{instrument_id}sensor-de"],
+            f"imap_ultra_l1c_{instrument_id}sensor-pset",
+        )
+        pset_dataset.attrs["Data_version"] = data_version
+        output_datasets = [pset_dataset]
+    else:
+        raise ValueError("Data dictionary does not contain the expected keys.")
+
+    return output_datasets

imap_processing/ultra/l1c/ultra_l1c_pset_bins.py

@@ -0,0 +1,54 @@
+"""Module to create bins for pointing sets."""
+
+import numpy as np
+
+
+def build_energy_bins() -> tuple[np.ndarray, np.ndarray]:
+    """
+    Build energy bin boundaries.
+
+    Returns
+    -------
+    energy_bin_start : np.ndarray
+        Array of energy bin start values.
+    energy_bin_end : np.ndarray
+        Array of energy bin end values.
+    """
+    alpha = 0.05  # deltaE/E
+    energy_start = 3.5  # energy start for the Ultra grids
+    n_bins = 90  # number of energy bins
+
+    # Calculate energy step
+    energy_step = (1 + alpha / 2) / (1 - alpha / 2)
+
+    # Create energy bins.
+    bin_edges = energy_start * energy_step ** np.arange(n_bins + 1)
+    energy_bin_start = bin_edges[:-1]
+    energy_bin_end = bin_edges[1:]
+
+    return energy_bin_start, energy_bin_end
+
+
+def build_spatial_bins(spacing: float = 0.5) -> tuple[np.ndarray, np.ndarray]:
+    """
+    Build spatial bin boundaries for azimuth and elevation.
+
+    Parameters
+    ----------
+    spacing : float, optional
+        The bin spacing in degrees (default is 0.5 degrees).
+
+    Returns
+    -------
+    az_bin_edges : np.ndarray
+        Array of azimuth bin boundary values.
+    el_bin_edges : np.ndarray
+        Array of elevation bin boundary values.
+    """
+    # Azimuth bins from 0 to 360 degrees.
+    az_bin_edges = np.arange(0, 360 + spacing, spacing)
+
+    # Elevation bins from -90 to 90 degrees.
+    el_bin_edges = np.arange(-90, 90 + spacing, spacing)
+
+    return az_bin_edges, el_bin_edges