Skip to content

Add option to return pull_spots data to fit_grains#905

Merged
psavery merged 1 commit intomasterfrom
return-pull-spots-data
Mar 10, 2026
Merged

Add option to return pull_spots data to fit_grains#905
psavery merged 1 commit intomasterfrom
return-pull-spots-data

Conversation

@psavery
Copy link
Collaborator

@psavery psavery commented Mar 10, 2026

Overview

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.

Affected Workflows

Only HEDM, and it's a new option that defaults to False, so old scripts are not affected.

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>
@psavery psavery merged commit 261b7e6 into master Mar 10, 2026
14 of 15 checks passed
@codecov
Copy link

codecov bot commented Mar 10, 2026

Codecov Report

❌ Patch coverage is 69.23077% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 70.90%. Comparing base (625a795) to head (a42f5fa).
⚠️ Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
hexrd/hedm/fitgrains.py 69.23% 4 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants