Pyroomacoustics API

Subpackages

• Adaptive Filtering
  • Module contents
    • Adaptive Filter Algorithms
      • How to use the adaptive filter module
      • Other Available Subpackages
      • Utilities
  • Algorithms
    • Adaptive Filter (Base)
      • AdaptiveFilter
        • AdaptiveFilter.name()
        • AdaptiveFilter.reset()
        • AdaptiveFilter.update()
    • Least Mean Squares
      • Least Mean Squares Family
      • BlockLMS
        • BlockLMS.reset()
        • BlockLMS.update()
      • NLMS
        • NLMS.update()
    • Recursive Least Squares
      • Recursive Least Squares Family
      • BlockRLS
        • BlockRLS.reset()
        • BlockRLS.update()
      • RLS
        • RLS.reset()
        • RLS.update()
    • Subband LMS
      • SubbandLMS
        • SubbandLMS.reset()
        • SubbandLMS.update()
      • hermitian()
  • Tools and Helpers
    • Data Structures
      • Buffer
        • Buffer.flush()
        • Buffer.push()
        • Buffer.size()
        • Buffer.top()
      • CoinFlipper
        • CoinFlipper.flip()
        • CoinFlipper.flip_all()
        • CoinFlipper.fresh_flips()
      • Powers
    • Utilities
      • autocorr()
      • hankel_multiplication()
      • hankel_stride_trick()
      • mkl_toeplitz_multiplication()
      • naive_toeplitz_multiplication()
      • toeplitz_multiplication()
      • toeplitz_opt_circ_approx()
      • toeplitz_strang_circ_approx()
• Blind Source Separation
  • Module contents
    • Blind Source Separation
  • Algorithms
    • Independent Vector Analysis (AuxIVA)
      • AuxIVA
      • auxiva()
    • Trinicon
      • trinicon()
    • Independent Low-Rank Matrix Analysis (ILRMA)
      • ILRMA
      • ilrma()
    • Sparse Independent Vector Analysis (SparseAuxIVA)
      • sparseauxiva()
    • Common Tools
      • projection_back()
      • sparir()
    • Fast Multichannel Nonnegative Matrix Factorization (FastMNMF)
      • FastMNMF
      • fastmnmf()
• Dataset Wrappers
  • Module contents
    • Example 1
    • Example 2 (CMU ARCTIC)
    • Example 3 (Google’s Speech Commands Dataset)
  • Datasets Available
    • CMU ARCTIC Corpus
      • The CMU ARCTIC Dataset
      • CMUArcticCorpus
        • CMUArcticCorpus.basedir
        • CMUArcticCorpus.info
        • CMUArcticCorpus.sentences
        • CMUArcticCorpus.build_corpus()
        • CMUArcticCorpus.filter()
      • CMUArcticSentence
        • CMUArcticSentence.data
        • CMUArcticSentence.fs
        • CMUArcticSentence.plot()
    • Google Speech Commands
      • Google’s Speech Commands Dataset
      • GoogleSample
        • GoogleSample.data
        • GoogleSample.fs
        • GoogleSample.plot()
      • GoogleSpeechCommands
        • GoogleSpeechCommands.basedir
        • GoogleSpeechCommands.size_by_samples
        • GoogleSpeechCommands.subdirs
        • GoogleSpeechCommands.classes
        • GoogleSpeechCommands.build_corpus()
        • GoogleSpeechCommands.filter()
    • TIMIT Corpus
      • The TIMIT Dataset
      • Sentence
        • Sentence.speaker
        • Sentence.id
        • Sentence.sex
        • Sentence.dialect
        • Sentence.fs
        • Sentence.samples
        • Sentence.text
        • Sentence.words
        • Sentence.phonems
        • Sentence.play()
        • Sentence.plot()
      • TimitCorpus
        • TimitCorpus.build_corpus()
        • TimitCorpus.get_word()
      • Word
        • Word.word
        • Word.boundaries
        • Word.samples
        • Word.fs
        • Word.phonems
        • Word.features
        • Word.mfcc()
        • Word.play()
        • Word.plot()
  • Tools and Helpers
    • Base Class
      • AudioSample
        • AudioSample.data
        • AudioSample.fs
        • AudioSample.meta
        • AudioSample.play()
        • AudioSample.plot()
      • Dataset
        • Dataset.samples
        • Dataset.info
        • Dataset.add_sample()
        • Dataset.add_sample_matching()
        • Dataset.filter()
        • Dataset.head()
      • Meta
        • Meta.as_dict()
        • Meta.match()
      • Sample
        • Sample.data
        • Sample.meta
    • Dataset Utilities
      • download_uncompress()
• Single Channel Denoising
  • Module contents
    • Single Channel Noise Reduction
  • Algorithms
    • pyroomacoustics.denoise.spectral_subtraction module
      • SpectralSub
        • SpectralSub.compute_gain_filter()
      • apply_spectral_sub()
    • pyroomacoustics.denoise.subspace module
      • Subspace
        • Subspace.apply()
        • Subspace.compute_signal_projection()
        • Subspace.update_cov_matrices()
      • apply_subspace()
    • pyroomacoustics.denoise.iterative_wiener module
      • IterativeWiener
        • IterativeWiener.compute_filtered_output()
      • apply_iterative_wiener()
      • compute_speech_psd()
      • compute_squared_gain()
      • compute_wiener_filter()
• Direction of Arrival
  • Module contents
    • Direction of Arrival Finding
      • How to use the DOA module
      • Other Available Subpackages
      • Utilities
      • Note on MUSIC
  • Algorithms
    • CSSM
      • CSSM
    • FRIDA
      • FRIDA
    • MUSIC
      • MUSIC
        • MUSIC.plot_individual_spectrum()
    • SRP-PHAT
      • SRP
    • TOPS
      • TOPS
    • WAVES
      • WAVES
  • Tools and Helpers
    • DOA (Base)
      • DOA
        • DOA.locate_sources()
        • DOA.polar_plt_dirac()
      • ModeVector
    • Tools for FRIDA (azimuth only)
      • Rmtx_ri()
      • Rmtx_ri_half()
      • Rmtx_ri_half_out_half()
      • Tmtx_ri()
      • Tmtx_ri_half()
      • Tmtx_ri_half_out_half()
      • build_mtx_amp()
      • build_mtx_amp_ri()
      • build_mtx_raw_amp()
      • coef_expan_mtx()
      • compute_b()
      • compute_mtx_obj()
      • compute_obj_val()
      • cov_mtx_est()
      • cpx_mtx2real()
      • dirac_recon_ri()
      • dirac_recon_ri_half()
      • dirac_recon_ri_half_multiband()
      • dirac_recon_ri_half_multiband_lu()
      • dirac_recon_ri_half_multiband_parallel()
      • dirac_recon_ri_half_parallel()
      • dirac_recon_ri_inner()
      • dirac_recon_ri_multiband_inner()
      • extract_off_diag()
      • hermitian_expan()
      • lu_compute_mtx_obj()
      • lu_compute_mtx_obj_initial()
      • make_G()
      • make_GtG_and_inv()
      • mtx_freq2raw()
      • mtx_freq2visi()
      • mtx_fri2signal_ri()
      • mtx_fri2signal_ri_multiband()
      • mtx_updated_G()
      • mtx_updated_G_multiband()
      • mtx_updated_G_multiband_new()
      • multiband_cov_mtx_est()
      • multiband_extract_off_diag()
      • output_shrink()
      • polar2cart()
      • pt_src_recon()
      • pt_src_recon_multiband()
      • pt_src_recon_rotate()
    • Grid Objects
      • Grid
        • Grid.apply()
        • Grid.find_peaks()
        • Grid.set_values()
      • GridCircle
        • GridCircle.apply()
        • GridCircle.find_peaks()
        • GridCircle.plot()
      • GridSphere
        • GridSphere.apply()
        • GridSphere.find_peaks()
        • GridSphere.min_max_distance()
        • GridSphere.plot()
        • GridSphere.plot_old()
        • GridSphere.regrid()
    • Plot Helpers
      • polar_plt_dirac()
      • sph_plot_diracs()
      • sph_plot_diracs_plotly()
    • Peak Detection
      • detect_peaks()
    • DOA Utilities
      • cart2spher()
      • circ_dist()
      • great_circ_dist()
      • polar_distance()
      • spher2cart()
• pyroomacoustics.experimental package
  • Submodules
    • pyroomacoustics.experimental.deconvolution module
      • deconvolve()
      • wiener_deconvolve()
    • pyroomacoustics.experimental.delay_calibration module
      • DelayCalibration
        • DelayCalibration.run()
    • pyroomacoustics.experimental.localization module
      • edm_line_search()
      • tdoa()
      • tdoa_loc()
    • pyroomacoustics.experimental.measure_ir module
    • pyroomacoustics.experimental.physics module
      • calculate_speed_of_sound()
    • pyroomacoustics.experimental.point_cloud module
      • Point Clouds
      • PointCloud
        • PointCloud.EDM()
        • PointCloud.align()
        • PointCloud.center()
        • PointCloud.classical_mds()
        • PointCloud.copy()
        • PointCloud.correct()
        • PointCloud.doa()
        • PointCloud.flatten()
        • PointCloud.fromEDM()
        • PointCloud.key2ind()
        • PointCloud.normalize()
        • PointCloud.plot()
        • PointCloud.trilateration()
        • PointCloud.trilateration_single_point()
    • RT60 Measurement Routine
      • RT60 Measurement Routine
      • measure_rt60()
    • pyroomacoustics.experimental.signals module
      • exponential_sweep()
      • linear_sweep()
      • window()
  • Module contents
    • Experimental
    • measure_ir()
• Phase Processing
  • Submodules
    • Griffin-Lim Phase Reconstruction
      • griffin_lim()
  • Module contents
    • Phase Processing
• Transforms
  • Module contents
    • Block based processing
  • Algorithms
    • DFT
      • DFT
        • DFT.X
        • DFT.x
        • DFT.nfft
        • DFT.D
        • DFT.transform
        • DFT.analysis_window
        • DFT.synthesis_window
        • DFT.axis
        • DFT.analysis()
        • DFT.synthesis()
    • STFT
      • STFT
        • STFT.analysis()
        • STFT.process()
        • STFT.reset()
        • STFT.set_filter()
        • STFT.synthesis()
        • STFT.zero_pad_back()
        • STFT.zero_pad_front()
      • analysis()
      • compute_synthesis_window()
      • synthesis()

Submodules

• pyroomacoustics.acoustics module
  • OctaveBandsFactory
    • OctaveBandsFactory.base_freq
    • OctaveBandsFactory.fs
    • OctaveBandsFactory.n_bands
    • OctaveBandsFactory.bands
    • OctaveBandsFactory.centers
    • OctaveBandsFactory.all_materials
    • OctaveBandsFactory.analysis()
    • OctaveBandsFactory.get_bw()
  • bandpass_filterbank()
  • bands_hz2s()
  • binning()
  • critical_bands()
  • inverse_sabine()
  • invmelscale()
  • melfilterbank()
  • melscale()
  • mfcc()
  • octave_bands()
  • rt60_eyring()
  • rt60_sabine()
• pyroomacoustics.beamforming module
  • Beamformer
    • Beamformer.far_field_weights()
    • Beamformer.filters_from_weights()
    • Beamformer.plot()
    • Beamformer.plot_beam_response()
    • Beamformer.plot_response_from_point()
    • Beamformer.process()
    • Beamformer.rake_delay_and_sum_weights()
    • Beamformer.rake_distortionless_filters()
    • Beamformer.rake_max_sinr_filters()
    • Beamformer.rake_max_sinr_weights()
    • Beamformer.rake_max_udr_filters()
    • Beamformer.rake_max_udr_weights()
    • Beamformer.rake_mvdr_filters()
    • Beamformer.rake_one_forcing_filters()
    • Beamformer.rake_one_forcing_weights()
    • Beamformer.rake_perceptual_filters()
    • Beamformer.response()
    • Beamformer.response_from_point()
    • Beamformer.snr()
    • Beamformer.steering_vector_2D()
    • Beamformer.steering_vector_2D_from_point()
    • Beamformer.udr()
    • Beamformer.weights_from_filters()
  • H()
  • MicrophoneArray
    • MicrophoneArray.M
    • MicrophoneArray.append()
    • MicrophoneArray.record()
    • MicrophoneArray.set_directivity()
    • MicrophoneArray.to_wav()
  • circular_2D_array()
  • circular_microphone_array_xyplane()
  • distance()
  • fir_approximation_ls()
  • linear_2D_array()
  • mdot()
  • poisson_2D_array()
  • spiral_2D_array()
  • square_2D_array()
  • sumcols()
  • unit_vec2D()
• pyroomacoustics.build_rir module
• pyroomacoustics.directivities module
  • CardioidFamily
    • CardioidFamily.directivity_pattern
    • CardioidFamily.get_response()
    • CardioidFamily.plot_response()
  • DirectionVector
    • DirectionVector.get_azimuth()
    • DirectionVector.get_colatitude()
    • DirectionVector.unit_vector
  • Directivity
    • Directivity.get_azimuth()
    • Directivity.get_colatitude()
    • Directivity.get_response()
    • Directivity.set_orientation()
  • DirectivityPattern
    • DirectivityPattern.CARDIOID
    • DirectivityPattern.FIGURE_EIGHT
    • DirectivityPattern.HYPERCARDIOID
    • DirectivityPattern.OMNI
    • DirectivityPattern.SUBCARDIOID
  • cardioid_func()
  • source_angle_shoebox()
• pyroomacoustics.metrics module
  • itakura_saito()
  • median()
  • mse()
  • pesq()
  • snr()
  • sweeping_echo_measure()
