Pyroomacoustics API

Subpackages

Module contents

pyroomacoustics

Provides
  1. Room impulse simulations via the image source model
  2. Simulation of sound propagation using STFT engine
  3. Reference implementations of popular algorithms for
  • beamforming
  • direction of arrival
  • adaptive filtering
  • source separation
  • single channel denoising
  • etc

How to use the documentation

Documentation is available in two forms: docstrings provided with the code, and a loose standing reference guide, available from the pyroomacoustics readthedocs page.

We recommend exploring the docstrings using IPython, an advanced Python shell with TAB-completion and introspection capabilities. See below for further instructions.

The docstring examples assume that pyroomacoustics has been imported as pra:

>>> import pyroomacoustics as pra

Code snippets are indicated by three greater-than signs:

>>> x = 42
>>> x = x + 1

Use the built-in help function to view a function’s docstring:

>>> help(pra.stft.STFT)
... 

Available submodules

pyroomacoustics.acoustics
Acoustics and psychoacoustics routines, mel-scale, critcal bands, etc.
pyroomacoustics.beamforming
Microphone arrays and beamforming routines.
pyroomacoustics.directivities
Directivity pattern objects and routines.
pyroomacoustics.geometry
Core geometry routine for the image source model.
pyroomacoustics.metrics
Performance metrics like mean-squared error, median, Itakura-Saito, etc.
pyroomacoustics.multirate
Rate conversion routines.
pyroomacoustics.parameters
Global parameters, i.e. for physics constants.
pyroomacoustics.recognition
Hidden Markov Model and TIMIT database structure.
pyroomacoustics.room
Abstraction of room and image source model.
pyroomacoustics.soundsource
Abstraction for a sound source.
pyroomacoustics.stft
Deprecated Replaced by the methods in pyroomacoustics.transform
pyroomacoustics.sync
A few routines to help synchronize signals.
pyroomacoustics.utilities
A bunch of routines to do various stuff.
pyroomacoustics.wall
Abstraction for walls of a room.
pyroomacoustics.windows
Tapering windows for spectral analysis.

Available subpackages

pyroomacoustics.adaptive
Adaptive filter algorithms
pyroomacoustics.bss
Blind source separation.
pyroomacoustics.datasets
Wrappers around a few popular speech datasets
pyroomacoustics.denoise
Single channel noise reduction methods
pyroomacoustics.doa
Direction of arrival finding algorithms
pyroomacoustics.phase
Phase-related processing
pyroomacoustics.transform
Block frequency domain processing tools

Utilities

__version__
pyroomacoustics version string