Support for recorded source/mic directivities from DIRPAT database (#259) #302

fakufaku · 2023-02-02T02:55:19Z

This PR is to integrate the work done by @prerak23 into the master branch:

Generalize for other SOFA files

The goal is to generalize what has been done for DIRPAT by @prerak23 to all SOFA files.
The target syntax is as follows.

# the file reader object reads the file and optionally performs interpolation
# if the file contains multiple directivities, they are all read
hrtf = MeasuredDirectivityFile(
    path="hrtf_file.sofa",
    fs=fs,
    interp_order=12,
    interp_n_points=1000,
)

# orientations can be provided as rotation matrices
orientation = Rotation3D([colatitude_deg, azimuth_deg], "yz", degrees=True)

# we can then choose which directivities we want from the file
dir_left = hrtf.get_mic_directivity("left", orientation=orientation)
dir_right = hrtf.get_mic_directivity("right", orientation=orientation)

TODO

documentation
changelog
Read multiple objects from a single file to be able to simulate mic arrays more smoothly, e.g. eigenmike. This could be implemented by detecting the multiple channels after the call to get_response that would return a (n_image_sources, n_channels, n_taps) array.
Implement 3D rotations with Euler angles

Co-authored-by: prerak23 prerak23@github.com

Thanks for sending a pull request (PR), we really appreciate that! Before hitting the submit button, we'd be really glad if you could make sure all the following points have been cleared.

Please also refer to the doc on contributing for more details. Even if you can't check all the boxes below, do not hesitate to go ahead with the PR and ask for help there.

Are there docstrings ? Do they follow the numpydoc style ?
Have you run the tests by doing nosetests or py.test at the root of the repo ?
Have you checked that the doc builds properly and that any new file has been added to the repo ? How to do that is covered in the documentation.
Is there a unit test for the proposed code modification ? If the PR addresses an issue, the test should make sure the issue is fixed.
Last but not least, did you document the proposed change in the CHANGELOG file ? It should go under "Unreleased".

Happy PR 😃

) * This is a pretty big commit that includes loading recorded directivity files and using them in the simulation * Supports source/receiver for shoebox rooms * Interpolation in spherical harmonic domain * Adds option for using minimum phase filters --------- Co-authored-by: prerak23 <prerak23@github.com>

…r the SOFA directivities. Adds samples some pre-generated samples for the tests. Removes some print statements from room.py.

…rical/cartesian conversion functions from doa sub-package. Adds a generalized pinv computation function. Adds a new plotting function. Moves doa sub-package fibonacci mapping to a dedicated function to make it available everywhere.

…ation. Adds also a generalized version of the method for the case where the measurement points are not on a grid. Adds tests for all this. Changes the regression test data files for sofa interpolation.

…s. Modifies slightly doa.GridSphere object so that it can be used to hold simple spherical grids without overhead.

… interpolations

…ore SOFA files. Fixes a bug with using cardioid/sofa responses where the cardioid would expect degrees, but got radians. Re-generates the test files for SOFA measured respones. Fixes a bug in DirectionVector where the degrees argument for the getter methods of azimuth and colatitude was ignored.

…naural simulation

…sub-package

…file. also modifies download function to avoid a fail when internet is not available

…kes API more consistent.

… test for correctness based on the energy integral on the sphere.

…arate classes wrapper instead (Cardioid, Sub-cardioid, etc). Adds Rotation3D class to apply arbitrary rotations to measured directivities.

… to cartesian coordinates. Re-generates the test file after visual inspection.

fakufaku · 2024-05-28T07:13:58Z

