acoular 24.3__tar.gz → 24.7__tar.gz

{acoular-24.3 → acoular-24.7}/.gitignore

@@ -1,14 +1,7 @@
 # files and file types to ignore
 *.pyc
-*.pyd
 *.so
 *~
-examples/three_sources.h5
-examples/all_bf.sav
-examples/benchmark/results/
-MANIFEST
-
-# ignore the build directories
 *.egg-info/
 .eggs/
 build/
@@ -23,7 +16,13 @@ __pycache__/
 *.nbc
 *.nbi
 *.pyd
-docs/source/api_ref/generated/
 .vscode/
 
-acoular/demo/three_sources.h5
+MANIFEST
+
+examples/all_bf.sav
+examples/benchmark/results/
+**/three_sources.h5
+docs/source/sg_execution_times.rst
+docs/source/api_ref/generated/
+docs/source/auto_examples/**/*

acoular-24.7/LICENSE

@@ -0,0 +1,28 @@
+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.

{acoular-24.3 → acoular-24.7}/PKG-INFO

@@ -1,41 +1,40 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: acoular
-Version: 24.3
+Version: 24.7
 Summary: Python library for acoustic beamforming
 Project-URL: homepage, https://acoular.org
 Project-URL: documentation, https://acoular.org
 Project-URL: repository, https://github.com/acoular/acoular
 Author-email: Acoular Development Team <info@acoular.org>
 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>
-License: Copyright (c) Acoular Development Team.
-        All rights reserved.
+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:
         
-          a. Redistributions of source code must retain the above copyright notice,
-             this list of conditions and the following disclaimer.
-          b. 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.
-          c. Neither the name of the acoular developers nor the names of
-             its contributors may be used to endorse or promote products
-             derived from this software without specific prior written
-             permission. 
+        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 REGENTS OR CONTRIBUTORS BE LIABLE FOR
-        ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        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.
+        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.
 License-File: AUTHORS.rst
 License-File: LICENSE
 Keywords: acoustics,beamforming,microphone array
@@ -43,39 +42,45 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: <=11,>=3.7
+Requires-Python: <=12,>=3.8
 Requires-Dist: numba
-Requires-Dist: numpy
+Requires-Dist: numpy<2.0
 Requires-Dist: scikit-learn
 Requires-Dist: scipy>=1.1.0
 Requires-Dist: tables>=3.4.4
 Requires-Dist: traits>=6.0
 Provides-Extra: dev
 Requires-Dist: graphviz; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
 Requires-Dist: ipython; extra == 'dev'
 Requires-Dist: matplotlib; extra == 'dev'
-Requires-Dist: nox; extra == 'dev'
 Requires-Dist: numpydoc; extra == 'dev'
 Requires-Dist: pickleshare; extra == 'dev'
+Requires-Dist: pylops; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff==0.4.1; extra == 'dev'
 Requires-Dist: sounddevice; extra == 'dev'
 Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-gallery; extra == 'dev'
+Requires-Dist: traitsui; extra == 'dev'
 Provides-Extra: full
 Requires-Dist: matplotlib; extra == 'full'
 Requires-Dist: pylops; extra == 'full'
 Requires-Dist: sounddevice; extra == 'full'
 Description-Content-Type: text/markdown
 
