Skip to content

rename truncate_energy_decay_curve #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mberz merged 2 commits into from
Feb 10, 2026
Merged

rename truncate_energy_decay_curve #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfc5b43
rename truncate_energy_decay_curve
f-brinkmann Jan 30, 2026
f4fae38
Apply code review
f-brinkmann Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions pyrato/edc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ def energy_decay_curve_truncation(
ch, :int(intersection_time_idx[ch])],
is_energy=True)

energy_decay_curve = _truncate_energy_decay_curve(
energy_decay_curve = _threshold_energy_decay_curve(
energy_decay_curve, trunc_levels)

if normalize:
Expand Down Expand Up @@ -597,7 +597,7 @@ def energy_decay_curve_chu(
psnr = dsp.peak_signal_to_noise_ratio(
data, noise_level, is_energy=is_energy)
trunc_levels = 10*np.log10((psnr)) - threshold
edc = truncate_energy_decay_curve(edc, trunc_levels)
edc = threshold_energy_decay_curve(edc, trunc_levels)

edc = edc.reshape(shape)

Expand Down Expand Up @@ -1135,7 +1135,23 @@ def intersection_time_lundeby(
return intersection_time, reverberation_time, noise_level


def _truncate_energy_decay_curve(energy_decay_curve, threshold_level):
def _threshold_energy_decay_curve(energy_decay_curve, threshold_level):
"""
Threshold an energy decay curve.

Parameters
----------
energy_decay_curve : array like
The energy decay curve
threshold_level : float
The threshold level in dB. The data below the threshold level are set
to ``numpy.nan`` values.

Returns
-------
energy_decay_curve : numpy.ndarray
The thresholded energy decay curve
"""

edc = np.atleast_2d(energy_decay_curve)
threshold_level = np.atleast_2d(threshold_level)
Expand All @@ -1148,18 +1164,24 @@ def _truncate_energy_decay_curve(energy_decay_curve, threshold_level):
return edc


def truncate_energy_decay_curve(energy_decay_curve, threshold):
"""Truncate an energy decay curve, discarding values below the threshold.
def threshold_energy_decay_curve(energy_decay_curve, threshold):
"""
Threshold an energy decay curve.

Parameters
----------
energy_decay_curve : pyfar.TimeData
The energy decay curve
threshold : float
The threshold level in dB. The data below the threshold level are set
to numpy.nan values.
to ``numpy.nan`` values.

Returns
-------
energy_decay_curve : pyfar.TimeData
The thresholded energy decay curve
"""
return pf.TimeData(
_truncate_energy_decay_curve(energy_decay_curve.time, threshold),
_threshold_energy_decay_curve(energy_decay_curve.time, threshold),
energy_decay_curve.times,
energy_decay_curve.comment)
8 changes: 4 additions & 4 deletions tests/test_edc_noise_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ def test_intersection_time_2D():
npt.assert_allclose(actual, expected)


def test_energy_decay_curve_threshold():
def test__threshold_energy_decay_curve():

t_60 = 1
m = -60/t_60
Expand All @@ -274,15 +274,15 @@ def test_energy_decay_curve_threshold():

edc_log = np.tile(edc_log, (2, 3, 1))

edc = enh._truncate_energy_decay_curve(10**(edc_log.copy()/10), 30)
edc = enh._threshold_energy_decay_curve(10**(edc_log.copy()/10), 30)

edc_ref = 10**(edc_log.copy()/10)
edc_ref[..., n_samples//2:] = np.nan

npt.assert_allclose(edc, edc_ref)


def test_truncate_energy_decay_curve():
def test_threshold_energy_decay_curve():
t_60 = 1
m = -60/t_60

Expand All @@ -293,7 +293,7 @@ def test_truncate_energy_decay_curve():
edc_log = np.tile(edc_log, (2, 3, 1))

edc = pf.TimeData(10**(edc_log.copy()/10), times)
edc_trunc = enh.truncate_energy_decay_curve(edc, 30)
edc_trunc = enh.threshold_energy_decay_curve(edc, 30)

edc_ref = 10**(edc_log.copy()/10)
edc_ref[..., n_samples//2:] = np.nan
Expand Down