Hi L1B DE: carry last_spin_num into output and add BADSPIN ccsds_qf flag by Copilot · Pull Request #2754 · IMAP-Science-Operations-Center/imap_processing

Copilot · 2026-02-23T18:45:16Z

last_spin_num was being dropped from L1A→L1B DE processing, and there was no quality flag to signal packets containing events from invalid spins.

Changes Made

quality_flags.py: Added BADSPIN = ENAFlags.BADSPIN (bit 2, value 4) to ImapHiL1bDeFlags, reusing the existing shared ENAFlags.BADSPIN flag rather than a custom flag.
hi_l1b.py:
- Removed last_spin_num from drop_vars — it now passes through to L1B with unchanged variable attributes.
- de_ccsds_qf(): sets BADSPIN flag (bitwise OR) on any packet where spin_invalids != 0; check is placed before the early-return guard so it applies even when no valid direct events exist.
imap_hi_variable_attrs.yaml: Updated VAR_NOTES for hi_de_ccsds_qf to document both flags — Bit 0 (PACKET_FULL) and Bit 2 (BADSPIN).
test_hi_l1b.py: Added spin_invalids to existing test datasets; added two new test methods using np.testing.assert_array_equal; updated data_vars count assertions from 17 to 18.

Original prompt

This section details on the original issue you should resolve

<issue_title>Hi L1B DE - carry last_spin_num into L1B and add spin_invalid quality flag</issue_title>
<issue_description>### Algorithm Description:
Simplifying dependencies for goodtimes, I want to carry the L1A DE last_spin_num into L1B DE. I also want to add a ccsds_qf for invalid spin that uses the spin_invalids flag to populate the value.

Details:

Carry the last_spin_num into L1B DE. The variable attributes should be the same as in the L1A DE.

Add a new quality flag to the ImapHiL1bDeFlags in quality_flags.py named SPIN_INVALID. Set that flag in hi_l1b.py for any L1A DE packet that has a nonzero value in the spin_invalids variable.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Hi L1B DE - carry last_spin_num into L1B and add spin_invalid quality flag #2753

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…flag Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

subagonsouth · 2026-02-23T18:56:23Z

imap_processing/tests/hi/test_hi_l1b.py

+        assert result["ccsds_qf"].values[0] == 0
+        assert result["ccsds_qf"].values[1] == ImapHiL1bDeFlags.SPIN_INVALID
+        assert result["ccsds_qf"].values[2] == 0


Suggested change

assert result["ccsds_qf"].values[0] == 0

assert result["ccsds_qf"].values[1] == ImapHiL1bDeFlags.SPIN_INVALID

assert result["ccsds_qf"].values[2] == 0

np.testing.assert_equal(result["ccsds_qf"].values, [0, ImapHiL1bDeFlags.SPIN_INVALID, 0])

Updated in 0c9b170.

subagonsouth · 2026-02-23T18:58:12Z

imap_processing/tests/hi/test_hi_l1b.py

+        expected = ImapHiL1bDeFlags.PACKET_FULL | ImapHiL1bDeFlags.SPIN_INVALID
+        assert result["ccsds_qf"].values[0] == expected
+        assert result["ccsds_qf"].values[1] == 0


Suggested change

expected = ImapHiL1bDeFlags.PACKET_FULL | ImapHiL1bDeFlags.SPIN_INVALID

assert result["ccsds_qf"].values[0] == expected

assert result["ccsds_qf"].values[1] == 0

np.testing.assert_array_equal(

result["ccsds_qf"].values,

[ImapHiL1bDeFlags.PACKET_FULL | ImapHiL1bDeFlags.SPIN_INVALID, 0],

)

Updated in 0c9b170.

subagonsouth

@copilot please see my comments and fix the issues that I identified.

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

subagonsouth

@copilot, please evaluate if np.testing.assert_equal, or np.testing.assert_array_equal should be used and make both cases use the same.

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot · 2026-02-23T19:04:48Z

@copilot, please evaluate if np.testing.assert_equal, or np.testing.assert_array_equal should be used and make both cases use the same.

Both cases now use np.testing.assert_array_equal consistently (b803706).

subagonsouth · 2026-02-23T19:08:40Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

subagonsouth

LGTM

laspsandoval

Looks good. A couple of things to think about.

imap_processing/quality_flags.py

imap_processing/hi/hi_l1b.py

subagonsouth · 2026-02-23T21:14:47Z

@copilot, please make two changes based on reviews.

