Method add_microphone_array

pyroomacoustics/room.py:2005–2053

Adds a microphone array (i.e. several microphones) in the room. Parameters ---------- mic_array: array_like or ndarray or MicrophoneArray object The array can be provided as an array of size ``(dim, n_mics)``, where ``dim`` is the dimension o

(self, mic_array, directivity=None)

        return self.add(MicrophoneArray(loc, fs, directivity))

    def add_microphone_array(self, mic_array, directivity=None):
        """
        Adds a microphone array (i.e. several microphones) in the room.

        Parameters
        ----------
        mic_array: array_like or ndarray or MicrophoneArray object
            The array can be provided as an array of size ``(dim, n_mics)``,
            where ``dim`` is the dimension of the room and ``n_mics`` is the
            number of microphones in the array.

            As an alternative, a
            :py:obj:`~pyroomacoustics.beamforming.MicrophoneArray` can be
            provided.
        directivity: list of Directivity objects, optional
            If ``mic_array`` is provided as a numpy array, an optional
            :py:obj:`~pyroomacoustics.directivities.Directivity` object or
            list thereof can be provided.
            If ``mic_array`` is a MicrophoneArray object, passing an argument here
            will result in an error.

        Returns
        -------
        :py:obj:`~pyroomacoustics.room.Room`
            The room is returned for further tweaking.
        """

        if self.simulator_state["rt_needed"] and directivity is not None:
            raise NotImplementedError("Directivity not supported with ray tracing.")

        if self.dim != 3 and directivity is not None:
            raise NotImplementedError("Directivity is only supported for 3D rooms.")

        if not isinstance(mic_array, MicrophoneArray):
            # if the type is not a microphone array, try to parse a numpy array
            mic_array = MicrophoneArray(mic_array, self.fs, directivity)
        else:
            # if the type is microphone array
            if directivity is not None:
                raise ValueError(
                    "When providing a MicrophoneArray object, the directivities should "
                    "be provided in the object, not via the `directivity` parameter "
                    "of this method."
                )

            if self.simulator_state["rt_needed"] and mic_array.is_directive:
                raise NotImplementedError("Directivity not supported with ray tracing.")

        return self.add(mic_array)

    def add_source(self, position, signal=None, delay=0, directivity=None):
        """