Repository navigation
Warn about unrealistic bounds and initial guesses - #179
Open
vishrutgrover wants to merge 1 commit into
Open
vishrutgrover wants to merge 1 commit into
vishrutgrover wants to merge 1 commit into
Conversation
This branch has not been deployed
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.
Describe the changes you have made in this PR
Adds
OsipiBase.osipi_check_bounds_and_initial_guess(), which warns (UserWarning) when user-provided fit settings look unrealistic:REALISTIC_BOUND_RANGES— the same ranges already asserted for default bounds intest_default_bounds_and_initial_guesses(D and Dp in mm²/s, normalised signal). This catches e.g. diffusivities given in µm²/ms.The check runs once per object: when an algorithm is initiated via
OsipiBase(algorithm=...), it runs in the second__init__call only, so warnings are not duplicated. It is a warning only, fitting behaviour is unchanged. The generic and body-part defaults raise no warnings.Example (D and Dp given in µm²/ms):
New tests in
tests/IVIMmodels/unit_tests/test_bounds_initial_guess_check.py(16 cases). Full suite locally (macOS, Python 3.11): 711 passed, 0 failed (695 before + 16 new).Link this PR to an issue [optional]
Fixes #176
Checklist
Contributor: Vishrut Grover