Add AnechoicRoom class #224

duembgen · 2021-06-03T07:39:53Z

This pull request reopens #160, now against the new version of pyroomacoustics.

This will close issue #13.

I am working on polishing it and will remove the "WIP" tag when done.

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".

…oustics into infinite_room

… infinite_room

…e_room

fakufaku · 2022-05-01T02:27:32Z

Hi @duembgen ! What is the status on this pull request ? If it is good, I could just pull it in. The tests are failing now, so maybe a merge or something is needed.

fakufaku

I could not find the definition of the AnechoicRoom anymore ? Is the code in sync ?

fakufaku · 2022-05-01T02:28:28Z

README.rst

@@ -158,7 +158,7 @@ The minimal dependencies are::

 where ``Cython`` is only needed to benefit from the compiled accelerated simulator.
 The simulator itself has a pure Python counterpart, so that this requirement could
-be ignored, but is much slower.
+be ignored, but is much slower. For the Cython implementation to work, the user should have Eigen installed. 


Actually, if you check the repo with the --recursive option, it should pull the eigen library too. I don't think the note is needed. This is covered in CONTRIBUTING.rst.

…e_room

duembgen · 2022-05-02T14:22:33Z

Hi @fakufaku thank you for your comments! I am finalizing the pull request now. Will remove the Eigen comment if it is fixed by doing a recursive clone. Do you have any preference on how / if to mention the AnechoicRoom class in the documentation? I added another section called Free-field simulation in the room doc file, but happy to change that.

duembgen · 2022-05-02T14:31:48Z

Regarding the CHANGELOG, would you like me to be more specific than Added AnechoicRoom class?

fakufaku

Very cool, LGTM! Thanks, it makes it even easier to use in simple scenarios!

There were just a couple of things that I have added in comments. I can merge as soon as you are done.

fakufaku · 2022-05-02T14:30:16Z

pyroomacoustics/room.py

+
+    def __init__(
+        self,
+        dim,


Can we make this dim=3 by default ? I would like to move away from 2D room simulation in the long term :)

pyroomacoustics/room.py

fakufaku · 2022-05-02T14:36:08Z

pyroomacoustics/room.py

+=====================
+
+You can also use this package to simulate free-field sound propagation between a set of sound sources and a set of microphones, without considering room effects. To this end, you can use the :py:obj:`pyroomacoustics.room.AnechoicRoom` class, which simply corresponds to setting the maximum image image order of the room simulation to zero. This allows for early development and testing of various audio-based algorithms, without worrying about room acoustics at first. Thanks to the modular framework of pyroomacoustics, room acoustics can easily be added, after this first testing stage, for more realistic simulations. 
+


Can you please add a link to the relevant example in the paragraph ?

Also, a short code snippet would be awesome, but I leave that to you to decide! If you don't feel like it, don't do it 😄

docs/requirements.txt

docs/pyroomacoustics.bss.fastmnmf2.rst

duembgen

Thank you for the review!
I created an example script in the examples folder and added a corresponding code snippet to the docs. If you agree with all the changes you can merge this pull request.

docs/pyroomacoustics.bss.fastmnmf2.rst

docs/requirements.txt

EliasBrohammer · 2022-05-03T10:16:03Z

sorry for bursting into your conversation:
Just yesterday I created a script using the idea from issue #13 (max_order=0 for the room creation).
I will try the new room as soon as it's ready and give you feedback!

fakufaku

Just a couple of things left!

fakufaku · 2022-05-06T07:43:31Z

pyroomacoustics/room.py

+Simulating Direction-of-Arrival Estimation in Free Field
+--------------------------------------------------------
+
+As a simple usage example, assume you want to localize a sound source emitting white noise, using a square microphone array. If you can neglect room effects (e.g. you operate in an anechoic room or outdoors), or if you simply want to test your algorithm in the best-case scenario, you can use the :py:obj:`pyroomacoustics.room.AnechoicRoom` class. The below code shows an example using the popular MUSIC algorithm for DOA estimation. The example is exctracted from `./examples/doa_anechoic_room.py`.


exctracted -> extracted

fakufaku · 2022-05-06T07:46:06Z

pyroomacoustics/room.py

+    # run the simulation
+    room.simulate()
+
+    # create frequency-domain input for DOA algorithms


Thanks for adding the example! But I feel it is a bit long. Maybe we could leave the DOA part out and use some hard-coded value for the parameters (e.g. pra.AnechoicRoom(fs=16000)). Without the DOA we also won't need n_fft.

fakufaku · 2022-05-06T07:47:09Z

pyroomacoustics/room.py

