acoular 25.7__py3-none-any.whl → 26.1__py3-none-any.whl

acoular/aiaa/aiaa.py

@@ -27,18 +27,17 @@ Examples
 
 import contextlib
 
-from numpy import array
+import numpy as np
 from traits.api import (
     File,
     Instance,
     Property,
     Union,
     cached_property,
-    on_trait_change,
+    observe,
     property_depends_on,
 )
 
-from acoular.deprecation import deprecated_alias
 from acoular.h5files import H5FileBase, _get_h5file_class
 from acoular.internal import digest
 from acoular.microphones import MicGeom
@@ -85,7 +84,6 @@ class TriggerAIAABenchmark(TimeSamplesAIAABenchmark):
         (self.num_samples, self.num_channels) = self.data.shape
 
 
-@deprecated_alias({'name': 'file'}, removal_version='25.10')
 class CsmAIAABenchmark(PowerSpectraImport):
     """Class to load the CSM that is stored in AIAA Benchmark HDF5 file."""
 
@@ -104,7 +102,7 @@ class CsmAIAABenchmark(PowerSpectraImport):
     #: HDF5 file object
     h5f = Instance(H5FileBase, transient=True)
 
-    # internal identifier
+    #: A unique identifier for the CSM importer, based on its properties. (read-only)
     digest = Property(depends_on=['basename', '_csmsum'])
 
     @cached_property
@@ -115,8 +113,8 @@ class CsmAIAABenchmark(PowerSpectraImport):
     def _get_basename(self):
         return get_file_basename(self.file)
 
-    @on_trait_change('basename')
-    def load_data(self):
+    @observe('basename')
+    def _load_data(self, event):  # noqa ARG002
         """Open the .h5 file and set attributes."""
         if self.h5f is not None:
             with contextlib.suppress(OSError):
@@ -156,7 +154,7 @@ class CsmAIAABenchmark(PowerSpectraImport):
         ndarray
             Array of length *block_size/2+1* containing the sample frequencies.
         """
-        return array(self.h5f.get_data_by_reference('/CsmData/binCenterFrequenciesHz')[:].flatten(), dtype=float)
+        return np.array(self.h5f.get_data_by_reference('/CsmData/binCenterFrequenciesHz')[:].flatten(), dtype=float)
 
 
 class MicAIAABenchmark(MicGeom):
@@ -172,8 +170,8 @@ class MicAIAABenchmark(MicGeom):
         None, File(filter=['*.h5'], exists=True), desc='name of the h5 file containing the microphone geometry'
     )
 
-    @on_trait_change('file')
-    def _import_mpos(self):
+    @observe('file')
+    def _import_mpos(self, event):  # noqa ARG002
         """
         Import the microphone positions from .h5 file.
 

acoular/base.py

@@ -7,6 +7,12 @@ The classes in this module are abstract base classes that provide a common inter
 that generate an output via the generator :meth:`result` in block-wise manner. They are not intended
 to be used directly, but to be subclassed by classes that implement the actual signal processing.
 
+.. inheritance-diagram::
+                acoular.base
+    :top-classes:
+                acoular.base.Generator
+    :parts: 1
+
 .. autosummary::
     :toctree: generated/
 
@@ -32,11 +38,9 @@ from traits.api import (
 )
 
 # acoular imports
-from .deprecation import deprecated_alias
 from .internal import digest
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples'}, removal_version='25.10')
 class Generator(ABCHasStrictTraits):
     """Interface for any generating signal processing block.
 
@@ -51,7 +55,7 @@ class Generator(ABCHasStrictTraits):
     """
 
     #: Sampling frequency of the signal, defaults to 1.0
-    sample_freq = Float(1.0, desc='sampling frequency')
+    sample_freq = Float(1.0)
 
     #: Number of signal samples
     num_samples = CInt
@@ -59,7 +63,7 @@ class Generator(ABCHasStrictTraits):
     #: Number of channels
     num_channels = CInt
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['sample_freq', 'num_samples', 'num_channels'])
 
     def _get_digest(self):