@prerak23
How are you doing?
I have made good progress, and I am feeling good about releasing things soon.
Would you mind taking a look at the current code?
I have also created some documentation here
(I don't have your new email address, so please send me an email)

prerak23 · 2024-06-13T13:33:39Z

examples/directivities/plot_directivity_3D.py

 orientation = DirectionVector(azimuth=0, colatitude=45, degrees=True)

 # create cardioid object
-dir_obj = CardioidFamily(orientation=orientation, pattern_enum=pattern)
+dir_obj = HyperCardioid(orientation=orientation)

 # plot
 azimuth = np.linspace(start=0, stop=360, num=361, endpoint=True)


For colatitude, shouldn't the "num" be equal to 181?

prerak23 · 2024-06-13T14:09:30Z

examples/directivities/simulate_binaural_recording.py

+    interp_n_points = 1000
+
+    fs, speech = wavfile.read(args.source)
+    speech = speech * (0.95 / abs(speech).max())


Are we normalizing speech signals here? Curious to know why?

prerak23 · 2024-06-13T14:26:06Z

examples/directivities/simulation_with_measured_directivity.py

+dir_obj_Dmic = akg.get_mic_directivity("AKG_c414K", orientation=rot_54_73)
+dir_obj_Emic = eigenmike.get_mic_directivity("EM_32_9", orientation=rot_54_73)
+
+dir_obj_Cmic = FigureEight(


Do you think it is good to comment here that the mic response is analytic for this case ?

prerak23 · 2024-06-13T14:37:27Z

pyroomacoustics/data/sofa/mit_kemar_large_pinna.sofa

This seems to be a new addition, with the past code I haven't experimented with HRTF's.

prerak23 · 2024-06-13T17:31:46Z

pyroomacoustics/acoustics.py

 from scipy.fftpack import dct
 from scipy.interpolate import interp1d
-from scipy.signal import butter, fftconvolve, sosfiltfilt
+from scipy.signal import butter, fftconvolve, hilbert, sosfiltfilt


Haven't found the usage of Hilbert transform in this file.

prerak23 and others added 5 commits February 2, 2023 11:53

merge with master

63d13f8

remove deprecated np.float type alias from numpy. run black

4274ec2

isort

8853437

isort

02af651

fakufaku mentioned this pull request Feb 8, 2023

Refactor of room.py and finalize of DIRPat pull request #305

Open

5 tasks

fakufaku added 2 commits February 9, 2023 18:09

Adds download functions for the SOFA files from DIRPAT. Adds tests fo…

76f8b96

…r the SOFA directivities. Adds samples some pre-generated samples for the tests. Removes some print statements from room.py.

Adds workaround to CI for windows and py3.7

88e1c5b

fakufaku force-pushed the dev/dirpat branch from 2f1dcf2 to 88e1c5b Compare February 9, 2023 09:33

fakufaku added 20 commits February 10, 2023 13:11

Changes the EM32 sofa file url to official url

a2e1080

Fixes the weights in the weighted pseudo-inverse used in the interpol…

910e5b5

…ation. Adds also a generalized version of the method for the case where the measurement points are not on a grid. Adds tests for all this. Changes the regression test data files for sofa interpolation.

Moves SOFA open function out of the DIRPATInterpolate class.

1a45b7c

Separates the spherical interpolation from the DIRPAT and SOFA classe…

70a562e

…s. Modifies slightly doa.GridSphere object so that it can be used to hold simple spherical grids without overhead.

Merge branch 'master' into dev/dirpat

b662934

Vectorizes the spherical harmonics computation function for spherical…

683b498

… interpolations

Moves the regular grid detection function to doa.utils

7507118

black/isort

079bb1e

black/sort

5958ce0

Adds support sofe simple hrir sofa files

b6ff1cb

Adds two SOFA files for MIT Kemar HRTF. Adds an example script for bi…

f558bfc

…naural simulation

merge master

f76ca8f

Modularize the RIR building routines for ISM and RT

bdb8309

Fixing tests for sofa files

32269ae

Adds simulation sub-package in list in setup.py

92e4007

Adds init file for simulation sub-package

9b38cca

fix sofa test

88a9c54

ray tracing: adds air absorption, linear interpolation of histogram

4922a0e

fakufaku mentioned this pull request Jun 14, 2023

Speech directivity #317

Open

5 tasks

fakufaku added 22 commits May 26, 2024 17:34

merge

e96f4ee

relocates the from directivities to simulation/ism

b6aa302

fixes source_angle_shoebox test

9fb7ba7

refactors directivities sub-module and sofa sub-module into a single …

7874a01

…sub-package

fixes sofa db to include files that are present, but not in the json …

ccacfed

…file. also modifies download function to avoid a fail when internet is not available

SOFA measurement labels are read from the database when available. Ma…

65107c4

…kes API more consistent.

removes unnecessary imports and lint

26f4a32

Merge branch 'master' into dev/dirpat

b1a0357

CHANGELOG formatting for branch

120ac43

merge

1d09fb8

Fixes the cardioid family formula in the corresponding object. Adds a…

f866eb8

… test for correctness based on the energy integral on the sphere.

lint

b3917a0

changes the interface for cardioid family. Removes the enum, uses sep…

d8d79ea

…arate classes wrapper instead (Cardioid, Sub-cardioid, etc). Adds Rotation3D class to apply arbitrary rotations to measured directivities.

lint

d392bb6

Changes the KDTree in MeasuredDirectivity from operating on spherical…

d48a899

… to cartesian coordinates. Re-generates the test file after visual inspection.

Adds directivities (analytic and measured) to the documentation.

e845041

adds soxr to requirements for doc building

f89e815

Doc

8d24c10

Disallow directivities for 2D rooms.

d7371a8

Fixes directivities examples

5e1334f

lint

200e875

Fixes some docstrings

b6d9a6c

fakufaku self-assigned this May 28, 2024

fakufaku requested a review from prerak23 May 28, 2024 07:14

prerak23 reviewed Jun 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for recorded source/mic directivities from DIRPAT database (#259) #302

Support for recorded source/mic directivities from DIRPAT database (#259) #302

fakufaku commented Feb 2, 2023 •

edited

Loading

fakufaku commented May 28, 2024

prerak23 Jun 13, 2024 •

edited

Loading

prerak23 Jun 13, 2024

prerak23 Jun 13, 2024

prerak23 Jun 13, 2024

prerak23 Jun 13, 2024

Support for recorded source/mic directivities from DIRPAT database (#259) #302

Are you sure you want to change the base?

Support for recorded source/mic directivities from DIRPAT database (#259) #302

Conversation

fakufaku commented Feb 2, 2023 • edited Loading

Generalize for other SOFA files

TODO

fakufaku commented May 28, 2024

prerak23 Jun 13, 2024 • edited Loading

Choose a reason for hiding this comment

prerak23 Jun 13, 2024

Choose a reason for hiding this comment

prerak23 Jun 13, 2024

Choose a reason for hiding this comment

prerak23 Jun 13, 2024

Choose a reason for hiding this comment

prerak23 Jun 13, 2024

Choose a reason for hiding this comment

fakufaku commented Feb 2, 2023 •

edited

Loading

prerak23 Jun 13, 2024 •

edited

Loading