Rename shadow factor to illumination factor #1214
Open
Conversation
This file contains hidden or 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
added 6 commits
December 10, 2025 23:23
schaubh
changed the title
schaubh
requested changes
Dec 11, 2025
| double shadowFactor; | ||
| } EclipseMsgPayload; | ||
|
|
||
| //! illuminationFactor alias to be used instead of shadowFactor. shadowFactor will be deprecarted by |
Contributor
There was a problem hiding this comment.
deprecated is miss-spelled.
| Eigen::Vector3d aHat_B; //!< [] (optional) unit direction vector of the sensor/communication boresight axis | ||
| double theta; //!< [r] (optional) sensor/communication half-cone angle, must be set if shat_B is specified | ||
| double theta_solar; //!< [r] (optional) illumination half-cone angle, treating aHat_B as the surface normal | ||
| double min_shadow_factor; //!< [] (optional) minimum amount of illumination due to eclipse necessary to observe |
Contributor
There was a problem hiding this comment.
You are changing a module variable which is a breaking change. Let's deprecate setting the old module variable name.
| \caption{Definition and Explanation of Variables Used.} | ||
| \centering \fontsize{10}{10}\selectfont | ||
| \begin{tabular}{ | m{5cm}| m{2cm} | m{1.5cm} | m{6cm} |} % Column formatting, | ||
| \begin{tabular}{ | m{5cm}| m{2cm} | m{1.5cm} | m{6cm} |} % Column formatting, |
Contributor
There was a problem hiding this comment.
if you update the TeX you also need to compile the TeX document and commit the updated PDF.
| # Forward direction: setting illuminationFactor updates shadowFactor | ||
| p.illuminationFactor = 0.8 | ||
| assert p.illuminationFactor == pytest.approx(0.8) | ||
| assert p.shadowFactor == pytest.approx(0.8) |
Contributor
There was a problem hiding this comment.
I'm not following what this test is doing? line 420 is still throwing a depreciation warning. When running all BSK unit tests, I should not be seeing a depreciation warning. If I added deprecated.filterwarnings("ignore", "p.shadowFactor") I still saw the deprecation warning.
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.
Description
The variable
shadowFactoris used to determine if a satellite is in the shadow of a planet, and if yes, by how much. A value of 1 meant the satellite was outside the shadow, and a value of 0 meant it was fully in the shadow. However, the name implies the opposite behavior. Thus, we are changing this variable name to reflect better describe what it does.This PR adopts a clearer name for the eclipse payload field:
illuminationFactor. For backward compatibility,shadowFactorcontinues to work and is formally deprecated until Dec 31, 2026.C / C++
EclipseMsgPayloadstill stores:double shadowFactor;illuminationFactoris introduced as a preprocessor alias toshadowFactorPython / SWIG
EclipseMsgPayload.illuminationFactoris exposed as a property that delegates to the same getter/setter asshadowFactor(no behavior or performance changes).EclipseMsgPayload.shadowFactorremains available but:Basilisk.utilities.deprecated.deprecationWarn) up to 2026-12-31.EclipseMsgRecorder(fromeclipseMsg.recorder()) now also supports:recorder.illuminationFactor→ alias forrecorder.shadowFactorso log access uses the new name without breaking existing code.
Modules / Files Touched
architecture/msgPayloadDefC/EclipseMsgPayload.hilluminationFactoralias and associated comments.architecture/messaging/msgAutoSource/msgInterfacePy.i.inilluminationFactorproperty onEclipseMsgPayload.shadowFactorwith deprecation behavior.EclipseMsgRecorderto handleilluminationFactorin logs.illuminationFactorwhile remaining compatible withshadowFactor.Verification
test_shadow_vs_illumination_alias_and_deprecation_behaviorvalidates:illuminationFactorandshadowFactorstay numerically in sync.shadowFactoremits a deprecation warning (checked withpytest.warns).shadowFactorto raise an error whileilluminationFactorcontinues to work.Documentation
illuminationFactoras the preferred name.shadowFactoras deprecated and scheduled for removal after Dec 31, 2026.Future work
Remove the C macro alias and the Python
shadowFactornaming