| Name | acoular JSON |
| Version |
24.10
JSON |
| download |
| home_page | None |
| Summary | Python library for acoustic beamforming |
| upload_time | 2024-10-22 15:27:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <=12,>=3.10 |
| license | BSD 3-Clause License
Copyright (c) Acoular Development Team
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
acoustics
beamforming
microphone array
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/acoular)
[](https://pypi.org/project/acoular)
[](https://github.com/acoular/acoular/actions)
[](https://zenodo.org/doi/10.5281/zenodo.3690794)
# Acoular
Acoular is a Python module for acoustic beamforming that is distributed under the new BSD license.
It is aimed at applications in acoustic testing. Multichannel data recorded by a microphone array can be processed and analyzed in order to generate mappings of sound source distributions. The maps (acoustic photographs) can then be used to locate sources of interest and to characterize them using their spectra.
# Features
- frequency domain beamforming algorithms: delay & sum, Capon (adaptive), MUSIC, functional beamforming, eigenvalue beamforming
- frequency domain deconvolution algorithms: DAMAS, DAMAS+, Clean, CleanSC, orthogonal deconvolution
- frequency domain inverse methods: CMF (covariance matrix fitting), general inverse beamforming, SODIX
- time domain methods: delay & sum beamforming, CleanT deconvolution
- time domain methods applicable for moving sources with arbitrary trajectory (linear, circular, arbitrarily 3D curved),
- frequency domain methods for rotating sources via virtual array rotation for arbitrary arrays and with different interpolation techniques
- 1D, 2D and 3D mapping grids for all methods
- gridless option for orthogonal deconvolution
- four different built-in steering vector formulations
- arbitrary stationary background flow can be considered for all methods
- efficient cross spectral matrix computation
- flexible modular time domain processing: n-th octave band filters, fast, slow, and impulse weighting, A-, C-, and Z-weighting, filter bank, zero delay filters
- time domain simulation of array microphone signals from fixed and arbitrarily moving sources in arbitrary flow
- fully object-oriented interface
- lazy evaluation: while processing blocks are set up at any time, (expensive) computations are only performed when needed
- intelligent and transparent caching: computed results are automatically saved and loaded on the next run to avoid unnecessary re-computation
- parallel (multithreaded) implementation with Numba for most algorithms
- easily extendable with new algorithms
# License
Acoular is licensed under the BSD 3-clause. See [LICENSE](LICENSE)
# Citing
If you use Acoular for academic work, please consider citing both our
[publication](https://doi.org/10.1016/j.apacoust.2016.09.015):
Sarradj, E., & Herold, G. (2017).
A Python framework for microphone array data processing.
Applied Acoustics, 116, 50–58.
https://doi.org/10.1016/j.apacoust.2016.09
and our [software](https://zenodo.org/doi/10.5281/zenodo.3690794):
Sarradj, E., Herold, G., Kujawski, A., Jekosch, S., Pelling, A. J. R., Czuchaj, M., Gensch, T., & Oertwig, S..
Acoular – Acoustic testing and source mapping software.
Zenodo. https://zenodo.org/doi/10.5281/zenodo.3690794
# Dependencies
Acoular runs under Linux, Windows and MacOS and needs Numpy, Scipy, Traits, scikit-learn, pytables, Numba packages available.
Matplotlib is needed for some of the examples.
If you want to use input from a soundcard, you will also need to install the [sounddevice](https://python-sounddevice.readthedocs.io/en/0.3.12/installation.html) package. Some solvers for the CMF method need [Pylops](https://pylops.readthedocs.io/en/stable/installation.html).
# Installation
Acoular can be installed via [conda](https://docs.conda.io/en/latest/), which is also part of the [Anaconda Python distribution](https://www.anaconda.com/). It is recommended to install into a dedicated [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). After activating this environment, run
conda install -c acoular acoular
This will install Acoular in your Anaconda Python environment and make the Acoular library available from Python. In addition, this will install all dependencies (those other packages mentioned above) if they are not already present on your system.
A second option is to install Acoular via [pip](https://pip.pypa.io/en/stable/). It is recommended to use a dedicated [virtual environment](https://virtualenv.pypa.io/en/latest/) and then run
pip install acoular
For more detailed installation instructions, see the [documentation](https://acoular.org/install/index.html).
# Documentation and help
Documentation is available [here](https://acoular.org) with a
[getting started](https://acoular.org/get_started/index.html) section and
[examples](https://acoular.org/auto_examples/index.html).
The Acoular [blog](https://acoular.github.io/blog/) contains some tutorials.
If you discover problems with the Acoular software, please report them using the [issue tracker](https://github.com/acoular/acoular/issues) on GitHub. Please use the [Acoular discussions forum](https://github.com/acoular/acoular/discussions) for practical questions, discussions, and demos.
# Contributing
We are always happy to welcome new contributors to the project.
If you are interested in contributing, have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.
# Example
This reads data from 64 microphone channels and computes a beamforming map for the 8kHz third octave band:
```python
from os import path
import acoular
from matplotlib.pylab import figure, plot, axis, imshow, colorbar, show
# this file contains the microphone coordinates
micgeofile = path.join(path.split(acoular.__file__)[0],'xml','array_64.xml')
# set up object managing the microphone coordinates
mg = acoular.MicGeom( from_file=micgeofile )
# set up object managing the microphone array data (usually from measurement)
ts = acoular.TimeSamples( name='three_sources.h5' )
# set up object managing the cross spectral matrix computation
ps = acoular.PowerSpectra( source=ts, block_size=128, window='Hanning' )
# set up object managing the mapping grid
rg = acoular.RectGrid( x_min=-0.2, x_max=0.2, y_min=-0.2, y_max=0.2, z=0.3, \
increment=0.01 )
# set up steering vector, implicitely contains also the standard quiescent
# environment with standard speed of sound
st = acoular.SteeringVector( grid = rg, mics=mg )
# set up the object managing the delay & sum beamformer
bb = acoular.BeamformerBase( freq_data=ps, steer=st )
# request the result in the 8kHz third octave band from approriate FFT-Lines
# this starts the actual computation (data intake, FFT, Welch CSM, beamforming)
pm = bb.synthetic( 8000, 3 )
# compute the sound pressure level
Lm = acoular.L_p( pm )
# plot the map
imshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \
interpolation='bicubic')
colorbar()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "acoular",
"maintainer": null,
"docs_url": null,
"requires_python": "<=12,>=3.10",
"maintainer_email": "Adam Kujawski <adam.kujawski@tu-berlin.de>, Art Pelling <a.pelling@tu-berlin.de>, Ennes Sarradj <ennes.sarradj@tu-berlin.de>, Gert Herold <gert.herold@tu-berlin.de>, Mikolaj Czuchaj <mikolaj.czuchaj@tu-berlin.de>, Simon Jekosch <s.jekosch@tu-berlin.de>",
"keywords": "acoustics, beamforming, microphone array",
"author": null,
"author_email": "Acoular Development Team <info@acoular.org>",
"download_url": "https://files.pythonhosted.org/packages/bb/66/59dad0a0ac7d8a6d56d4e368cf1b6cd98b71f56bf95eb3dbb598fee162ca/acoular-24.10.tar.gz",
"platform": null,
"description": "\n\n[](https://pypi.org/project/acoular)\n[](https://pypi.org/project/acoular)\n[](https://github.com/acoular/acoular/actions)\n[](https://zenodo.org/doi/10.5281/zenodo.3690794)\n\n# Acoular\nAcoular is a Python module for acoustic beamforming that is distributed under the new BSD license. \n\nIt is aimed at applications in acoustic testing. Multichannel data recorded by a microphone array can be processed and analyzed in order to generate mappings of sound source distributions. The maps (acoustic photographs) can then be used to locate sources of interest and to characterize them using their spectra. \n\n# Features\n- frequency domain beamforming algorithms: delay & sum, Capon (adaptive), MUSIC, functional beamforming, eigenvalue beamforming\n- frequency domain deconvolution algorithms: DAMAS, DAMAS+, Clean, CleanSC, orthogonal deconvolution\n- frequency domain inverse methods: CMF (covariance matrix fitting), general inverse beamforming, SODIX\n- time domain methods: delay & sum beamforming, CleanT deconvolution\n- time domain methods applicable for moving sources with arbitrary trajectory (linear, circular, arbitrarily 3D curved), \n- frequency domain methods for rotating sources via virtual array rotation for arbitrary arrays and with different interpolation techniques\n- 1D, 2D and 3D mapping grids for all methods\n- gridless option for orthogonal deconvolution\n- four different built-in steering vector formulations\n- arbitrary stationary background flow can be considered for all methods\n- efficient cross spectral matrix computation\n- flexible modular time domain processing: n-th octave band filters, fast, slow, and impulse weighting, A-, C-, and Z-weighting, filter bank, zero delay filters\n- time domain simulation of array microphone signals from fixed and arbitrarily moving sources in arbitrary flow\n- fully object-oriented interface\n- lazy evaluation: while processing blocks are set up at any time, (expensive) computations are only performed when needed\n- intelligent and transparent caching: computed results are automatically saved and loaded on the next run to avoid unnecessary re-computation\n- parallel (multithreaded) implementation with Numba for most algorithms\n- easily extendable with new algorithms\n\n# License\nAcoular is licensed under the BSD 3-clause. See [LICENSE](LICENSE)\n\n# Citing\n\nIf you use Acoular for academic work, please consider citing both our\n[publication](https://doi.org/10.1016/j.apacoust.2016.09.015):\n\n Sarradj, E., & Herold, G. (2017). \n A Python framework for microphone array data processing.\n Applied Acoustics, 116, 50\u201358. \n https://doi.org/10.1016/j.apacoust.2016.09\n\nand our [software](https://zenodo.org/doi/10.5281/zenodo.3690794):\n\n Sarradj, E., Herold, G., Kujawski, A., Jekosch, S., Pelling, A. J. R., Czuchaj, M., Gensch, T., & Oertwig, S..\n Acoular \u2013 Acoustic testing and source mapping software. \n Zenodo. https://zenodo.org/doi/10.5281/zenodo.3690794\n\n# Dependencies\nAcoular runs under Linux, Windows and MacOS and needs Numpy, Scipy, Traits, scikit-learn, pytables, Numba packages available. \nMatplotlib is needed for some of the examples.\n\nIf you want to use input from a soundcard, you will also need to install the [sounddevice](https://python-sounddevice.readthedocs.io/en/0.3.12/installation.html) package. Some solvers for the CMF method need [Pylops](https://pylops.readthedocs.io/en/stable/installation.html).\n\n# Installation\n\nAcoular can be installed via [conda](https://docs.conda.io/en/latest/), which is also part of the [Anaconda Python distribution](https://www.anaconda.com/). It is recommended to install into a dedicated [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). After activating this environment, run\n\n conda install -c acoular acoular\n\nThis will install Acoular in your Anaconda Python environment and make the Acoular library available from Python. In addition, this will install all dependencies (those other packages mentioned above) if they are not already present on your system. \n\nA second option is to install Acoular via [pip](https://pip.pypa.io/en/stable/). It is recommended to use a dedicated [virtual environment](https://virtualenv.pypa.io/en/latest/) and then run\n\n pip install acoular\n\nFor more detailed installation instructions, see the [documentation](https://acoular.org/install/index.html).\n\n# Documentation and help\nDocumentation is available [here](https://acoular.org) with a\n[getting started](https://acoular.org/get_started/index.html) section and\n[examples](https://acoular.org/auto_examples/index.html).\n\nThe Acoular [blog](https://acoular.github.io/blog/) contains some tutorials.\n\nIf you discover problems with the Acoular software, please report them using the [issue tracker](https://github.com/acoular/acoular/issues) on GitHub. Please use the [Acoular discussions forum](https://github.com/acoular/acoular/discussions) for practical questions, discussions, and demos.\n\n# Contributing\n\nWe are always happy to welcome new contributors to the project. \nIf you are interested in contributing, have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n\n# Example\nThis reads data from 64 microphone channels and computes a beamforming map for the 8kHz third octave band:\n\n```python\nfrom os import path\nimport acoular\nfrom matplotlib.pylab import figure, plot, axis, imshow, colorbar, show\n\n# this file contains the microphone coordinates\nmicgeofile = path.join(path.split(acoular.__file__)[0],'xml','array_64.xml')\n# set up object managing the microphone coordinates\nmg = acoular.MicGeom( from_file=micgeofile )\n# set up object managing the microphone array data (usually from measurement)\nts = acoular.TimeSamples( name='three_sources.h5' )\n# set up object managing the cross spectral matrix computation\nps = acoular.PowerSpectra( source=ts, block_size=128, window='Hanning' )\n# set up object managing the mapping grid\nrg = acoular.RectGrid( x_min=-0.2, x_max=0.2, y_min=-0.2, y_max=0.2, z=0.3, \\\nincrement=0.01 )\n# set up steering vector, implicitely contains also the standard quiescent \n# environment with standard speed of sound\nst = acoular.SteeringVector( grid = rg, mics=mg )\n# set up the object managing the delay & sum beamformer\nbb = acoular.BeamformerBase( freq_data=ps, steer=st )\n# request the result in the 8kHz third octave band from approriate FFT-Lines\n# this starts the actual computation (data intake, FFT, Welch CSM, beamforming)\npm = bb.synthetic( 8000, 3 )\n# compute the sound pressure level\nLm = acoular.L_p( pm )\n# plot the map\nimshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \\\ninterpolation='bicubic')\ncolorbar()\n```\n\n\n\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License\n \n Copyright (c) Acoular Development Team\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions are met:\n \n 1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n \n 2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n \n 3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Python library for acoustic beamforming",
"version": "24.10",
"project_urls": {
"documentation": "https://acoular.org",
"homepage": "https://acoular.org",
"repository": "https://github.com/acoular/acoular"
},
"split_keywords": [
"acoustics",
" beamforming",
" microphone array"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "06b258c2594cf33e9c6a3252d15db4914ebba99e74cc5d7eec0a92f89149f9c1",
"md5": "809dc90c8300e9b6f00959b0222281b2",
"sha256": "c3c1c3dd3d6527cad4887fca6dc090b3170d28891c5c1d3ec25bcbb7a6d09227"
},
"downloads": -1,
"filename": "acoular-24.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "809dc90c8300e9b6f00959b0222281b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=12,>=3.10",
"size": 149517,
"upload_time": "2024-10-22T15:27:21",
"upload_time_iso_8601": "2024-10-22T15:27:21.828270Z",
"url": "https://files.pythonhosted.org/packages/06/b2/58c2594cf33e9c6a3252d15db4914ebba99e74cc5d7eec0a92f89149f9c1/acoular-24.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bb6659dad0a0ac7d8a6d56d4e368cf1b6cd98b71f56bf95eb3dbb598fee162ca",
"md5": "0777a63e6aee4aded0bf63dd135f9f55",
"sha256": "03ba50474b788aedcc626afcab5a476218b719351801be0241e134e5459ac3a1"
},
"downloads": -1,
"filename": "acoular-24.10.tar.gz",
"has_sig": false,
"md5_digest": "0777a63e6aee4aded0bf63dd135f9f55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=12,>=3.10",
"size": 127141,
"upload_time": "2024-10-22T15:27:19",
"upload_time_iso_8601": "2024-10-22T15:27:19.918339Z",
"url": "https://files.pythonhosted.org/packages/bb/66/59dad0a0ac7d8a6d56d4e368cf1b6cd98b71f56bf95eb3dbb598fee162ca/acoular-24.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 15:27:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "acoular",
"github_project": "acoular",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "acoular"
}