@@ -92,7 +96,7 @@ class SamplesGenerator(Generator):
 
     """
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['sample_freq', 'num_samples', 'num_channels'])
 
     def _get_digest(self):
@@ -133,7 +137,7 @@ class SpectraGenerator(Generator):
     #: The length of the block used to calculate the spectra
     block_size = CInt
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['sample_freq', 'num_samples', 'num_channels', 'num_freqs', 'block_size'])
 
     def _get_digest(self):
@@ -156,7 +160,6 @@ class SpectraGenerator(Generator):
         """
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples'}, read_only=True, removal_version='25.10')
 class TimeOut(SamplesGenerator):
     """
     Abstract base class receiving from a :attr:`source` and returning time domain signals.
@@ -178,7 +181,7 @@ class TimeOut(SamplesGenerator):
     #: Number of samples in output, as given by :attr:`source`.
     num_samples = Delegate('source')
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest'])
 
     @cached_property
@@ -204,11 +207,6 @@ class TimeOut(SamplesGenerator):
         """
 
 
-@deprecated_alias(
-    {'numchannels': 'num_channels', 'numsamples': 'num_samples', 'numfreqs': 'num_freqs'},
-    read_only=True,
-    removal_version='25.10',
-)
 class SpectraOut(SpectraGenerator):
     """
     Abstract base class receiving from a :attr:`source` and returning frequency domain signals.
@@ -239,7 +237,7 @@ class SpectraOut(SpectraGenerator):
     #: The size of the block used to calculate the spectra
     block_size = Delegate('source')
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest'])
 
     @cached_property
@@ -263,7 +261,6 @@ class SpectraOut(SpectraGenerator):
         """
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples'}, read_only=True, removal_version='25.10')
 class InOut(SamplesGenerator, SpectraGenerator):
     """
     Abstract base class receiving from a :attr:`source` and returning signals in the same domain.
@@ -288,7 +285,7 @@ class InOut(SamplesGenerator, SpectraGenerator):
     #: Number of samples / snapshots in output, as given by :attr:`source`.
     num_samples = Delegate('source')
 
-    # internal identifier
+    #: A unique identifier for the generator, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest'])
 
     @cached_property

acoular/calib.py

@@ -3,6 +3,12 @@
 # ------------------------------------------------------------------------------
 """Implements calibration of multichannel time signals.
 
+.. inheritance-diagram::
+                acoular.calib
+    :top-classes:
+                acoular.base.InOut
+    :parts: 1
+
 .. autosummary::
     :toctree: generated/
 
@@ -12,19 +18,14 @@
 # imports from other packages
 import xml.dom.minidom
 
-from numpy import array, newaxis
-from traits.api import CArray, CInt, File, List, Property, Union, cached_property, on_trait_change
-
-import acoular as ac
-
-from .base import InOut
+import numpy as np
+from traits.api import CArray, CInt, File, List, Property, Union, cached_property, observe
 
 # acoular imports
-from .deprecation import deprecated_alias
+from .base import InOut, SamplesGenerator, SpectraGenerator
 from .internal import digest
 
 
-@deprecated_alias({'from_file': 'file'}, removal_version='25.10')
 class Calib(InOut):
     """Processing block for handling calibration data in `*.xml` or NumPy format.
 
@@ -77,30 +78,30 @@ class Calib(InOut):
     """
 
     #: Name of the .xml file to be imported.
-    file = Union(None, File(filter=['*.xml'], exists=True), desc='name of the xml file to import')
+    file = Union(None, File(filter=['*.xml'], exists=True))
 
     #: Number of microphones in the calibration data,
     #: is set automatically when read from file or when data is set.
-    num_mics = CInt(0, desc='number of microphones in the geometry')
+    num_mics = CInt(0)
 
     #: Array of calibration factors,
     #: is set automatically when read from file.
     #: Can be set manually by specifying a NumPy array with shape (num_channels, ) if
     #: :attr:`source` yields time domain signals. For frequency domain signals, the expected
     #: shape is (num_channels * num_freqs).
-    data = CArray(desc='calibration data')
+    data = CArray()
 
     #: Channels that are to be treated as invalid.
-    invalid_channels = List(int, desc='list of invalid channels')
+    invalid_channels = List(int)
 
     #: Channel mask to serve as an index for all valid channels, is set automatically.
-    channels = Property(depends_on=['invalid_channels', 'num_mics'], desc='channel mask')
+    channels = Property(depends_on=['invalid_channels', 'num_mics'])
 
-    # Internal identifier
+    #: A unique identifier for the object, based on its properties. (read-only)
     digest = Property(depends_on=['source.digest', 'data'])
 
-    @on_trait_change('data')
-    def set_num_mics(self):
+    @observe('data')
+    def _update_num_mics(self, event):  # noqa ARG002
         """Sets the number of microphones based on the shape of the data array."""
         self.num_mics = self.data.shape[0]
 
