1019 calculate instrument spin phase #1022
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add function get_spacecraft_to_instrument_spin_phase_offset Add test coverage for new geometry functions
tech3371
reviewed
Oct 16, 2024
imap_processing/spice/geometry.py
Outdated
| """ | ||
| Get the spin phase offset from the spacecraft to the instrument. | ||
|
|
||
| The spin phase offset is can be calculated using the instrument frame SPICE |
There was a problem hiding this comment.
Suggested change
| The spin phase offset is can be calculated using the instrument frame SPICE | |
| The spin phase offset can be calculated using the instrument frame SPICE |
| instrument_spin_phase_offset = get_spacecraft_to_instrument_spin_phase_offset( | ||
| instrument | ||
| ) | ||
| return (spacecraft_spin_phase + instrument_spin_phase_offset) % 1 |
There was a problem hiding this comment.
This % 1 is to get the [0, 1) range?
There was a problem hiding this comment.
Yes, that is correct. The s/c spin phase is in [0, 1) but then we add a positive offset value that is also in the range [0, 1), so we need to "unwind" the phase back into the [0, 1) range.
| ) | ||
| def test_get_instrument_spin_phase(instrument, fake_spin_data): | ||
| """Test coverage for get_instrument_spin_phase()""" | ||
| ets = np.array([7.5, 30, 61, 75, 106, 121, 136]) |
There was a problem hiding this comment.
Sure... that should be MET instead of ephemeris time (et) anyway.
tech3371
approved these changes
Oct 16, 2024
subagonsouth
merged commit f7b2467
into
IMAP-Science-Operations-Center:dev
17 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Overview
Adds two functions:
get_spacecraft_to_instrument_spin_phase_offset()This function provides the offset to apply to the spacecraft spin phase to get the instrument spin phase. For now, this is a hard coded table. In the future, it will most likely use SPICE to determine the phase offset.
get_instrument_spin_phase()This function just adds the offset to the spacecraft spin phase and does a modulus with 1 to return the phase to the [0, 1) range.
Updated Files
Closes: #1019