feature/add_schroeder_frequency_function #101
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,38 @@ | |
| """ | ||
| import numpy as np | ||
|
|
||
| def schroeder_frequency(volume, reverberation_time): | ||
| r""" | ||
| Calculate the Schroeder cut-off frequency of a room. | ||
|
|
||
| Calculation according to [#]_. | ||
|
|
||
| .. math:: | ||
|
|
||
| f_s = 2000 \sqrt{\left(\frac{T}{V}\right)} | ||
|
|
||
| Parameters | ||
| ---------- | ||
| volume : double, np.ndarray | ||
| room volume in m^3 | ||
| reverberation_time : double, np.ndarray | ||
| reverberation time in s | ||
|
|
||
| Returns | ||
| ------- | ||
| schroeder_frequency : float, np.ndarray | ||
| schroeder frequency in Hz | ||
|
|
||
| References | ||
| ---------- | ||
| .. [#] H. Kuttruff, Room acoustics, 4th Ed. Taylor & Francis, 2009. | ||
|
|
||
| """ | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Maybe you can do a validation check of the input parameters. For example, the volume needs to be greater than zero. 🔢
Member
There was a problem hiding this comment. here we could raise error, if the input parameters of the function are not valid. See the Guidelines |
||
| schroeder_frequency = 2000*np.sqrt(reverberation_time / volume) | ||
|
|
||
| return schroeder_frequency | ||
|
|
||
| def energy_decay_curve_analytic( | ||
| surfaces, alphas, volume, times, source=None, | ||
| receiver=None, method='eyring', c=343.4, frequency=None, | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add the source - the citation is broken
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice hint, but we don´t know how ... seems as broken as for energy_decay_curve_analytic function below.