-
Notifications
You must be signed in to change notification settings - Fork 419
/
__init__.py
153 lines (111 loc) · 3.82 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
"""
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 <http://pyroomacoustics.readthedocs.io>`_.
We recommend exploring the docstrings using
`IPython <http://ipython.scipy.org>`_, 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)
... # doctest: +SKIP
Available submodules
---------------------
:py:obj:`pyroomacoustics.acoustics`
Acoustics and psychoacoustics routines, mel-scale, critcal bands, etc.
:py:obj:`pyroomacoustics.beamforming`
Microphone arrays and beamforming routines.
:py:obj:`pyroomacoustics.directivities`
Directivity pattern objects and routines.
:py:obj:`pyroomacoustics.geometry`
Core geometry routine for the image source model.
:py:obj:`pyroomacoustics.metrics`
Performance metrics like mean-squared error, median, Itakura-Saito, etc.
:py:obj:`pyroomacoustics.multirate`
Rate conversion routines.
:py:obj:`pyroomacoustics.parameters`
Global parameters, i.e. for physics constants.
:py:obj:`pyroomacoustics.recognition`
Hidden Markov Model and TIMIT database structure.
:py:obj:`pyroomacoustics.room`
Abstraction of room and image source model.
:py:obj:`pyroomacoustics.soundsource`
Abstraction for a sound source.
:py:obj:`pyroomacoustics.stft`
**Deprecated** Replaced by the methods in :py:obj:`pyroomacoustics.transform`
:py:obj:`pyroomacoustics.sync`
A few routines to help synchronize signals.
:py:obj:`pyroomacoustics.utilities`
A bunch of routines to do various stuff.
:py:obj:`pyroomacoustics.wall`
Abstraction for walls of a room.
:py:obj:`pyroomacoustics.windows`
Tapering windows for spectral analysis.
Available subpackages
---------------------
:py:obj:`pyroomacoustics.adaptive`
Adaptive filter algorithms
:py:obj:`pyroomacoustics.bss`
Blind source separation.
:py:obj:`pyroomacoustics.datasets`
Wrappers around a few popular speech datasets
:py:obj:`pyroomacoustics.denoise`
Single channel noise reduction methods
:py:obj:`pyroomacoustics.doa`
Direction of arrival finding algorithms
:py:obj:`pyroomacoustics.phase`
Phase-related processing
:py:obj:`pyroomacoustics.transform`
Block frequency domain processing tools
Utilities
---------
__version__
pyroomacoustics version string
"""
from .version import __version__
from . import libroom as libroom
from .room import *
from .beamforming import *
from .soundsource import *
from .parameters import *
from .utilities import *
from .windows import *
from .sync import *
from .metrics import *
from .multirate import *
from .acoustics import *
from .recognition import *
from .directivities import *
from . import doa
from . import adaptive
from . import transform
from . import transform as realtime # to be deprecated
from . import experimental
from . import datasets
from . import bss
from . import denoise
from . import phase
import warnings
warnings.warn(
"Do not import the 'realtime' module as it will be deprecated soon. It will be replaced by the 'transform' module.",
DeprecationWarning,
)