diff --git a/docs/api_reference.rst b/docs/api_reference.rst index 6786912f..97ab956a 100644 --- a/docs/api_reference.rst +++ b/docs/api_reference.rst @@ -12,5 +12,8 @@ Modules .. toctree:: :maxdepth: 1 - modules/pyrato modules/analytic + modules/dsp + modules/edc + modules/parameters + modules/parametric diff --git a/docs/modules/analytic.rst b/docs/modules/analytic.rst index 1aac9c1b..9edcbe88 100644 --- a/docs/modules/analytic.rst +++ b/docs/modules/analytic.rst @@ -1,7 +1,8 @@ -analytic -======== +pyrato.analytic +=============== .. automodule:: pyrato.analytic :members: :undoc-members: :show-inheritance: + \ No newline at end of file diff --git a/docs/modules/pyrato.rst b/docs/modules/dsp.rst similarity index 52% rename from docs/modules/pyrato.rst rename to docs/modules/dsp.rst index e2cffe01..7a6c88ac 100644 --- a/docs/modules/pyrato.rst +++ b/docs/modules/dsp.rst @@ -1,7 +1,7 @@ -pyrato -====== +pyrato.dsp +========== -.. automodule:: pyrato +.. automodule:: pyrato.dsp :members: :undoc-members: :show-inheritance: diff --git a/docs/modules/edc.rst b/docs/modules/edc.rst new file mode 100644 index 00000000..dc74e9c1 --- /dev/null +++ b/docs/modules/edc.rst @@ -0,0 +1,7 @@ +pyrato.edc +========== + +.. automodule:: pyrato.edc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/parameters.rst b/docs/modules/parameters.rst new file mode 100644 index 00000000..33af477d --- /dev/null +++ b/docs/modules/parameters.rst @@ -0,0 +1,7 @@ +pyrato.parameters +================= + +.. automodule:: pyrato.parameters + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/parametric.rst b/docs/modules/parametric.rst new file mode 100644 index 00000000..63534f30 --- /dev/null +++ b/docs/modules/parametric.rst @@ -0,0 +1,7 @@ +pyrato.parametric +================= + +.. automodule:: pyrato.parametric + :members: + :undoc-members: + :show-inheritance: diff --git a/pyrato/dsp.py b/pyrato/dsp.py index 9a272fb4..ed4a83b0 100644 --- a/pyrato/dsp.py +++ b/pyrato/dsp.py @@ -211,7 +211,7 @@ def time_shift(signal, shift, circular_shift=True, unit='samples'): >>> import matplotlib.pyplot as plt >>> impulse = pf.signals.impulse( ... 32, amplitude=(1, 1.5, 1), delay=(14, 15, 16)) - >>> shifted = ra.time_shift(impulse, [-2, 0, 2]) + >>> shifted = ra.dsp.time_shift(impulse, [-2, 0, 2]) >>> pf.plot.use('light') >>> _, axs = plt.subplots(2, 1) >>> pf.plot.time(impulse, ax=axs[0]) @@ -228,7 +228,7 @@ def time_shift(signal, shift, circular_shift=True, unit='samples'): >>> import pyrato as ra >>> import matplotlib.pyplot as plt >>> impulse = pf.signals.impulse(32, delay=15) - >>> shifted = ra.time_shift(impulse, -10, circular_shift=False) + >>> shifted = ra.dsp.time_shift(impulse, -10, circular_shift=False) >>> pf.plot.use('light') >>> _, axs = plt.subplots(2, 1) >>> pf.plot.time(impulse, ax=axs[0]) diff --git a/pyrato/edc.py b/pyrato/edc.py index 026e5b2d..167438e6 100644 --- a/pyrato/edc.py +++ b/pyrato/edc.py @@ -114,7 +114,7 @@ def schroeder_integration(room_impulse_response, is_energy=False): ... L, source_pos, receiver_pos, ... reverberation_time=1, max_freq=1e3, n_samples=2**16, ... speed_of_sound=343.9) - >>> edc = ra.schroeder_integration(rir) + >>> edc = ra.edc.schroeder_integration(rir) >>> pf.plot.time(rir/np.abs(rir.time).max(), dB=True, label='RIR') >>> ax = pf.plot.time( ... edc/edc.time[..., 0], dB=True, log_prefix=10, label='EDC') @@ -251,7 +251,7 @@ def energy_decay_curve_truncation( ... rir.n_samples, rms=rir.time.max()*10**(-50/20), ... sampling_rate=rir.sampling_rate) >>> rir = rir + awgn - >>> edc = ra.energy_decay_curve_truncation(rir) + >>> edc = ra.edc.energy_decay_curve_truncation(rir) ... >>> ax = pf.plot.time(rir, dB=True, label='RIR') >>> pf.plot.time(edc, dB=True, log_prefix=10, label='EDC') @@ -389,7 +389,7 @@ def energy_decay_curve_lundeby( ... rir.n_samples, rms=rir.time.max()*10**(-50/20), ... sampling_rate=rir.sampling_rate) >>> rir = rir + awgn - >>> edc = ra.energy_decay_curve_lundeby(rir) + >>> edc = ra.edc.energy_decay_curve_lundeby(rir) ... >>> ax = pf.plot.time(rir, dB=True, label='RIR') >>> pf.plot.time(edc, dB=True, log_prefix=10, label='EDC') @@ -535,7 +535,7 @@ def energy_decay_curve_chu( ... rir.n_samples, rms=rir.time.max()*10**(-40/20), ... sampling_rate=rir.sampling_rate) >>> rir = rir + awgn - >>> edc = ra.energy_decay_curve_chu(rir) + >>> edc = ra.edc.energy_decay_curve_chu(rir) ... >>> pf.plot.time(rir/np.abs(rir.time).max(), dB=True, label='RIR') >>> ax = pf.plot.time( @@ -675,7 +675,7 @@ def energy_decay_curve_chu_lundeby( ... rir.n_samples, rms=rir.time.max()*10**(-50/20), ... sampling_rate=rir.sampling_rate) >>> rir = rir + awgn - >>> edc = ra.energy_decay_curve_chu_lundeby(rir) + >>> edc = ra.edc.energy_decay_curve_chu_lundeby(rir) ... >>> ax = pf.plot.time(rir, dB=True, label='RIR') >>> pf.plot.time(edc, dB=True, log_prefix=10, label='EDC') @@ -828,7 +828,7 @@ def intersection_time_lundeby( ... rir.n_samples, rms=rir.time.max()*10**(-40/20), ... sampling_rate=rir.sampling_rate) >>> rir = rir + awgn - >>> inter_time, _, noise_power = ra.intersection_time_lundeby(rir) + >>> inter_time, _, noise_power = ra.edc.intersection_time_lundeby(rir) ... >>> ax = pf.plot.time(rir, dB=True, label='RIR') >>> ax.axvline(inter_time, c='k', linestyle='--', label='$T_i$')