Skip to content

Refactor: make preprocess rir private #165

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
f-brinkmann merged 2 commits into from
Mar 19, 2026
Merged

Refactor: make preprocess rir private #165

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
5283074
make the preprocess_rir a private function
mberz Mar 19, 2026
e311999
update docstring
f-brinkmann Mar 19, 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
4 changes: 2 additions & 2 deletions pyrato/dsp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def estimate_noise_energy(
shape of the input Signal.
"""

energy_data = preprocess_rir(
energy_data = _preprocess_rir(
data,
is_energy=is_energy,
shift=False,
Expand Down Expand Up @@ -182,7 +182,7 @@ def _smooth_rir(
return time_window_data, time_vector_window, time_vector


def preprocess_rir(
def _preprocess_rir(
data,
is_energy=False,
shift=False,
Expand Down
12 changes: 6 additions & 6 deletions pyrato/edc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ def energy_decay_curve_truncation(
shape = data.time.shape
data = data.flatten()

energy_data = dsp.preprocess_rir(
energy_data = dsp._preprocess_rir(
data,
is_energy=is_energy,
shift=time_shift,
Expand Down Expand Up @@ -451,7 +451,7 @@ def energy_decay_curve_lundeby(
shape = data.time.shape
data = data.flatten()

energy_data = dsp.preprocess_rir(
energy_data = dsp._preprocess_rir(
data,
is_energy=is_energy,
shift=time_shift,
Expand Down Expand Up @@ -607,7 +607,7 @@ def energy_decay_curve_chu(
shape = data.cshape
data = data.flatten()

energy_data = dsp.preprocess_rir(
energy_data = dsp._preprocess_rir(
data,
is_energy=is_energy,
shift=time_shift,
Expand Down Expand Up @@ -756,7 +756,7 @@ def energy_decay_curve_chu_lundeby(
shape = data.time.shape
data = data.flatten()

energy_data = dsp.preprocess_rir(
energy_data = dsp._preprocess_rir(
data,
is_energy=is_energy,
shift=time_shift,
Expand Down Expand Up @@ -930,7 +930,7 @@ def intersection_time_lundeby(
# Dynamic range 10 ... 20 dB
use_dyn_range_for_regression = 20

energy_data = dsp.preprocess_rir(
energy_data = dsp._preprocess_rir(
data,
is_energy=is_energy,
shift=time_shift,
Expand Down Expand Up @@ -1094,7 +1094,7 @@ def _intersection_time_lundby(
noise_estimation : float
The energy of the background noise.
energy_data : np.ndarray
Data returned by ``pyrato.dsp.preprocess_rir``.
Data returned by ``pyrato.dsp._preprocess_rir``.
time_vector_window : ndarray
The time vector of the smoothed data obtained from
``pyrato.dsp._smooth_rir``.
Expand Down
12 changes: 6 additions & 6 deletions tests/test_data/generate_test_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,19 +76,19 @@
noise_energy_2D = pyrato.estimate_noise_energy(
rir_array, interval=[0.9, 1.0], is_energy=False)

preprocessing_1D = pyrato.dsp.preprocess_rir(
preprocessing_1D = pyrato.dsp._preprocess_rir(
rir_array[0], is_energy=False, shift=False, channel_independent=False)
preprocessing_2D = pyrato.dsp.preprocess_rir(
preprocessing_2D = pyrato.dsp._preprocess_rir(
rir_array, is_energy=False, shift=False, channel_independent=False)

preprocessing_time_shift_1D = pyrato.dsp.preprocess_rir(
preprocessing_time_shift_1D = pyrato.dsp._preprocess_rir(
rir_array[0], is_energy=False, shift=True, channel_independent=False)
preprocessing_time_shift_2D = pyrato.dsp.preprocess_rir(
preprocessing_time_shift_2D = pyrato.dsp._preprocess_rir(
rir_array, is_energy=False, shift=True, channel_independent=False)

preprocessing_time_shift_channel_independent_1D = pyrato.dsp.preprocess_rir(
preprocessing_time_shift_channel_independent_1D = pyrato.dsp._preprocess_rir(
rir_array[0], is_energy=False, shift=True, channel_independent=True)
preprocessing_time_shift_channel_independent_2D = pyrato.dsp.preprocess_rir(
preprocessing_time_shift_channel_independent_2D = pyrato.dsp._preprocess_rir(
rir_array, is_energy=False, shift=True, channel_independent=True)

smoothed_rir_1D = pyrato.dsp._smooth_rir(
Expand Down
12 changes: 6 additions & 6 deletions tests/test_dsp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def test_preprocessing_1D():
os.path.join(test_data_path, 'analytic_rir_psnr50_1D.csv'),
delimiter=',')
rir = pf.Signal(rir, 1)
actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=False,
Expand All @@ -123,7 +123,7 @@ def test_preprocessing_2D():
delimiter=',')
rir = pf.Signal(rir, 1)

actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=False,
Expand All @@ -141,7 +141,7 @@ def test_preprocessing_time_shift_1D():
delimiter=',')
rir = pf.Signal(rir, 1)

actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=True,
Expand All @@ -164,7 +164,7 @@ def test_preprocessing_time_shift_2D():
os.path.join(test_data_path, 'preprocessing_time_shift_2D.csv'),
delimiter=','))

actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=True,
Expand All @@ -184,7 +184,7 @@ def test_preprocessing_time_shift_channel_independent_1D():
'preprocessing_time_shift_channel_independent_1D.csv'),
delimiter=','))

actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=True,
Expand All @@ -203,7 +203,7 @@ def test_preprocessing_time_shift_channel_independent_2D():
'preprocessing_time_shift_channel_independent_2D.csv'),
delimiter=','))

actual = dsp.preprocess_rir(
actual = dsp._preprocess_rir(
rir,
is_energy=False,
shift=True,
Expand Down
Loading