@@ -109,14 +110,14 @@ class Calib(InOut):
         if len(self.invalid_channels) == 0:
             return slice(0, None, None)
         allr = [i for i in range(self.num_mics) if i not in self.invalid_channels]
-        return array(allr)
+        return np.array(allr)
 
     @cached_property
     def _get_digest(self):
         return digest(self)
 
-    @on_trait_change('file')
-    def import_data(self):
+    @observe('file')
+    def _import_data(self, event):  # noqa ARG002
         """Loads the calibration data from `*.xml` file ."""
         doc = xml.dom.minidom.parse(self.file)
         names = []
@@ -124,7 +125,7 @@ class Calib(InOut):
         for element in doc.getElementsByTagName('pos'):
             names.append(element.getAttribute('Name'))
             data.append(float(element.getAttribute('factor')))
-        self.data = array(data, 'd')
+        self.data = np.array(data, 'd')
         self.num_mics = self.data.shape[0]
 
     def __validate_data(self):
@@ -136,13 +137,13 @@ class Calib(InOut):
             msg = 'No source data available.'
             raise ValueError(msg)
         tobj = self.source
-        while isinstance(tobj, ac.InOut):
+        while isinstance(tobj, InOut):
             tobj = tobj.source
-        if isinstance(tobj, ac.SamplesGenerator) and (self.data[self.channels].shape[0] != tobj.num_channels):
+        if isinstance(tobj, SamplesGenerator) and (self.data[self.channels].shape[0] != tobj.num_channels):
             msg = f'calibration data shape {self.data[self.channels].shape[0]} does not match \
                 source data shape {tobj.num_channels}'
             raise ValueError(msg)
