Fixes scattering in the ray tracing simulator, make simulation deterministic. (#426)

* Fixes scattering in the ray tracing simulator. Adds a function to seed the RNG in libroom.

* Moves all numerical constants used in libroom into a common header shared accross the package.

* Adds a test for the Lambertian reflection sampler.

* Adds a package wide random number generator and some methods to fix the seeds of this RNG and the one used in libroom.

* Make the room simulation deterministic.

* Document the new RNG related routines.

* Fixes room.is_inside.

* Fix the fix of is_inside.

* Adding pre-commit hooks and flake8 configs.

Author: fakufaku

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203
+# E203 is ignored because it conflicts with Black's whitespace handling

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# Global exclude: ignore build folders, virtual environments, and C++ dependencies
+exclude: '^(pyroomacoutics/libroom_src/ext/|build/|dist/|venv/|extern/)'
+
+repos:
+  - repo: https://github.com/pycqa/isort
+    rev: 7.0.0
+    hooks:
+      - id: isort
+        files: ^(pyroomacoustics/|examples/|setup\.py)
+
+  - repo: https://github.com/psf/black
+    rev: 26.1.0
+    hooks:
+      - id: black
+        files: ^(pyroomacoustics/|examples/|setup\.py)
+
+#  - repo: https://github.com/pycqa/flake8
+#    rev: 7.3.0
+#    hooks:
+#      - id: flake8
+#        files: ^(pyroomacoustics/|examples/|setup\.py)
+#
+#  - repo: https://github.com/pre-commit/mirrors-clang-format
+#    rev: v21.1.8
+#    hooks:
+#      - id: clang-format
+#        # Only run on your C++ source and headers
+#        files: \.(cpp|h|hpp|cc)$
+
+

CHANGELOG.rst

@@ -11,9 +11,18 @@ adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 `Unreleased`_
 -------------
 
+Added
+~~~~~
+
+- A new ``random`` sub-module that contains a Numpy random number generator to use
+  package wide and some methods to set the seeds for this generator and that of
+  the libroom module.
+
 Changed
 ~~~~~~~
 
+- Adds random "bending" of the rays to account for scattering in the ray tracing.
+
 - Refactor the way the RIR is weighted with the histogram in simulation/rt.py.
 
 - Improves ``pra.experimental.measure_rt60``: Compute the T60 using a fit. Default is

docs/index.rst

@@ -32,4 +32,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/pyroomacoustics.random.rst

@@ -0,0 +1,14 @@
+Randomness
+==========
+
+.. automodule:: pyroomacoustics.random
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Random Number Generator
+-----------------------
+
+.. automodule:: pyroomacoustics.random.generator
+   :members:
+   :show-inheritance:

docs/pyroomacoustics.rst

@@ -13,6 +13,7 @@ Subpackages
     pyroomacoustics.doa
     pyroomacoustics.experimental
     pyroomacoustics.phase
+    pyroomacoustics.random
     pyroomacoustics.transform
 
 Submodules

examples/directivities/simulate_binaural_recording.py

@@ -7,6 +7,7 @@
 
 Get more SOFA files at https://www.sofaconventions.org/mediawiki/index.php/Files
 """
+
 import argparse
 from pathlib import Path
 

pyproject.toml

@@ -5,4 +5,8 @@ requires = ["setuptools", "wheel", "numpy>=1.13.0", "Cython", "pybind11>=2.2"]
 [tool.pytest.ini_options]
 filterwarnings = [
   'ignore:Matplotlib is currently using agg, which is a non-GUI backend, so cannot show the figure.:UserWarning'
-]
+] 
+
+[tool.isort]
+profile = "black"
+line_length = 88

pyroomacoustics/__init__.py

@@ -107,6 +107,9 @@
 :py:obj:`pyroomacoustics.phase`
     Phase-related processing
 
+:py:obj:`pyroomacoustics.random`
+    Routines for random number generation.
+
 :py:obj:`pyroomacoustics.transform`
     Block frequency domain processing tools
 
@@ -129,6 +132,7 @@
 from .metrics import *
 from .multirate import *
 from .parameters import *
+from .random import get_rng, seed
 from .recognition import *
 from .room import *
 from .soundsource import *

pyroomacoustics/doa/doa.py

@@ -322,8 +322,9 @@ def locate_sources(
             self.src_idx = np.zeros(self.num_src, dtype=np.int64)
             self.angle_of_arrival = None
         if X.shape[0] != self.M:
-            raise ValueError("Number of signals (rows) does not match the \
-                number of microphones.")
+            raise ValueError(
+                "Number of signals (rows) does not match the number of microphones."
+            )
         if X.shape[1] != self.max_bin:
             raise ValueError("Mismatch in FFT length.")
         self.num_snap = X.shape[2]
@@ -574,8 +575,9 @@ def _check_num_src(self, num_src):
         #         str(self.M) + '.')
         #     num_src = self.M
         if num_src < 1:
-            warnings.warn("Number of sources must be at least 1. Changing \
-                number of sources to 1.")
+            warnings.warn(
+                "Number of sources must be at least 1. Changing number of sources to 1."
+            )
             num_src = 1
         valid = int(num_src)
         return valid