-![Acoular Logo](./docs/source/_static/Acoular_logo.png)
+![Acoular Logo](https://github.com/acoular/acoular/blob/master/docs/source/_static/Acoular_logo.png?raw=true)
 
 [![PyPI](https://img.shields.io/pypi/pyversions/acoular.svg)](https://pypi.org/project/acoular)
 [![PyPI](https://img.shields.io/pypi/v/acoular.svg)](https://pypi.org/project/acoular)
-[![Github](https://github.com/acoular/acoular/actions/workflows/python-package.yml/badge.svg)](https://github.com/acoular/acoular/actions/workflows/python-package.yml)
+[![Actions status](https://github.com/acoular/acoular/actions/workflows/tests.yml/badge.svg)](https://github.com/acoular/acoular/actions)
+[![DOI](https://zenodo.org/badge/29729101.svg)](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. 
@@ -87,7 +92,7 @@ It is aimed at applications in acoustic testing. Multichannel data recorded by a
 - 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 source with arbitrary trajectory (linear, circular, arbitrarily 3D curved), 
+- 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
@@ -107,18 +112,25 @@ Acoular is licensed under the BSD 3-clause. See [LICENSE](LICENSE)
 
 # Citing
 
-If you use Acoular for academic work, please consider citing our
+If you use Acoular for academic work, please consider citing both our
 [publication](https://doi.org/10.1016/j.apacoust.2016.09.015):
 
-    Ennes Sarradj, Gert Herold,
-    A Python framework for microphone array data processing,
-    Applied Acoustics, Volume 116, 2017, Pages 50-58
+    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 hardware, 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).
+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
 
@@ -126,22 +138,27 @@ Acoular can be installed via [conda](https://docs.conda.io/en/latest/), which is
 
     conda install -c acoular acoular
 
-This will install Acoular in your Anaconda Python enviroment 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. 
+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 install instructions see the [documentation](http://acoular.org/install/index.html).
+For more detailed installation instructions, see the [documentation](https://acoular.org/install/index.html).
 
 # Documentation and help
-Documentation is available [here](http://acoular.org) with a
-[getting started](http://acoular.org/get_started/index.html) section and
-[examples](http://acoular.org/examples/index.html).
+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.
 
-Problems, suggestions and success using Acoular may be reported via the [acoular-users](https://groups.google.com/forum/#!forum/acoular-users) discussion forum.
+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:
@@ -178,4 +195,6 @@ interpolation='bicubic')
 colorbar()
 ```
 
-![result](./docs/source/get_started/three_source_py3_colormap.png)
+![result](https://github.com/acoular/acoular/blob/master/docs/source/get_started/three_source_py3_colormap.png?raw=true)
+
+

{acoular-24.3 → acoular-24.7}/README.md

@@ -1,8 +1,9 @@
-![Acoular Logo](./docs/source/_static/Acoular_logo.png)
+![Acoular Logo](https://github.com/acoular/acoular/blob/master/docs/source/_static/Acoular_logo.png?raw=true)
 
 [![PyPI](https://img.shields.io/pypi/pyversions/acoular.svg)](https://pypi.org/project/acoular)
 [![PyPI](https://img.shields.io/pypi/v/acoular.svg)](https://pypi.org/project/acoular)
-[![Github](https://github.com/acoular/acoular/actions/workflows/python-package.yml/badge.svg)](https://github.com/acoular/acoular/actions/workflows/python-package.yml)
+[![Actions status](https://github.com/acoular/acoular/actions/workflows/tests.yml/badge.svg)](https://github.com/acoular/acoular/actions)
+[![DOI](https://zenodo.org/badge/29729101.svg)](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. 
@@ -14,7 +15,7 @@ It is aimed at applications in acoustic testing. Multichannel data recorded by a
 - 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 source with arbitrary trajectory (linear, circular, arbitrarily 3D curved), 
+- 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
@@ -34,18 +35,25 @@ Acoular is licensed under the BSD 3-clause. See [LICENSE](LICENSE)
 
 # Citing
 
-If you use Acoular for academic work, please consider citing our
+If you use Acoular for academic work, please consider citing both our
 [publication](https://doi.org/10.1016/j.apacoust.2016.09.015):
 
-    Ennes Sarradj, Gert Herold,
-    A Python framework for microphone array data processing,
-    Applied Acoustics, Volume 116, 2017, Pages 50-58
+    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 hardware, 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).
+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
 
@@ -53,22 +61,27 @@ Acoular can be installed via [conda](https://docs.conda.io/en/latest/), which is
 
     conda install -c acoular acoular
 
-This will install Acoular in your Anaconda Python enviroment 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. 
+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 install instructions see the [documentation](http://acoular.org/install/index.html).
+For more detailed installation instructions, see the [documentation](https://acoular.org/install/index.html).
 
 # Documentation and help
-Documentation is available [here](http://acoular.org) with a
-[getting started](http://acoular.org/get_started/index.html) section and
-[examples](http://acoular.org/examples/index.html).
+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.
 
-Problems, suggestions and success using Acoular may be reported via the [acoular-users](https://groups.google.com/forum/#!forum/acoular-users) discussion forum.
+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:
@@ -105,4 +118,6 @@ interpolation='bicubic')
 colorbar()
 ```
 
-![result](./docs/source/get_started/three_source_py3_colormap.png)
+![result](https://github.com/acoular/acoular/blob/master/docs/source/get_started/three_source_py3_colormap.png?raw=true)
+
+

acoular-24.7/acoular/__init__.py

@@ -0,0 +1,125 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) Acoular Development Team.
+# ------------------------------------------------------------------------------
+
+"""The Acoular library: several classes for the implementation of acoustic beamforming."""
+
+import os
+
+from . import demo, tools
+from .calib import Calib
+from .configuration import config
+from .environments import (
+    Environment,
+    FlowField,
+    GeneralFlowEnvironment,
+    OpenJet,
+    RotatingFlow,
+    SlotJet,
+    UniformFlowEnvironment,
+    cartToCyl,
+    cylToCart,
+)
+from .fbeamform import (
+    BeamformerAdaptiveGrid,
+    BeamformerBase,
+    BeamformerCapon,
+    BeamformerClean,
+    BeamformerCleansc,
+    BeamformerCMF,
+    BeamformerDamas,
+    BeamformerDamasPlus,
+    BeamformerEig,
+    BeamformerFunctional,
+    BeamformerGIB,
+    BeamformerGridlessOrth,
+    BeamformerMusic,
+    BeamformerOrth,
+    BeamformerSODIX,
+    L_p,
+    PointSpreadFunction,
+    SteeringVector,
+    integrate,
+)
+from .grids import (
+    CircSector,
+    ConvexSector,
+    Grid,
+    ImportGrid,
+    LineGrid,
+    MergeGrid,
+    MultiSector,
+    PolySector,
+    RectGrid,
+    RectGrid3D,
+    RectSector,
+    RectSector3D,
+    Sector,
+)
+from .microphones import MicGeom
+from .sdinput import SoundDeviceSamplesGenerator
+from .signals import (
+    FiltWNoiseGenerator,
+    GenericSignalGenerator,
+    PNoiseGenerator,
+    SignalGenerator,
+    SineGenerator,
+    WNoiseGenerator,
+)
+from .sources import (
+    LineSource,
+    MaskedTimeSamples,
+    MovingLineSource,
+    MovingPointSource,
+    MovingPointSourceDipole,
+    PointSource,
+    PointSourceConvolve,
+    PointSourceDipole,
+    SourceMixer,
+    SphericalHarmonicSource,
+    TimeSamples,
+    UncorrelatedNoiseSource,
+)
+from .spectra import BaseSpectra, FFTSpectra, PowerSpectra, PowerSpectraImport, synthetic
+from .spectra import PowerSpectra as EigSpectra
+from .tbeamform import (
+    BeamformerCleant,
+    BeamformerCleantSq,
+    BeamformerCleantSqTraj,
+    BeamformerCleantTraj,
+    BeamformerTime,
+    BeamformerTimeSq,
+    BeamformerTimeSqTraj,
+    BeamformerTimeTraj,
+    IntegratorSectorTime,
+)
+from .tprocess import (
+    AngleTracker,
+    ChannelMixer,
+    Filter,
+    FilterBank,
+    FiltFiltOctave,
+    FiltFreqWeight,
+    FiltOctave,
+    MaskedTimeInOut,
+    Mixer,
+    OctaveFilterBank,
+    SamplesGenerator,
+    SampleSplitter,
+    SpatialInterpolator,
+    SpatialInterpolatorConstantRotation,
+    SpatialInterpolatorRotation,
+    TimeAverage,
+    TimeCache,
+    TimeConvolve,
+    TimeCumAverage,
+    TimeExpAverage,
+    TimeInOut,
+    TimePower,
+    TimeReverse,
+    Trigger,
+    WriteH5,
+    WriteWAV,
+)
+from .trajectory import Trajectory
+from .version import __author__, __date__, __version__

{acoular-24.3 → acoular-24.7}/acoular/calib.py

@@ -1,10 +1,7 @@
-# -*- coding: utf-8 -*-
-#pylint: disable-msg=E0611, E1101, C0103, R0901, R0902, R0903, R0904, W0232
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 # Copyright (c) Acoular Development Team.
-#------------------------------------------------------------------------------
-"""
-Implements calibration of multichannel time signals.
+# ------------------------------------------------------------------------------
+"""Implements calibration of multichannel time signals.
 
 .. autosummary::
     :toctree: generated/
@@ -13,69 +10,64 @@ Implements calibration of multichannel time signals.
 """
 
 # imports from other packages
-from numpy import array
-from traits.api import HasPrivateTraits, CLong, File, CArray, Property, \
-cached_property, on_trait_change
 from os import path
 
+from numpy import array
+from traits.api import CArray, CLong, File, HasPrivateTraits, Property, cached_property, on_trait_change
+
 # acoular imports
 from .internal import digest
 
-class Calib( HasPrivateTraits ):
-    """
-    Container for calibration data in `*.xml` format
-    
+
+class Calib(HasPrivateTraits):
+    """Container for calibration data in `*.xml` format.
+
     This class serves as interface to load calibration data for the used
-    microphone array.
+    microphone array. The calibration factors are stored as [Pa/unit].
     """
 
     #: Name of the .xml file to be imported.
-    from_file = File(filter=['*.xml'], 
-        desc="name of the xml file to import")
+    from_file = File(filter=['*.xml'], desc='name of the xml file to import')
 
     #: Basename of the .xml-file. Readonly / is set automatically.
-    basename = Property( depends_on = 'from_file', 
-        desc="basename of xml file")
-    
-    #: Number of microphones in the calibration data, 
+    basename = Property(depends_on='from_file', desc='basename of xml file')
+
+    #: Number of microphones in the calibration data,
     #: is set automatically / read from file.
-    num_mics = CLong( 0, 
-        desc="number of microphones in the geometry")
+    num_mics = CLong(0, desc='number of microphones in the geometry')
 
-    #: Array of calibration factors, 
+    #: Array of calibration factors,
     #: is set automatically / read from file.
-    data = CArray(
-        desc="calibration data")
+    data = CArray(desc='calibration data')
 
     # Internal identifier
-    digest = Property( depends_on = ['basename', ] )
+    digest = Property(depends_on=['basename'])
 
     @cached_property
-    def _get_digest( self ):
+    def _get_digest(self):
         return digest(self)
-    
+
     @cached_property
-    def _get_basename( self ):
+    def _get_basename(self):
         if not path.isfile(self.from_file):
             return ''
         return path.splitext(path.basename(self.from_file))[0]
-    
+
     @on_trait_change('basename')
-    def import_data( self ):
-        """ 
-        Loads the calibration data from `*.xml` file .
-        """
+    def import_data(self):
+        """Loads the calibration data from `*.xml` file ."""
         if not path.isfile(self.from_file):
             # empty calibration
-            if self.basename=='':
-                self.data = None 
+            if self.basename == '':
+                self.data = None
                 self.num_mics = 0
             # no file there
             else:
-                self.data = array([1.0, ], 'd')
+                self.data = array([1.0], 'd')
                 self.num_mics = 1
             return
         import xml.dom.minidom
+
         doc = xml.dom.minidom.parse(self.from_file)
         names = []
         data = []
@@ -84,4 +76,3 @@ class Calib( HasPrivateTraits ):
             data.append(float(element.getAttribute('factor')))
         self.data = array(data, 'd')
         self.num_mics = self.data.shape[0]
-