Skip to content

Commit

Permalink
I-ALiRT - Test decom for HIT CCSDS (#757)
Browse files Browse the repository at this point in the history 
* IALiRT HIT CCSDS
  • Loading branch information
@laspsandoval
laspsandoval authored Sep 12, 2024
1 parent 3e9f5b4 commit 9b259db
Show file tree
Hide file tree
Showing 8 changed files with 1,647 additions and 160 deletions.
99 changes: 0 additions & 99 deletions imap_processing/ialirt/l0/decom_ialirt.py
View file

This file was deleted.

220 changes: 220 additions & 0 deletions imap_processing/ialirt/l0/process_hit.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
"""Functions to support HIT processing."""

import logging

import numpy as np
import xarray as xr

logger = logging.getLogger(__name__)


# HIT prefixes as defined by Table 37 of the HIT Algorithm Document.
HIT_PREFIX_TO_RATE_TYPE = {
"FAST_RATE_1": [
f"{prefix}_{i:02d}"
for i in range(15)
for prefix in ["L1A_TRIG", "IA_EVNT_TRIG", "A_EVNT_TRIG", "L3A_TRIG"]
],
"FAST_RATE_2": [
f"{prefix}_{i:02d}"
for i in range(15)
for prefix in ["L1B_TRIG", "IB_EVNT_TRIG", "B_EVNT_TRIG", "L3B_TRIG"]
],
"SLOW_RATE": [
"L1A",
"L2A",
"L3A",
"L1A0AHG",
"L1B0AHG",
"L1C0AHG",
"L4IAHG",
"L4OAHG",
"SLOW_RATE_08",
"SLOW_RATE_09",
"SLOW_RATE_10",
"L1A0BHG",
"L1B0BHG",
"L1C0BHG",
"L4IBHG",
"L4OBHG",
*[f"IALRT_RATE_{i}" for i in range(1, 21)],
"TRIG_IA_EVNT",
"TRIG_IB_EVNT",
"NASIDE_IALRT",
"NBSIDE_IALRT",
*[f"ERATE_{i}" for i in range(1, 6)],
"L12A",
"L123A",
"PENA",
"L12B",
"L123B",
"PENB",
"SLOW_RATE_51",
"SLOW_RATE_52",
"SLOW_RATE_53",
"SLOW_RATE_54",
"H_06_08",
"H_12_15",
"H_15_70",
"HE4_06_08",
"HE4_15_70",
],
}


def find_groups(data: xr.Dataset) -> xr.Dataset:
"""
Find all occurrences of the sequential set of 60 values 0-59.
If a value is missing, or we are starting/ending
in the middle of a sequence we do not count that as a valid group.
Parameters
----------
data : xr.Dataset
HIT Dataset.
Returns
-------
grouped_data : xr.Dataset
Grouped data.
"""
subcom_range = (0, 59)

data = data.sortby("hit_sc_tick", ascending=True)

# Use hit_subcom == 0 to define the beginning of the group.
# Find hit_sc_tick at this index and use it as the beginning time for the group.
start_sc_ticks = data["hit_sc_tick"][(data["hit_subcom"] == subcom_range[0])]
start_sc_tick = start_sc_ticks.min()
# Use hit_subcom == 59 to define the end of the group.
last_sc_ticks = data["hit_sc_tick"][([data["hit_subcom"] == subcom_range[-1]][-1])]
last_sc_tick = last_sc_ticks.max()

# Filter out data before the first subcom=0 and after the last subcom=59.
grouped_data = data.where(
(data["hit_sc_tick"] >= start_sc_tick) & (data["hit_sc_tick"] <= last_sc_tick),
drop=True,
)

# Assign labels based on the hit_sc_tick start times.
group_labels = np.searchsorted(
start_sc_ticks, grouped_data["hit_sc_tick"], side="right"
)
# Example:
# grouped_data.coords
# Coordinates:
# * epoch (epoch) int64 7kB 315922822184000000 ... 315923721184000000
# * group (group) int64 7kB 1 1 1 1 1 1 1 1 1 ... 15 15 15 15 15 15 15 15 15
grouped_data["group"] = ("group", group_labels)

return grouped_data


def create_l1(
fast_rate_1: xr.DataArray,
fast_rate_2: xr.DataArray,
slow_rate: xr.DataArray,
) -> dict[str, float]:
"""
Create L1 data dictionary.
Parameters
----------
fast_rate_1 : xr.DataArray
Fast rate 1 DataArray.
fast_rate_2 : xr.DataArray
Fast rate 2 DataArray.
slow_rate : xr.DataArray
Slow rate DataArray.
Returns
-------
l1 : dict
Dictionary containing parsed L0 packet data.
"""
fast_rate_1_dict = {
prefix: value
for prefix, value in zip(
HIT_PREFIX_TO_RATE_TYPE["FAST_RATE_1"], fast_rate_1.data
)
}
fast_rate_2_dict = {
prefix: value
for prefix, value in zip(
HIT_PREFIX_TO_RATE_TYPE["FAST_RATE_2"], fast_rate_2.data
)
}
slow_rate_dict = {
prefix: value
for prefix, value in zip(HIT_PREFIX_TO_RATE_TYPE["SLOW_RATE"], slow_rate.data)
}

l1 = {**fast_rate_1_dict, **fast_rate_2_dict, **slow_rate_dict}

return l1


def process_hit(xarray_data: xr.Dataset) -> list[dict]:
"""
Create L1 data dictionary.
Parameters
----------
xarray_data : dict(xr.Dataset)
Dictionary of xarray data including a single
set for processing.
Returns
-------
hit_data : dict
Dictionary final data product.
"""
hit_data = []
grouped_data = find_groups(xarray_data)
unique_groups = np.unique(grouped_data["group"])

for group in unique_groups:
# Subcom values for the group should be 0-59 with no duplicates.
subcom_values = grouped_data["hit_subcom"][
(grouped_data["group"] == group).values
]

# Ensure no duplicates and all values from 0 to 59 are present
if not np.array_equal(subcom_values, np.arange(60)):
raise ValueError(
f"Group {group} does not contain all values from 0 to "
f"59 without duplicates."
)

fast_rate_1 = grouped_data["hit_fast_rate_1"][
(grouped_data["group"] == group).values
]
fast_rate_2 = grouped_data["hit_fast_rate_2"][
(grouped_data["group"] == group).values
]
slow_rate = grouped_data["hit_slow_rate"][
(grouped_data["group"] == group).values
]
met = int(grouped_data["hit_met"][(grouped_data["group"] == group).values][0])

l1 = create_l1(fast_rate_1, fast_rate_2, slow_rate)

hit_data.append(
{
"met": met,
"hit_lo_energy_e_A_side": l1["IALRT_RATE_1"] + l1["IALRT_RATE_2"],
"hit_medium_energy_e_A_side": l1["IALRT_RATE_5"] + l1["IALRT_RATE_6"],
"hit_high_energy_e_A_side": l1["IALRT_RATE_7"],
"hit_low_energy_e_B_side": l1["IALRT_RATE_11"] + l1["IALRT_RATE_12"],
"hit_medium_energy_e_B_side": l1["IALRT_RATE_15"] + l1["IALRT_RATE_16"],
"hit_high_energy_e_B_side": l1["IALRT_RATE_17"],
"hit_medium_energy_H_omni": l1["H_12_15"] + l1["H_15_70"],
"hit_high_energy_H_A_side": l1["IALRT_RATE_8"],
"hit_high_energy_H_B_side": l1["IALRT_RATE_18"],
"hit_low_energy_He_omni": l1["HE4_06_08"],
"hit_high_energy_He_omni": l1["HE4_15_70"],
}
)

return hit_data
16 changes: 8 additions & 8 deletions imap_processing/ialirt/packet_definitions/ialirt.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -557,16 +557,16 @@
</xtce:Parameter>
<!-- CoDICE LO -->
<!-- HIT -->
<xtce:Parameter name="HIT_SC_TICK" parameterTypeRef="uint32">
<xtce:LongDescription>Spacecraft tick</xtce:LongDescription>
<xtce:Parameter name="HIT_MET" parameterTypeRef="uint32">
<xtce:LongDescription>Mission elapsed time</xtce:LongDescription>
</xtce:Parameter>
<xtce:Parameter name="HIT_STATUS" parameterTypeRef="instrument_status">
<xtce:LongDescription>1 = nominal, 0 = off-nominal</xtce:LongDescription>
</xtce:Parameter>
<xtce:Parameter name="HIT_RESERVED" parameterTypeRef="uint1">
<xtce:LongDescription>Reserved</xtce:LongDescription>
<xtce:Parameter name="HIT_SPARE" parameterTypeRef="uint1">
<xtce:LongDescription>Spare</xtce:LongDescription>
</xtce:Parameter>
<xtce:Parameter name="HIT_COUNTER" parameterTypeRef="uint6">
<xtce:Parameter name="HIT_SUBCOM" parameterTypeRef="uint6">
<xtce:LongDescription>Seconds counter</xtce:LongDescription>
</xtce:Parameter>
<xtce:Parameter name="HIT_FAST_RATE_1" parameterTypeRef="uint16">
Expand Down Expand Up @@ -717,10 +717,10 @@
<xtce:ParameterRefEntry parameterRef="COD_LO_SPARE_0"/>
<!-- CoDICE LO -->
<!-- HIT -->
<xtce:ParameterRefEntry parameterRef="HIT_SC_TICK"/>
<xtce:ParameterRefEntry parameterRef="HIT_MET"/>
<xtce:ParameterRefEntry parameterRef="HIT_STATUS"/>
<xtce:ParameterRefEntry parameterRef="HIT_RESERVED"/>
<xtce:ParameterRefEntry parameterRef="HIT_COUNTER"/>
<xtce:ParameterRefEntry parameterRef="HIT_SPARE"/>
<xtce:ParameterRefEntry parameterRef="HIT_SUBCOM"/>
<xtce:ParameterRefEntry parameterRef="HIT_FAST_RATE_1"/>
<xtce:ParameterRefEntry parameterRef="HIT_FAST_RATE_2"/>
<xtce:ParameterRefEntry parameterRef="HIT_SLOW_RATE"/>
Expand Down
Loading

0 comments on commit 9b259db

Please sign in to comment.