Skip to content

Commit d9f11b5

Browse files
committed
reviewer comments
1 parent 03ea4cf commit d9f11b5

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

pyrato/parametric.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,19 @@ def energy_decay_curve(
2727
times : numpy.ndarray[float]
2828
The times at which the energy decay curve is evaluated.
2929
reverberation_time : float | numpy.ndarray[float]
30-
The reverberation time in seconds. If an array is passed, a energy
30+
The reverberation time in seconds. If an array is passed, an energy
3131
decay curve is calculated for each reverberation time.
3232
energy : float | numpy.ndarray[float], optional
3333
The initial energy of the sound field, by default 1. If
34-
``reverberation_time`` is an array, the shape of ``energy`` is required
34+
`reverberation_time` is an array, the shape of `energy` is required
3535
to match the shape or be broadcastable to the shape of
36-
``reverberation_time``.
36+
`reverberation_time`.
3737
3838
Returns
3939
-------
4040
energy_decay_curve : pyfar.TimeData
41-
The energy decay curve.
41+
The energy decay curve with a ``cshape`` equal to the shape of
42+
the passed ``reverberation_time``.
4243
4344
Example
4445
-------
@@ -66,7 +67,7 @@ def energy_decay_curve(
6667
energy = np.asarray(energy)
6768
times = np.asarray(times)
6869

69-
if np.any(reverberation_time < 0):
70+
if np.any(reverberation_time <= 0):
7071
raise ValueError("Reverberation time must be greater than zero.")
7172

7273
if np.any(energy < 0):

0 commit comments

Comments
 (0)