Tests and changelog

CHANGELOG.rst

@@ -11,7 +11,12 @@ adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
 `Unreleased`_
 -------------
 
-Nothing yet
+Bugfix
+~~~~~~
+
+- Fixes issue #382: When providing a ``MicrophoneArray`` object with
+  directivity to ``Room.add_microphone_array``, the directivity was dropped
+  from the object.
 
 `0.8.2`_ - 2024-11-06
 ---------------------

pyroomacoustics/tests/test_room_add.py

@@ -23,33 +23,68 @@
 )
 
 
-def test_add_source_mic():
-    room = pra.ShoeBox(room_size).add_source(source_loc0).add_microphone(mic0)
+@pytest.mark.parametrize("with_dir", ((True,), (False,)))
+def test_add_source_mic(with_dir):
+    room = pra.ShoeBox(room_size)
+
+    if with_dir:
+        sdir0 = src_dir0
+        sdir1 = src_dir1
+        mdir0 = mic_dir0
+        mdir1 = mic_dir1
+    else:
+        sdir0 = sdir1 = None
+        mdir0 = mdir1 = None
+
+    room = (
+        pra.ShoeBox(room_size)
+        .add_source(source_loc0, directivity=sdir0)
+        .add_microphone(mic0, directivity=mdir0)
+    )
 
     assert len(room.sources) == 1
     assert np.allclose(room.sources[0].position, source_loc0)
     assert len(room.mic_array) == 1
     assert room.mic_array.R.shape == (3, 1)
     assert np.allclose(room.mic_array.R[:, 0], mic0)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert all(d is md for d, md in zip(room.mic_array.directivity, [mdir0]))
 
-    room.add_microphone(mic1).add_source(source_loc1)
+    room.add_microphone(mic1, directivity=mdir1).add_source(
+        source_loc1, directivity=sdir1
+    )
 
     assert len(room.sources) == 2
     assert np.allclose(room.sources[1].position, source_loc1)
     assert len(room.mic_array) == 2
     assert np.allclose(room.mic_array.R[:, 0], mic0)
     assert np.allclose(room.mic_array.R[:, 1], mic1)
     assert room.mic_array.R.shape == (3, 2)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert room.sources[1].directivity is sdir1
+    assert all(d is md for d, md in zip(room.mic_array.directivity, [mdir0, mdir1]))
 
 
-def test_add_source_mic_obj():
+@pytest.mark.parametrize("with_dir", ((True,), (False,)))
+def test_add_source_mic_obj(with_dir):
     room = pra.ShoeBox(room_size)
 
-    source0 = pra.SoundSource(source_loc0, signal=sig)
-    source1 = pra.SoundSource(source_loc1, signal=sig)
+    if with_dir:
+        sdir0 = src_dir0
+        sdir1 = src_dir1
+        mdir0 = mic_dir0
+        mdir1 = mic_dir1
+    else:
+        sdir0 = sdir1 = None
+        mdir0 = mdir1 = None
+
+    source0 = pra.SoundSource(source_loc0, signal=sig, directivity=sdir0)
+    source1 = pra.SoundSource(source_loc1, signal=sig, directivity=sdir1)
 
-    mic_array0 = pra.MicrophoneArray(np.c_[mic0], fs=room.fs)
-    mic_array1 = pra.MicrophoneArray(np.c_[mic1], fs=room.fs)
+    mic_array0 = pra.MicrophoneArray(np.c_[mic0], fs=room.fs, directivity=mdir0)
+    mic_array1 = pra.MicrophoneArray(np.c_[mic1], fs=room.fs, directivity=mdir1)
 
     room.add(source0).add(mic_array0)
 
@@ -58,6 +93,9 @@ def test_add_source_mic_obj():
     assert len(room.mic_array) == 1
     assert room.mic_array.R.shape == (3, 1)
     assert np.allclose(room.mic_array.R[:, 0], mic0)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert all(d is md for d, md in zip(room.mic_array.directivity, [mdir0]))
 
     room.add(mic_array1).add(source1)
 
