Refactor the parametric energy decay curve function#74
Merged
Conversation
ahms5
requested changes
Oct 10, 2025
Member
ahms5
left a comment
ahms5
left a comment
There was a problem hiding this comment.
why is this PR called refactor if a new method is added?
github-project-automation
bot
moved this from Drafting Phase
to Require review
in Weekly Planning
Member
Author
This PR was not ready for review, yet ;) When it's ready it will replace the function |
github-project-automation
bot
moved this from Require review
to Done
in Weekly Planning
mberz
requested review from
a team,
SimonBuechner,
ahms5,
artur-pa,
f-brinkmann and
hoyer-a
f-brinkmann
requested changes
Mar 18, 2026
Member
f-brinkmann
left a comment
f-brinkmann
left a comment
There was a problem hiding this comment.
Made a suggestion to improve the docs and simplify the computation (not tested if the latter works)
pyrato/parametric.py
Outdated
Comment on lines
+72
to
+78
| shape = np.broadcast_shapes(energy.shape, reverberation_time.shape) | ||
| try: | ||
| energy = np.broadcast_to(energy, shape) | ||
| except ValueError as error: | ||
| raise ValueError( | ||
| "Reverberation time and energy must have the same shape.", | ||
| ) from error |
Member
There was a problem hiding this comment.
I think this only works one way. How about using
Suggested change
| shape = np.broadcast_shapes(energy.shape, reverberation_time.shape) | |
| try: | |
| energy = np.broadcast_to(energy, shape) | |
| except ValueError as error: | |
| raise ValueError( | |
| "Reverberation time and energy must have the same shape.", | |
| ) from error | |
| try: | |
| shape = np.broadcast_shapes(energy.shape, reverberation_time.shape) | |
| except ValueError as error: | |
| raise ValueError( | |
| "Reverberation time and energy must be broadcastable to the same shape.", | |
| ) from error |
If we then do
times = np.broadcast_to(times, shape + (times.size, ))the reshaping and transposing below might not be requried anymore because of exploting automatic broadcasting.
Member
Author
There was a problem hiding this comment.
Seems to not work like that.
Member
Author
There was a problem hiding this comment.
I've adapted your suggestion, though
pyrato/parametric.py
Outdated
Comment on lines
+29
to
+32
| reverberation_time : float | numpy.ndarray[float] | ||
| The reverberation time in seconds. | ||
| energy : float | numpy.ndarray[float], optional | ||
| The initial energy of the sound field, by default 1. |
Member
There was a problem hiding this comment.
It took me a little while to figure out
- that mulriple EDCs will be computed if one of these is array like and
- that they must be broadcastable (I also made a note below that might make things more flexible)
Can you please add a note on this here?
hoyer-a
requested changes
Mar 18, 2026
f-brinkmann
approved these changes
Mar 18, 2026
Member
f-brinkmann
left a comment
f-brinkmann
left a comment
There was a problem hiding this comment.
Thanks. Only docstring suggestions left. Approved otherwise.
pyrato/parametric.py
Outdated
| times : numpy.ndarray[float] | ||
| The times at which the energy decay curve is evaluated. | ||
| reverberation_time : float | numpy.ndarray[float] | ||
| The reverberation time in seconds. If an array is passed, a energy |
Member
There was a problem hiding this comment.
teeny tiny typo
Suggested change
| The reverberation time in seconds. If an array is passed, a energy | |
| The reverberation time in seconds. If an array is passed, an energy |
pyrato/parametric.py
Outdated
Comment on lines
+34
to
+36
| ``reverberation_time`` is an array, the shape of ``energy`` is required | ||
| to match the shape or be broadcastable to the shape of | ||
| ``reverberation_time``. |
Member
There was a problem hiding this comment.
I think we agreed to have parameters in italics:
Suggested change
| ``reverberation_time`` is an array, the shape of ``energy`` is required | |
| to match the shape or be broadcastable to the shape of | |
| ``reverberation_time``. | |
| `reverberation_time` is an array, the shape of `energy` is required | |
| to match the shape or be broadcastable to the shape of | |
| `reverberation_time`. |
mberz
force-pushed
the
refactor/parametric_edc
branch
from
d9f11b5 to
7f72db0
Compare
- uses reverbation time as input instead of geometry - returns pf.TimeData object - independent of sabine/eyring equations
Co-authored-by: Anton Hoyer <156099087+hoyer-a@users.noreply.github.com>
mberz
force-pushed
the
refactor/parametric_edc
branch
from
7f72db0 to
f6ce872
Compare
github-project-automation
bot
moved this from Require review
to Done
in Weekly Planning
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
4 participants
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.
Changes to the function
We should also remove support for Python < 3.11 in a different PR