acoular 25.4__py3-none-any.whl → 25.10__py3-none-any.whl

acoular/__init__.py

@@ -16,7 +16,6 @@ from .base import (
     SamplesGenerator,
     SpectraGenerator,
     SpectraOut,
-    TimeInOut,
     TimeOut,
 )
 from .calib import Calib
@@ -52,7 +51,7 @@ from .fbeamform import (
     SteeringVector,
     integrate,
 )
-from .fprocess import IRFFT, RFFT, AutoPowerSpectra, CrossPowerSpectra, FFTSpectra
+from .fprocess import IRFFT, RFFT, AutoPowerSpectra, CrossPowerSpectra
 from .grids import (
     CircSector,
     ConvexSector,
@@ -69,7 +68,7 @@ from .grids import (
     Sector,
 )
 from .microphones import MicGeom
-from .process import Average, Cache, SampleSplitter, TimeAverage, TimeCache
+from .process import Average, Cache, SampleSplitter
 from .sdinput import SoundDeviceSamplesGenerator
 from .signals import (
     FiltWNoiseGenerator,
@@ -117,7 +116,6 @@ from .tprocess import (
     FiltFiltOctave,
     FiltFreqWeight,
     FiltOctave,
-    MaskedTimeInOut,
     MaskedTimeOut,
     Mixer,
     OctaveFilterBank,

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'})
 class CsmAIAABenchmark(PowerSpectraImport):
     """Class to load the CSM that is stored in AIAA Benchmark HDF5 file."""
 
@@ -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,9 +170,11 @@ 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):
-        """Import the microphone positions from .h5 file.
+    @observe('file')
+    def _import_mpos(self, event):  # noqa ARG002
+        """
+        Import the microphone positions from .h5 file.
+
         Called when :attr:`basename` changes.
         """
         file = _get_h5file_class()

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/
 
@@ -16,7 +22,6 @@ to be used directly, but to be subclassed by classes that implement the actual s
     InOut
     TimeOut
     SpectraOut
-    TimeInOut
 """
 
 from abc import abstractmethod
@@ -33,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'})
 class Generator(ABCHasStrictTraits):
     """Interface for any generating signal processing block.
 
@@ -157,10 +160,9 @@ class SpectraGenerator(Generator):
         """
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples'}, read_only=True)
 class TimeOut(SamplesGenerator):
-    """Abstract base class for any signal processing block that receives data from any
-    :attr:`source` domain and returns time domain signals.
+    """
+    Abstract base class receiving from a :attr:`source` and returning time domain signals.
 
     It provides a base class that can be used to create signal processing blocks that receive data
     from any generating :attr:`source` and generates a time signal output via the generator
@@ -205,10 +207,9 @@ class TimeOut(SamplesGenerator):
         """
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples', 'numfreqs': 'num_freqs'}, read_only=True)
 class SpectraOut(SpectraGenerator):
-    """Abstract base class for any signal processing block that receives data from any
-    :attr:`source` domain and returns frequency domain signals.
+    """
+    Abstract base class receiving from a :attr:`source` and returning frequency domain signals.
 
     It provides a base class that can be used to create signal processing blocks that receive data
     from any generating :attr:`source` domain and generates a frequency domain output via the
@@ -260,10 +261,9 @@ class SpectraOut(SpectraGenerator):
         """
 
 
-@deprecated_alias({'numchannels': 'num_channels', 'numsamples': 'num_samples'}, read_only=True)
 class InOut(SamplesGenerator, SpectraGenerator):
-    """Abstract base class for any signal processing block that receives data from any
-    :attr:`source` domain and returns signals in the same domain.
+    """
+    Abstract base class receiving from a :attr:`source` and returning signals in the same domain.
 
     It provides a base class that can be used to create signal processing blocks that receive data
     from any generating :attr:`source` and generates an output via the generator :meth:`result` in
@@ -308,25 +308,3 @@ class InOut(SamplesGenerator, SpectraGenerator):
         numpy.ndarray
             Two-dimensional output data block of shape (num, ...)
         """
-
-
-class TimeInOut(TimeOut):
-    """Deprecated alias for :class:`~acoular.base.TimeOut`.
-
-    .. deprecated:: 24.10
-        Using :class:`~acoular.base.TimeInOut` is deprecated and will be removed in Acoular 25.07.
-        Use :class:`~acoular.base.TimeOut` instead.
-    """
-
-    #: Data source; :class:`~acoular.base.SamplesGenerator` or derived object.
-    source = Instance(SamplesGenerator)
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        import warnings
-
-        warnings.warn(
-            'TimeInOut is deprecated and will be removed in Acoular 25.07. Use TimeOut instead.',
-            DeprecationWarning,
-            stacklevel=2,
-        )

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'})
 class Calib(InOut):
     """Processing block for handling calibration data in `*.xml` or NumPy format.
 
@@ -72,7 +73,6 @@ class Calib(InOut):
     0.07458428+0.49657939j  1.772696  +3.92233098j  3.19543248+0.17988554j
     0.3379041 -3.93342331j  0.93949242+2.5328611j   2.97352574+0.j        ]]
 
