Method add_source

pyroomacoustics/room.py:2055–2102

Adds a sound source given by its position in the room. Optionally a source signal and a delay can be provided. Parameters ----------- position: ndarray, shape: (2,) or (3,) The location of the source in the room signal: ndarray, shape: (n

(self, position, signal=None, delay=0, directivity=None)

        return self.add(mic_array)

    def add_source(self, position, signal=None, delay=0, directivity=None):
        """
        Adds a sound source given by its position in the room. Optionally
        a source signal and a delay can be provided.

        Parameters
        -----------
        position: ndarray, shape: (2,) or (3,)
            The location of the source in the room
        signal: ndarray, shape: (n_samples,), optional
            The signal played by the source
        delay: float, optional
            A time delay until the source signal starts
            in the simulation

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

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

        if isinstance(position, SoundSource):
            if directivity is not None:
                if isinstance(directivity, CardioidFamily) or isinstance(
                    directivity, MeasuredDirectivity
                ):
                    return self.add(SoundSource(position, directivity=directivity))
            else:
                return self.add(position)
        else:
            if directivity is not None:
                if isinstance(directivity, CardioidFamily) or isinstance(
                    directivity, MeasuredDirectivity
                ):
                    return self.add(
                        SoundSource(
                            position,
                            signal=signal,
                            delay=delay,
                            directivity=directivity,
                        )
                    )

            else:
                return self.add(SoundSource(position, signal=signal, delay=delay))

    def add_soundsource(self, sndsrc, directivity=None):
        """