@@ -2365,9 +2399,15 @@ def get_wall_by_name(self, name):
        """
        Returns the instance of the wall by giving its name.

-        :arg name: (string) name of the wall
+        Parameters


Thanks for fixing the formatting in different places!

EliasBrohammer · 2022-07-28T10:29:35Z

Just wanted to ask, how the status on this pull-request is? :)

duembgen · 2022-09-16T12:00:42Z

@fakufaku I have simplified the example, I hope that's roughly what you had in mind. Feel free to change anything to your liking and merge as soon as you are satisfied.
@EliasBrohammer sorry for the late reply.

fakufaku · 2022-11-10T02:38:37Z

@duembgen Sorry it took me so long to merge this! Thanks for your contribution!!! 🙏

duembgen and others added 24 commits April 28, 2020 16:51

Added package files to gitignore.

a96816d

Add InfiniteRoom class.

2d43b41

Add Signal class and new example file.

344cab1

Merge branch 'next_gen_simulator' of https://github.com/LCAV/pyroomac…

8abf6da

…oustics into infinite_room

Change .gitignore path to more general.

eacb6f1

Minor doc fixes.

1ff4402

Remove Signal subclass from this branch.

dcf2fea

Added simplified simulation for free space.

b0839b8

Minor formatting fix.

4233e0d

Simplified Anechoic room implementation.

5821d8f

Fix plotting.

e540a20

Add anechoic room to doa examples.

2d76fd6

Black autoformatting fix.

8e9eb2d

Fixed python2 formatting errors.

e2f6d60

Incorporate comments from pull request LCAV#160

04b0106

Merge branch 'master' of https://github.com/LCAV/pyroomacoustics into…

936504e

… infinite_room

Fix merge mistake

1034778

Specify x/y

c7a8331

Merge branch 'master' into infinite_room

fa9f78f

Fix CHANGELOG and remove unnecessary changes

4314366

Merge branch 'master' of github.com:lcav/pyroomacoustics into infinit…

bb33c98

…e_room

Fix import error

da0be48

Add note on Eigen

358eb1c

Add missing tabular requirement and shebang

63b5e6e

fakufaku reviewed May 1, 2022

View reviewed changes

duembgen added 3 commits May 2, 2022 09:57

Recover anechoic room simulation

f325a29

Add automatically generated doc files

85e60be

Merge branch 'master' of github.com:lcav/pyroomacoustics into infinit…

29e82cc

…e_room

Remove Eigen comment

874707a

fakufaku requested changes May 2, 2022

View reviewed changes

Add usage examples to folder and doc

20986f2

duembgen commented May 2, 2022

View reviewed changes

docs/pyroomacoustics.bss.fastmnmf2.rst Show resolved Hide resolved

docs/requirements.txt Show resolved Hide resolved

duembgen changed the title ~~WIP: Add AnechoicRoom class~~ Add AnechoicRoom class May 3, 2022

fakufaku reviewed May 6, 2022

View reviewed changes

fakufaku mentioned this pull request May 11, 2022

Simulating a room with no echo #258

Closed

Simplify example

ec0c1d7

fakufaku merged commit c30a0a6 into LCAV:master Nov 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add AnechoicRoom class #224

Add AnechoicRoom class #224

duembgen commented Jun 3, 2021 •

edited

Loading

fakufaku commented May 1, 2022

fakufaku left a comment

fakufaku May 1, 2022

duembgen commented May 2, 2022

duembgen commented May 2, 2022

fakufaku left a comment

fakufaku May 2, 2022

fakufaku May 2, 2022

duembgen left a comment

EliasBrohammer commented May 3, 2022

fakufaku left a comment

fakufaku May 6, 2022

fakufaku May 6, 2022

fakufaku May 6, 2022

EliasBrohammer commented Jul 28, 2022

duembgen commented Sep 16, 2022

fakufaku commented Nov 10, 2022

		=====================

		You can also use this package to simulate free-field sound propagation between a set of sound sources and a set of microphones, without considering room effects. To this end, you can use the :py:obj:`pyroomacoustics.room.AnechoicRoom` class, which simply corresponds to setting the maximum image image order of the room simulation to zero. This allows for early development and testing of various audio-based algorithms, without worrying about room acoustics at first. Thanks to the modular framework of pyroomacoustics, room acoustics can easily be added, after this first testing stage, for more realistic simulations.

Add AnechoicRoom class #224

Add AnechoicRoom class #224

Conversation

duembgen commented Jun 3, 2021 • edited Loading

fakufaku commented May 1, 2022

fakufaku left a comment

Choose a reason for hiding this comment

fakufaku May 1, 2022

Choose a reason for hiding this comment

duembgen commented May 2, 2022

duembgen commented May 2, 2022

fakufaku left a comment

Choose a reason for hiding this comment

fakufaku May 2, 2022

Choose a reason for hiding this comment

fakufaku May 2, 2022

Choose a reason for hiding this comment

duembgen left a comment

Choose a reason for hiding this comment

EliasBrohammer commented May 3, 2022

fakufaku left a comment

Choose a reason for hiding this comment

fakufaku May 6, 2022

Choose a reason for hiding this comment

fakufaku May 6, 2022

Choose a reason for hiding this comment

fakufaku May 6, 2022

Choose a reason for hiding this comment

EliasBrohammer commented Jul 28, 2022

duembgen commented Sep 16, 2022

fakufaku commented Nov 10, 2022

duembgen commented Jun 3, 2021 •

edited

Loading