modify ImapHiL1bDeFlags to inherit from ENAFlags and use ENAFlags existing BADSPIN flag.
Update the VAR_NOTES attribute in imap_hi_variable_attrs.yaml to include the new flag description.

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot · 2026-02-23T21:17:48Z

@copilot, please make two changes based on reviews.

modify ImapHiL1bDeFlags to inherit from ENAFlags and use ENAFlags existing BADSPIN flag.

Update the VAR_NOTES attribute in i...

Done in da732c2. ImapHiL1bDeFlags now uses BADSPIN = ENAFlags.BADSPIN (bit 2) following the same pattern as ImapHkUltraFlags and ImapLoFlags (direct inheritance is not possible in Python 3.12 for enums with existing members). The VAR_NOTES for hi_de_ccsds_qf in imap_hi_variable_attrs.yaml now includes the Bit 2 / BADSPIN description.

subagonsouth · 2026-02-23T21:21:32Z

pre-commit.ci autofix

for more information, see https://pre-commit.ci

Initial plan

90362a6

Copilot AI assigned Copilot and subagonsouth Feb 23, 2026

Copilot started work on behalf of subagonsouth February 23, 2026 18:45 View session

Hi L1B DE: carry last_spin_num into L1B and add SPIN_INVALID quality …

3d5faa7

…flag Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Carry last_spin_num into L1B and add spin_invalid quality flag~~ Hi L1B DE: carry last_spin_num into output and add SPIN_INVALID ccsds_qf flag Feb 23, 2026

Copilot AI requested a review from subagonsouth February 23, 2026 18:52

Copilot finished work on behalf of subagonsouth February 23, 2026 18:53

subagonsouth reviewed Feb 23, 2026

View reviewed changes

Copilot started work on behalf of subagonsouth February 23, 2026 18:59 View session

Use np.testing assertions in SPIN_INVALID test methods

0c9b170

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot AI requested a review from subagonsouth February 23, 2026 19:01

Copilot finished work on behalf of subagonsouth February 23, 2026 19:01

subagonsouth reviewed Feb 23, 2026

View reviewed changes

Copilot started work on behalf of subagonsouth February 23, 2026 19:03 View session

Use np.testing.assert_array_equal consistently in SPIN_INVALID tests

b803706

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot AI requested a review from subagonsouth February 23, 2026 19:05

Copilot finished work on behalf of subagonsouth February 23, 2026 19:05

subagonsouth marked this pull request as ready for review February 23, 2026 19:07

[pre-commit.ci] auto fixes from pre-commit.com hooks

56ed0e6

for more information, see https://pre-commit.ci

subagonsouth requested review from laspsandoval, maxinelasp and tech3371 February 23, 2026 19:58

subagonsouth approved these changes Feb 23, 2026

View reviewed changes

laspsandoval approved these changes Feb 23, 2026

View reviewed changes

imap_processing/quality_flags.py Outdated Show resolved Hide resolved

imap_processing/hi/hi_l1b.py Outdated Show resolved Hide resolved

Copilot started work on behalf of subagonsouth February 23, 2026 21:15 View session

Use ENAFlags.BADSPIN in ImapHiL1bDeFlags and update ccsds_qf VAR_NOTES

da732c2

Co-authored-by: subagonsouth <16110870+subagonsouth@users.noreply.github.com>

Copilot AI changed the title ~~Hi L1B DE: carry last_spin_num into output and add SPIN_INVALID ccsds_qf flag~~ Hi L1B DE: carry last_spin_num into output and add BADSPIN ccsds_qf flag Feb 23, 2026

Copilot AI requested a review from subagonsouth February 23, 2026 21:18

Copilot finished work on behalf of subagonsouth February 23, 2026 21:18

[pre-commit.ci] auto fixes from pre-commit.com hooks

e39cd57

for more information, see https://pre-commit.ci

subagonsouth merged commit 67cf8d8 into dev Feb 24, 2026
14 checks passed

subagonsouth deleted the copilot/carry-last-spin-num-to-l1b branch February 24, 2026 16:33

Conversation

Copilot AI commented Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

Comments on the Issue (you are @copilot in this section)

Uh oh!

subagonsouth Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

subagonsouth Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

subagonsouth left a comment

Choose a reason for hiding this comment

Uh oh!

subagonsouth left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Feb 23, 2026

Uh oh!

subagonsouth commented Feb 23, 2026

Uh oh!

subagonsouth left a comment

Choose a reason for hiding this comment

Uh oh!

laspsandoval left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

subagonsouth commented Feb 23, 2026

Uh oh!

Copilot AI commented Feb 23, 2026

Uh oh!

subagonsouth commented Feb 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 23, 2026 •

edited

Loading