Add dr return mode to find_dynamic_range()#19
Open
Riz1Asif wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an explicit mode="dr" return option to find_dynamic_range() so callers can obtain the frequency-dependent dynamic-range spectrum directly, aligning the public API more closely with the underlying DR-based computation.
Changes:
- Add
mode="dr"to return the computed dynamic-range spectrum (as a 2D array stacked withfrequencies). - Update the
find_dynamic_range()docstring to describe modes/returns more clearly. - Normalize
frequencies,refractive_index, and (in boundaries mode)absorption_coefficientto NumPy arrays and raise on invalidmode.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This PR adds a mode="dr" option to find_dynamic_range() to return the frequency-dependent dynamic range spectrum directly.
Currently, the function name suggests that dynamic range itself is the main quantity of interest, but the exposed outputs are primarily derived quantities such as amax, amaxd, and boundaries. Returning the DR spectrum directly makes the function behavior more transparent and aligns the API more closely with the underlying implementation.
This PR: