Pyroomacoustics API¶
Subpackages¶
- Adaptive Filtering
- Blind Source Separation
- Dataset Wrappers
- Single Channel Denoising
- Direction of Arrival
- Module contents
- Algorithms
- Tools and Helpers
- DOA (Base)
- 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
- Plot Helpers
- Peak Detection
- DOA Utilities
- pyroomacoustics.experimental package
- Submodules
- pyroomacoustics.experimental.deconvolution module
- pyroomacoustics.experimental.delay_calibration module
- pyroomacoustics.experimental.localization module
- pyroomacoustics.experimental.measure_ir module
- pyroomacoustics.experimental.physics module
- pyroomacoustics.experimental.point_cloud module
- Point Clouds
PointCloudPointCloud.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
- pyroomacoustics.experimental.signals module
- Module contents
- Submodules
- Phase Processing
- Randomness
- Transforms
Submodules¶
- pyroomacoustics.acoustics module
AntoniOctaveFilterBankAntoniOctaveFilterBank.base_freqAntoniOctaveFilterBank.fsAntoniOctaveFilterBank.n_bandsAntoniOctaveFilterBank.bandsAntoniOctaveFilterBank.centersAntoniOctaveFilterBank.analysis()AntoniOctaveFilterBank.energy()AntoniOctaveFilterBank.get_bw()AntoniOctaveFilterBank.synthesis()AntoniOctaveFilterBank.wavelet_analysis()AntoniOctaveFilterBank.wavelet_synthesis()
AntoniOctaveFilterBankParametersAntoniOctaveFilterBankParameters.analyzed_band_indicesAntoniOctaveFilterBankParameters.bands_center_binsAntoniOctaveFilterBankParameters.bands_lower_binsAntoniOctaveFilterBankParameters.bands_upper_binsAntoniOctaveFilterBankParameters.n_fftAntoniOctaveFilterBankParameters.output_dtypeAntoniOctaveFilterBankParameters.output_lengthAntoniOctaveFilterBankParameters.padded_lengthAntoniOctaveFilterBankParameters.windows
BaseOctaveFilterBankOctaveBandsFactoryantoni_magnitude_octave_filter_response()bandpass_filterbank()bands_hz2s()binning()cosine_magnitude_octave_filter_response()critical_bands()inverse_sabine()invmelscale()magnitude_response_to_minimum_phase()melfilterbank()melscale()mfcc()octave_bands()rt60_eyring()rt60_sabine()
- pyroomacoustics.beamforming module
BeamformerBeamformer.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()MicrophoneArraycircular_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
- Directional Sources and Microphones
- Analytic Directional Responses
CardioidCardioidEnergyDistributionCardioidFamilyCardioidFamily.directivity_patternCardioidFamily.filter_len_irCardioidFamily.get_azimuth()CardioidFamily.get_colatitude()CardioidFamily.get_response()CardioidFamily.get_response_cartesian()CardioidFamily.is_impulse_responseCardioidFamily.plot_response()CardioidFamily.sample_rays()CardioidFamily.set_orientation()
FigureEightHyperCardioidOmnidirectionalSubCardioidcardioid_energy()cardioid_func()
- Real Spherical Harmonics Directivities
- Measured Directivities
- Specifying Object Directions
- Creating New Types of Directivities
- Spherical Interpolation
- Numerical Spherical Integral
- Analytic Directional Responses
- pyroomacoustics.metrics module
- pyroomacoustics.multirate module
- Simulation and Control Parameters
- pyroomacoustics.recognition module
- Room Simulation
- Room
- Free-field simulation
AnechoicRoomRoomRoom.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_bandRoom.measure_rt60()Room.n_micsRoom.n_sourcesRoom.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.volumeRoom.wall_area()
ShoeBoxfind_non_convex_walls()wall_factory()
- Simulation Routines Sub-package
- pyroomacoustics.soundsource module
- pyroomacoustics.stft module
- pyroomacoustics.sync module
- pyroomacoustics.utilities module
all_combinations()angle_function()autocorr()clip()compare_plot()convmtx()create_noisy_signal()dB()design_highpass_filter_sos()fractional_delay()fractional_delay_filter_bank()goertzel()highpass()levinson()low_pass_dirac()lpc()normalize()normalize_pwr()prony()real_spectrum()requires_matplotlib()resample()rms()shanks()spectrum()time_dB()to_16b()to_float32()
- pyroomacoustics.windows module
Module contents¶
pyroomacoustics¶
- Provides
Room impulse simulations via the image source model
Simulation of sound propagation using STFT engine
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.acousticsAcoustics and psychoacoustics routines, mel-scale, critcal bands, etc.
pyroomacoustics.beamformingMicrophone arrays and beamforming routines.
pyroomacoustics.directivitiesDirectivity pattern objects and routines.
pyroomacoustics.geometryCore geometry routine for the image source model.
pyroomacoustics.metricsPerformance metrics like mean-squared error, median, Itakura-Saito, etc.
pyroomacoustics.multirateRate conversion routines.
pyroomacoustics.parametersGlobal parameters, i.e. for physics constants.
pyroomacoustics.recognitionHidden Markov Model and TIMIT database structure.
pyroomacoustics.roomAbstraction of room and image source model.
pyroomacoustics.soundsourceAbstraction for a sound source.
pyroomacoustics.stftDeprecated Replaced by the methods in
pyroomacoustics.transformpyroomacoustics.syncA few routines to help synchronize signals.
pyroomacoustics.utilitiesA bunch of routines to do various stuff.
pyroomacoustics.wallAbstraction for walls of a room.
pyroomacoustics.windowsTapering windows for spectral analysis.
Available subpackages¶
pyroomacoustics.adaptiveAdaptive filter algorithms
pyroomacoustics.bssBlind source separation.
pyroomacoustics.datasetsWrappers around a few popular speech datasets
pyroomacoustics.denoiseSingle channel noise reduction methods
pyroomacoustics.doaDirection of arrival finding algorithms
pyroomacoustics.phasePhase-related processing
pyroomacoustics.randomRoutines for random number generation.
pyroomacoustics.transformBlock frequency domain processing tools
Utilities¶
- __version__
pyroomacoustics version string