• pyroomacoustics.multirate module
  • frac_delay()
  • low_pass()
  • resample()
• pyroomacoustics.parameters module
  • Constants
    • Constants.get()
    • Constants.set()
  • Material
    • Material.energy_absorption
    • Material.scattering
    • Material.absorption_coeffs
    • Material.all_flat()
    • Material.is_freq_flat()
    • Material.resample()
    • Material.scattering_coeffs
  • Physics
    • Physics.from_speed()
    • Physics.get_air_absorption()
    • Physics.get_sound_speed()
  • calculate_speed_of_sound()
  • make_materials()
• pyroomacoustics.recognition module
  • CircularGaussianEmission
    • CircularGaussianEmission.get_pdfs()
    • CircularGaussianEmission.prob_x_given_state()
    • CircularGaussianEmission.update_parameters()
  • GaussianEmission
    • GaussianEmission.get_pdfs()
    • GaussianEmission.prob_x_given_state()
    • GaussianEmission.update_parameters()
  • HMM
    • HMM.K
    • HMM.O
    • HMM.A
    • HMM.pi
    • HMM.emission
    • HMM.model
    • HMM.leftright_jum_max
    • HMM.backward()
    • HMM.fit()
    • HMM.forward()
    • HMM.generate()
    • HMM.loglikelihood()
    • HMM.update_parameters()
    • HMM.viterbi()
• Room Simulation
  • Room
    • Simulating a Shoebox Room with the Image Source Model
      • Create the room
      • Randomized Image Method
      • Add sources and microphones
      • Adding source or microphone directivity
      • Create the Room Impulse Response
      • Simulate sound propagation
      • Full Example
    • Hybrid ISM/Ray Tracing Simulator
    • Wall Materials
    • Controlling the signal-to-noise ratio
    • Reverberation Time
  • Free-field simulation
  • AnechoicRoom
    • AnechoicRoom.get_bbox()
    • AnechoicRoom.is_inside()
    • AnechoicRoom.plot()
    • AnechoicRoom.plot_walls()
  • Room
    • Room.add()
    • Room.add_microphone()
    • Room.add_microphone_array()
    • Room.add_soundsource()
    • Room.add_source()
    • Room.compute_rir()
    • Room.direct_snr()
    • Room.extrude()
    • Room.from_corners()
    • Room.get_bbox()
    • Room.get_volume()
    • Room.get_wall_by_name()
    • Room.image_source_model()
    • Room.is_inside()
    • Room.is_multi_band
    • Room.measure_rt60()
    • Room.n_mics
    • Room.n_sources
    • Room.plot()
    • Room.plot_rir()
    • Room.ray_tracing()
    • Room.rt60_theory()
    • Room.set_air_absorption()
    • Room.set_ray_tracing()
    • Room.set_sound_speed()
    • Room.simulate()
    • Room.unset_air_absorption()
    • Room.unset_ray_tracing()
    • Room.volume
    • Room.wall_area()
  • ShoeBox
    • ShoeBox.extrude()
    • ShoeBox.get_volume()
    • ShoeBox.is_inside()
  • find_non_convex_walls()
  • sequence_generation()
  • wall_factory()
• pyroomacoustics.soundsource module
  • SoundSource
    • SoundSource.add_signal()
    • SoundSource.distance()
    • SoundSource.get_damping()
    • SoundSource.get_images()
    • SoundSource.get_rir()
    • SoundSource.set_directivity()
    • SoundSource.set_ordering()
    • SoundSource.wall_sequence()
  • build_rir_matrix()
• pyroomacoustics.stft module
• pyroomacoustics.sync module
  • correlate()
  • delay_estimation()
  • tdoa()
  • time_align()
• pyroomacoustics.utilities module
  • all_combinations()
  • angle_function()
  • autocorr()
  • clip()
  • compare_plot()
  • convmtx()
  • create_noisy_signal()
  • dB()
  • fractional_delay()
  • fractional_delay_filter_bank()
  • goertzel()
  • highpass()
  • levinson()
  • low_pass_dirac()
  • lpc()
  • normalize()
  • normalize_pwr()
  • prony()
  • real_spectrum()
  • requires_matplotlib()
  • rms()
  • shanks()
  • spectrum()
  • time_dB()
  • to_16b()
  • to_float32()
• pyroomacoustics.windows module
  • Window Functions
  • bart()
  • bart_hann()
  • blackman()
  • blackman_harris()
  • bohman()
  • cosine()
  • flattop()
  • gaussian()
  • hamming()
  • hann()
  • kaiser()
  • rect()
  • triang()

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