Add option to return pull_spots data to fit_grains#905
Merged
Conversation
If `return_pull_spots_data` is set to be `True`, spots data from `pull_spots()` will be returned from `fit_grains()`. This spots data is needed for spot diagnostic code. The new option defaults to `False`, so previous function calls will remain unchanged - the output should be the same. A test was also added that verifies the expected output is returned when `return_pull_spots_data` is set to `True`. Signed-off-by: Patrick Avery <patrick.avery@kitware.com>
bnmajor
approved these changes
Mar 10, 2026
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #905 +/- ##
==========================================
- Coverage 70.90% 70.90% -0.01%
==========================================
Files 143 143
Lines 22064 22074 +10
==========================================
+ Hits 15645 15652 +7
- Misses 6419 6422 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Overview
If
return_pull_spots_datais set to beTrue, spots data frompull_spots()will be returned fromfit_grains(). This spots data is needed for spot diagnostic code.The new option defaults to
False, so previous function calls will remain unchanged - the output should be the same.A test was also added that verifies the expected output is returned when
return_pull_spots_datais set toTrue.Affected Workflows
Only HEDM, and it's a new option that defaults to
False, so old scripts are not affected.