feature/add_schroeder_frequency_function #101
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,39 @@ | |
| """ | ||
| import numpy as np | ||
|
|
||
| def schroeder_frequency(V, T): | ||
| r""" | ||
| function which calculates the Schroeder frequency. The cut-off | ||
| frequency for modes. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Please add the source - the citation is broken
Author
There was a problem hiding this comment. nice hint, but we don´t know how ... seems as broken as for energy_decay_curve_analytic function below. |
||
| Approved by Monty Python Flying Circus. | ||
|
Contributor
There was a problem hiding this comment. We appreciate Your sense of humour, although this should be a serious scientific documentation. |
||
|
|
||
| .. math:: | ||
|
|
||
| f_s = 2000 * \sqrt(\frac{T}{V}) | ||
|
|
||
| Parameters | ||
| ---------- | ||
| V : float, np.ndarray | ||
|
Contributor
There was a problem hiding this comment. Please follow the variable naming convention adopted in the project, i.e.: |
||
| room volume in m^3 | ||
| T : float, np.ndarray | ||
| reverberation time in s | ||
|
|
||
| Returns | ||
| ------- | ||
| schroeder_freq : float, np.ndarray | ||
|
Contributor
There was a problem hiding this comment. The documentation return statement does not match the actual return variable name. Please repair and change to schroeder_frequency according to convention |
||
| 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 |
||
| f_s = 2000*np.sqrt(T / V) | ||
|
|
||
| return f_s | ||
|
|
||
| def energy_decay_curve_analytic( | ||
| surfaces, alphas, volume, times, source=None, | ||
| receiver=None, method='eyring', c=343.4, frequency=None, | ||
|
|
||
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, change the sentence to: Calculate the Schroeder cut-off frequency of a room