-        if isinstance(tobj, ac.SpectraGenerator) and (
+        if isinstance(tobj, SpectraGenerator) and (
             self.data[self.channels].shape[0] != tobj.num_channels * tobj.num_freqs
         ):
             msg = f'calibration data shape {self.data[self.channels].shape[0]} does not match \
@@ -170,4 +171,4 @@ class Calib(InOut):
         """
         self.__validate_data()
         for block in self.source.result(num):
-            yield block * self.data[self.channels][newaxis]
+            yield block * self.data[self.channels][np.newaxis]

acoular/configuration.py

@@ -39,9 +39,9 @@ if 'numpy' in sys.modules:
     # check if it uses OpenBLAS or another library
     if 'openblas' in temp_stdout.getvalue().lower() and environ.get('OPENBLAS_NUM_THREADS') != '1':
         # it's OpenBLAS, set numba threads=1 to avoid overcommittment
-        import numba
+        import numba as nb
 
-        numba.set_num_threads(1)
+        nb.set_num_threads(1)
         warn(
             'We detected that Numpy is already loaded and uses OpenBLAS. Because '
             'this conflicts with Numba parallel execution, we disable parallel '

acoular/demo/__init__.py

@@ -5,15 +5,103 @@
 
 .. autosummary::
     :toctree: generated/
+"""
 
-    acoular_demo
 
-"""
+def create_three_sources(mg, h5savefile='three_sources.h5'):
+    """
+    Create three noise sources and return them as Mixer.
+
+    Alias for :func:`create_three_sources_2d`.
+    """
+    return create_three_sources_2d(mg, h5savefile=h5savefile)
+
+
+def _create_three_sources(mg, locs, h5savefile='', sfreq=51200, duration=1):
+    """Create three noise sources with custom locations and return them as Mixer."""
+    import acoular as ac
+
+    nsamples = duration * sfreq
+
+    n1 = ac.WNoiseGenerator(sample_freq=sfreq, num_samples=nsamples, seed=1)
+    n2 = ac.WNoiseGenerator(sample_freq=sfreq, num_samples=nsamples, seed=2, rms=0.7)
+    n3 = ac.WNoiseGenerator(sample_freq=sfreq, num_samples=nsamples, seed=3, rms=0.5)
+
+    noises = [n1, n2, n3]
+    ps = [ac.PointSource(signal=n, mics=mg, loc=loc) for n, loc in list(zip(noises, locs, strict=True))]
+    pa = ac.Mixer(source=ps[0], sources=ps[1:])
+
+    if h5savefile:
+        wh5 = ac.WriteH5(source=pa, file=h5savefile)
+        wh5.save()
+    return pa
+
+
+def create_three_sources_1d(mg, h5savefile='three_sources_1d.h5'):
+    """Create three noise sources on a 1D line and return them as Mixer."""
+    locs = [(-0.1, 0, -0.3), (0.15, 0, -0.3), (0, 0, -0.3)]
+    return _create_three_sources(mg, locs, h5savefile=h5savefile)
+
+
+def create_three_sources_2d(mg, h5savefile='three_sources_2d.h5'):
+    """Create three noise sources in a 2D plane and return them as Mixer."""
+    locs = [(-0.1, -0.1, -0.3), (0.15, 0, -0.3), (0, 0.1, -0.3)]
+    return _create_three_sources(mg, locs, h5savefile=h5savefile)
+
+
+def create_three_sources_3d(mg, h5savefile='three_sources_3d.h5'):
+    """Create three noise sources in 3D space and return them as Mixer."""
+    locs = [(-0.1, -0.1, -0.3), (0.15, 0, -0.17), (0, 0.1, -0.25)]
+    return _create_three_sources(mg, locs, h5savefile=h5savefile)
+
+
+def run():
+    """Run the Acoular demo."""
+    from pathlib import Path
+
+    import acoular as ac
+
+    ac.config.global_caching = 'none'
+
+    # set up microphone geometry
+
+    micgeofile = Path(ac.__file__).parent / 'xml' / 'array_64.xml'
+    mg = ac.MicGeom(file=micgeofile)
+
+    # generate test data, in real life this would come from an array measurement
+
+    pa = create_three_sources(mg)
+
+    # analyze the data and generate map
+
+    ps = ac.PowerSpectra(source=pa, block_size=128, window='Hanning')
+
+    rg = ac.RectGrid(x_min=-0.2, x_max=0.2, y_min=-0.2, y_max=0.2, z=-0.3, increment=0.01)
+    st = ac.SteeringVector(grid=rg, mics=mg)
+
+    bb = ac.BeamformerBase(freq_data=ps, steer=st)
+    pm = bb.synthetic(8000, 3)
+    spl = ac.L_p(pm)
+
+    if ac.config.have_matplotlib:
+        from matplotlib.pyplot import axis, colorbar, figure, imshow, plot, show
+
+        # show map
+        imshow(spl.T, origin='lower', vmin=spl.max() - 10, extent=rg.extent, interpolation='bicubic')
+        colorbar()
+
+        # plot microphone geometry
+        figure(2)
+        plot(mg.pos[0], mg.pos[1], 'o')
+        axis('equal')
+
+        show()
 
-from . import acoular_demo
-from .acoular_demo import (
-    create_three_sources,
-    create_three_sources_1d,
-    create_three_sources_2d,
-    create_three_sources_3d,
-)
+    else:
+        print('Matplotlib not found! Please install matplotlib if you want to plot the results.')
+        print('For consolation we do an ASCII map plot of the results here.')
+        grayscale = '@%#*+=-:. '[::-1]
+        ind = ((spl.T - spl.max() + 9).clip(0, 9)).astype(int)[::-1]
+        print(78 * '-')
+        print('|\n'.join([' '.join(['|'] + [grayscale[i] for i in row[2:-1]]) for row in ind]) + '|')
+        print(7 * '-', ''.join([f'{grayscale[i]}={int(spl.max()) - 9 + i}dB ' for i in range(1, 10)]), 6 * '-')

acoular/demo/__main__.py

@@ -0,0 +1,37 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) Acoular Development Team.
+# ------------------------------------------------------------------------------
+"""Demo for Acoular.
+
+To run the demo, execute the following commands:
+
+.. code-block:: python
+
+    import acoular
+
+    acoular.demo.run()
+
+
+Generates a test data set for three sources, analyzes them and generates a
+map of the three sources.
+
+The simulation generates the sound pressure at 64 microphones that are
+arrangend in the 'array64' geometry, which is part of the package. The sound
+pressure signals are sampled at 51200 Hz for a duration of 1 second.
+
+Source location (relative to array center) and RMS in 1 m distance:
+
+====== =============== ======
+Source Location        RMS
+====== =============== ======
+1      (-0.1,-0.1,0.3) 1.0 Pa
+2      (0.15,0,0.3)    0.7 Pa
+3      (0,0.1,0.3)     0.5 Pa
+====== =============== ======
+
+"""
+
+if __name__ == '__main__':
+    from . import run
+
+    run()