@@ -67,6 +105,10 @@ def test_add_source_mic_obj():
     assert np.allclose(room.mic_array.R[:, 0], mic0)
     assert np.allclose(room.mic_array.R[:, 1], mic1)
     assert room.mic_array.R.shape == (3, 2)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert room.sources[1].directivity is sdir1
+    assert all(d is md for d, md in zip(room.mic_array.directivity, [mdir0, mdir1]))
 
 
 @pytest.mark.parametrize("with_dir", ((True,), (False,)))
@@ -109,13 +151,25 @@ def test_add_source_mic_obj_with_dir_error():
         room.add_microphone_array(mic_array, directivity=[mic_dir0, mic_dir1])
 
 
-def test_add_source_mic_ndarray():
-    source0 = pra.SoundSource(source_loc0, signal=sig)
-    source1 = pra.SoundSource(source_loc1, signal=sig)
+@pytest.mark.parametrize("with_dir", ((True,), (False,)))
+def test_add_source_mic_ndarray(with_dir):
+    if with_dir:
+        sdir0 = src_dir0
+        sdir1 = src_dir1
+        mdir = [mic_dir0, mic_dir1]
+    else:
+        sdir0 = sdir1 = None
+        mdir = [None, None]
+
+    source0 = pra.SoundSource(source_loc0, signal=sig, directivity=sdir0)
+    source1 = pra.SoundSource(source_loc1, signal=sig, directivity=sdir1)
     mic_array = np.c_[mic0, mic1]
 
     room = (
-        pra.ShoeBox(room_size).add(source0).add(source1).add_microphone_array(mic_array)
+        pra.ShoeBox(room_size)
+        .add(source0)
+        .add(source1)
+        .add_microphone_array(mic_array, directivity=mdir)
     )
 
     assert len(room.sources) == 2
@@ -125,14 +179,32 @@ def test_add_source_mic_ndarray():
     assert np.allclose(room.mic_array.R[:, 0], mic0)
     assert np.allclose(room.mic_array.R[:, 1], mic1)
     assert room.mic_array.R.shape == (3, 2)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert room.sources[1].directivity is sdir1
+    assert all(d is md for d, md in zip(room.mic_array.directivity, mdir))
 
 
-def test_add_source_mic_ndarray_2():
-    source0 = pra.SoundSource(source_loc0, signal=sig)
-    source1 = pra.SoundSource(source_loc1, signal=sig)
+@pytest.mark.parametrize("with_dir", ((True,), (False,)))
+def test_add_source_mic_ndarray_2(with_dir):
+    if with_dir:
+        sdir0 = src_dir0
+        sdir1 = src_dir1
+        mdir = [mic_dir0, mic_dir1]
+    else:
+        sdir0 = sdir1 = None
+        mdir = [None, None]
+
+    source0 = pra.SoundSource(source_loc0, signal=sig, directivity=sdir0)
+    source1 = pra.SoundSource(source_loc1, signal=sig, directivity=sdir1)
     mic_array = np.c_[mic0, mic1]
 
-    room = pra.ShoeBox(room_size).add(source0).add(source1).add_microphone(mic_array)
+    room = (
+        pra.ShoeBox(room_size)
+        .add(source0)
+        .add(source1)
+        .add_microphone(mic_array, directivity=mdir)
+    )
 
     assert len(room.sources) == 2
     assert np.allclose(room.sources[0].position, source_loc0)
@@ -141,6 +213,10 @@ def test_add_source_mic_ndarray_2():
     assert np.allclose(room.mic_array.R[:, 0], mic0)
     assert np.allclose(room.mic_array.R[:, 1], mic1)
     assert room.mic_array.R.shape == (3, 2)
+    # Test directivities.
+    assert room.sources[0].directivity is sdir0
+    assert room.sources[1].directivity is sdir1
+    assert all(d is md for d, md in zip(room.mic_array.directivity, mdir))
 
 
 if __name__ == "__main__":