-    Deprecated and will be removed in Acoular 25.10:
     This class serves as interface to load calibration data for the used
     microphone array. The calibration factors are stored as [Pa/unit].
     """
@@ -100,8 +100,9 @@ class Calib(InOut):
     # Internal identifier
     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]
 
     @cached_property
@@ -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 '
@@ -68,7 +68,7 @@ class Config(HasStrictTraits):
     The package used to read and write .h5 files can be specified
     by :attr:`h5library`.
 
-    Example:
+    Examples
     --------
         For using Acoular with h5py package and overwrite existing cache:
 

acoular/demo/__init__.py

@@ -11,4 +11,9 @@
 """
 
 from . import acoular_demo
-from .acoular_demo import create_three_sources
+from .acoular_demo import (
+    create_three_sources,
+    create_three_sources_1d,
+    create_three_sources_2d,
+    create_three_sources_3d,
+)

acoular/demo/acoular_demo.py

@@ -33,28 +33,52 @@ Source Location        RMS
 
 
 def create_three_sources(mg, h5savefile='three_sources.h5'):
-    """Create three noise sources and return them as Mixer."""
-    import acoular as ac
+    """
+    Create three noise sources and return them as Mixer.
+
+    Alias for :func:`create_three_sources_2d`.
+    """
+    return create_three_sources_2d(mg, h5savefile=h5savefile)
+
 
-    # set up the parameters
+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
 
-    sfreq = 51200
-    duration = 1
     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)
-    p1 = ac.PointSource(signal=n1, mics=mg, loc=(-0.1, -0.1, -0.3))
-    p2 = ac.PointSource(signal=n2, mics=mg, loc=(0.15, 0, -0.3))
-    p3 = ac.PointSource(signal=n3, mics=mg, loc=(0, 0.1, -0.3))
-    pa = ac.Mixer(source=p1, sources=[p2, p3])
+
+    noises = [n1, n2, n3]
+    ps = [ac.PointSource(signal=n, mics=mg, loc=loc) for n, loc in list(zip(noises, locs))]
+    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
@@ -87,7 +111,7 @@ def run():
         from matplotlib.pyplot import axis, colorbar, figure, imshow, plot, show
 
         # show map
-        imshow(spl.T, origin='lower', vmin=spl.max() - 10, extent=rg.extend(), interpolation='bicubic')
+        imshow(spl.T, origin='lower', vmin=spl.max() - 10, extent=rg.extent, interpolation='bicubic')
         colorbar()
 
         # plot microphone geometry

acoular/deprecation.py

@@ -1,6 +1,13 @@
 # ------------------------------------------------------------------------------
 # Copyright (c) Acoular Development Team.
 # ------------------------------------------------------------------------------
+"""Implements helper functions for deprecation handling.
+
+.. autosummary::
+    :toctree: generated/
+
+    deprecated_alias
+"""
 
 from warnings import warn
 
@@ -8,7 +15,9 @@ from traits.api import Property
 
 
 def deprecated_alias(old2new, read_only=False, removal_version=''):
-    """Decorator function for deprecating renamed class traits.
+    """
+    Decorator function for deprecating renamed class traits.
+
     Replaced traits should no longer be part of the class definition
     and only mentioned in this decorator's parameter list.
     The replacement trait has to be defined in the updated class and