acoular 24.7__tar.gz → 25.1__tar.gz

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

@@ -17,6 +17,7 @@ __pycache__/
 *.nbi
 *.pyd
 .vscode/
+.venv*
 
 MANIFEST
 

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: acoular
-Version: 24.7
+Version: 25.1
 Summary: Python library for acoustic beamforming
 Project-URL: homepage, https://acoular.org
 Project-URL: documentation, https://acoular.org
@@ -42,21 +42,21 @@ 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.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: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Physics
-Requires-Python: <=12,>=3.8
+Requires-Python: <3.14,>=3.10
 Requires-Dist: numba
-Requires-Dist: numpy<2.0
+Requires-Dist: numpy
 Requires-Dist: scikit-learn
 Requires-Dist: scipy>=1.1.0
-Requires-Dist: tables>=3.4.4
+Requires-Dist: tables
 Requires-Dist: traits>=6.0
 Provides-Extra: dev
 Requires-Dist: graphviz; extra == 'dev'
+Requires-Dist: h5py; extra == 'dev'
 Requires-Dist: hatch; extra == 'dev'
 Requires-Dist: ipython; extra == 'dev'
 Requires-Dist: matplotlib; extra == 'dev'
@@ -64,15 +64,48 @@ 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: pytest-cases; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-env; extra == 'dev'
+Requires-Dist: pytest-mock; extra == 'dev'
+Requires-Dist: pytest-profiling; extra == 'dev'
+Requires-Dist: pytest-regtest; extra == 'dev'
+Requires-Dist: pyyaml; extra == 'dev'
+Requires-Dist: ruff==0.8.1; extra == 'dev'
+Requires-Dist: setuptools; extra == 'dev'
 Requires-Dist: sounddevice; extra == 'dev'
 Requires-Dist: sphinx; extra == 'dev'
 Requires-Dist: sphinx-gallery; extra == 'dev'
+Requires-Dist: sphinxcontrib-bibtex; extra == 'dev'
 Requires-Dist: traitsui; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: graphviz; extra == 'docs'
+Requires-Dist: ipython; extra == 'docs'
+Requires-Dist: matplotlib; extra == 'docs'
+Requires-Dist: numpydoc; extra == 'docs'
+Requires-Dist: pickleshare; extra == 'docs'
+Requires-Dist: setuptools; extra == 'docs'
+Requires-Dist: sounddevice; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-gallery; extra == 'docs'
+Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
 Provides-Extra: full
 Requires-Dist: matplotlib; extra == 'full'
 Requires-Dist: pylops; extra == 'full'
 Requires-Dist: sounddevice; extra == 'full'
+Provides-Extra: tests
+Requires-Dist: h5py; extra == 'tests'
+Requires-Dist: pylops; extra == 'tests'
+Requires-Dist: pytest; extra == 'tests'
+Requires-Dist: pytest-cases; extra == 'tests'
+Requires-Dist: pytest-cov; extra == 'tests'
+Requires-Dist: pytest-env; extra == 'tests'
+Requires-Dist: pytest-mock; extra == 'tests'
+Requires-Dist: pytest-profiling; extra == 'tests'
+Requires-Dist: pytest-regtest; extra == 'tests'
+Requires-Dist: pyyaml; extra == 'tests'
+Requires-Dist: sounddevice; extra == 'tests'
+Requires-Dist: traitsui; extra == 'tests'
 Description-Content-Type: text/markdown
 
 ![Acoular Logo](https://github.com/acoular/acoular/blob/master/docs/source/_static/Acoular_logo.png?raw=true)
@@ -164,35 +197,44 @@ If you are interested in contributing, have a look at the [CONTRIBUTING.md](CONT
 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
+from os.path import join, split
+import acoular as ac
+import matplotlib.pylab as plt
 
 # this file contains the microphone coordinates
-micgeofile = path.join(path.split(acoular.__file__)[0],'xml','array_64.xml')
+micgeofile = join(split(ac.__file__)[0],'xml','array_64.xml')
 # set up object managing the microphone coordinates
-mg = acoular.MicGeom( from_file=micgeofile )
+mg = ac.MicGeom( file=micgeofile )
+# generate test data, in real life this would come from an array measurement
+p = ac.demo.create_three_sources(mg, h5savefile='three_sources.h5')
 # set up object managing the microphone array data (usually from measurement)
-ts = acoular.TimeSamples( name='three_sources.h5' )
+ts = ac.TimeSamples( file='three_sources.h5')
 # set up object managing the cross spectral matrix computation
-ps = acoular.PowerSpectra( time_data=ts, block_size=128, window='Hanning' )
+ps = ac.PowerSpectra( source=ts, block_size=128, window='Hanning' )
+# alternatively, you can use the in-memory Mixer object directly:
+# ps = ac.PowerSpectra( source=p, 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, \
+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 )
 # set up steering vector, implicitely contains also the standard quiescent 
 # environment with standard speed of sound
-st = acoular.SteeringVector( grid = rg, mics=mg )
+st = ac.SteeringVector( grid = rg, mics=mg )
 # set up the object managing the delay & sum beamformer
-bb = acoular.BeamformerBase( freq_data=ps, steer=st )
+bb = ac.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 )
+Lm = ac.L_p( pm )
 # plot the map
-imshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \
+plt.imshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \
 interpolation='bicubic')
-colorbar()
+plt.title(f'Beamformer (base) for 3 sources measured for 8000 Hz')
+plt.xlabel('x in m')
+plt.ylabel('y in m')
+plt.colorbar(label=r'$L_p$')
+plt.savefig('three_sources.png', dpi=300, bbox_inches='tight')
+plt.show()
 ```
 
 ![result](https://github.com/acoular/acoular/blob/master/docs/source/get_started/three_source_py3_colormap.png?raw=true)

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

@@ -87,35 +87,44 @@ If you are interested in contributing, have a look at the [CONTRIBUTING.md](CONT
 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
+from os.path import join, split
+import acoular as ac
+import matplotlib.pylab as plt
 
 # this file contains the microphone coordinates
-micgeofile = path.join(path.split(acoular.__file__)[0],'xml','array_64.xml')
+micgeofile = join(split(ac.__file__)[0],'xml','array_64.xml')
 # set up object managing the microphone coordinates
-mg = acoular.MicGeom( from_file=micgeofile )
+mg = ac.MicGeom( file=micgeofile )
+# generate test data, in real life this would come from an array measurement
+p = ac.demo.create_three_sources(mg, h5savefile='three_sources.h5')
 # set up object managing the microphone array data (usually from measurement)
-ts = acoular.TimeSamples( name='three_sources.h5' )
+ts = ac.TimeSamples( file='three_sources.h5')
 # set up object managing the cross spectral matrix computation
-ps = acoular.PowerSpectra( time_data=ts, block_size=128, window='Hanning' )
+ps = ac.PowerSpectra( source=ts, block_size=128, window='Hanning' )
+# alternatively, you can use the in-memory Mixer object directly:
+# ps = ac.PowerSpectra( source=p, 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, \
+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 )
 # set up steering vector, implicitely contains also the standard quiescent 
 # environment with standard speed of sound
-st = acoular.SteeringVector( grid = rg, mics=mg )
+st = ac.SteeringVector( grid = rg, mics=mg )
 # set up the object managing the delay & sum beamformer
-bb = acoular.BeamformerBase( freq_data=ps, steer=st )
+bb = ac.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 )
+Lm = ac.L_p( pm )
 # plot the map
-imshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \
+plt.imshow( Lm.T, origin='lower', vmin=Lm.max()-10, extent=rg.extend(), \
 interpolation='bicubic')
-colorbar()
+plt.title(f'Beamformer (base) for 3 sources measured for 8000 Hz')
+plt.xlabel('x in m')
+plt.ylabel('y in m')
+plt.colorbar(label=r'$L_p$')
+plt.savefig('three_sources.png', dpi=300, bbox_inches='tight')
+plt.show()
 ```
 
 ![result](https://github.com/acoular/acoular/blob/master/docs/source/get_started/three_source_py3_colormap.png?raw=true)

{acoular-24.7 → acoular-25.1}/acoular/__init__.py

@@ -4,11 +4,22 @@
 
 """The Acoular library: several classes for the implementation of acoustic beamforming."""
 
-import os
+import os  # noqa: I001
 
-from . import demo, tools
-from .calib import Calib
+# config must be imported before any submodules containing numpy, see #322.
 from .configuration import config
+
+from . import demo, tools, aiaa
+from .base import (
+    Generator,
+    InOut,
+    SamplesGenerator,
+    SpectraGenerator,
+    SpectraOut,
+    TimeInOut,
+    TimeOut,
+)
+from .calib import Calib
 from .environments import (
     Environment,
     FlowField,
@@ -41,6 +52,7 @@ from .fbeamform import (
     SteeringVector,
     integrate,
 )
+from .fprocess import IRFFT, RFFT, AutoPowerSpectra, CrossPowerSpectra, FFTSpectra
 from .grids import (
     CircSector,
     ConvexSector,
@@ -57,10 +69,13 @@ from .grids import (
     Sector,
 )
 from .microphones import MicGeom
+from .process import Average, Cache, SampleSplitter, TimeAverage, TimeCache
 from .sdinput import SoundDeviceSamplesGenerator
 from .signals import (
     FiltWNoiseGenerator,
     GenericSignalGenerator,
+    NoiseGenerator,
+    PeriodicSignalGenerator,
     PNoiseGenerator,
     SignalGenerator,
     SineGenerator,
@@ -80,7 +95,8 @@ from .sources import (
     TimeSamples,
     UncorrelatedNoiseSource,
 )
-from .spectra import BaseSpectra, FFTSpectra, PowerSpectra, PowerSpectraImport, synthetic
+from .tools.helpers import synthetic
+from .spectra import BaseSpectra, PowerSpectra, PowerSpectraImport
 from .spectra import PowerSpectra as EigSpectra
 from .tbeamform import (
     BeamformerCleant,
@@ -102,19 +118,15 @@ from .tprocess import (
     FiltFreqWeight,
     FiltOctave,
     MaskedTimeInOut,
+    MaskedTimeOut,
     Mixer,
     OctaveFilterBank,
-    SamplesGenerator,
-    SampleSplitter,
     SpatialInterpolator,
     SpatialInterpolatorConstantRotation,
     SpatialInterpolatorRotation,
-    TimeAverage,
-    TimeCache,
     TimeConvolve,
     TimeCumAverage,
     TimeExpAverage,
-    TimeInOut,
     TimePower,
     TimeReverse,
     Trigger,

acoular-25.1/acoular/aiaa/__init__.py

@@ -0,0 +1,12 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) Acoular Development Team.
+# ------------------------------------------------------------------------------
+"""Provides classes for importing AIAA Array Benchmarks.
+
+.. autosummary::
+    :toctree: generated/
+
+    aiaa
+"""
+
+from .aiaa import CsmAIAABenchmark, MicAIAABenchmark, TimeSamplesAIAABenchmark, TriggerAIAABenchmark

{acoular-24.7/acoular/tools → acoular-25.1/acoular/aiaa}/aiaa.py

@@ -1,8 +1,8 @@
 # ------------------------------------------------------------------------------
 # Copyright (c) Acoular Development Team.
 # ------------------------------------------------------------------------------
-"""Classes for importing AIAA Array Benchmarks
-from . import aiaa
+"""Classes for importing AIAA Array Benchmarks.
+
 These classes allow importing data from HDF5 files following the specifications of
 the AIAA microphone array methods benchmarking effort:
 https://www-docs.b-tu.de/fg-akustik/public/veroeffentlichungen/ArrayMethodsFileFormatsR2P4Release.pdf .
@@ -12,8 +12,8 @@ the framework.
 
 Examples
 --------
->>> micgeom = MicAIAABenchmark(name='some_benchmarkdata.h5')  # doctest: +SKIP
->>> timedata = TimeSamplesAIAABenchmark(name='some_benchmarkdata.h5')  # doctest: +SKIP
+>>> micgeom = MicAIAABenchmark(file='some_benchmarkdata.h5')  # doctest: +SKIP
+>>> timedata = TimeSamplesAIAABenchmark(file='some_benchmarkdata.h5')  # doctest: +SKIP
 
 
 .. autosummary::
@@ -23,10 +23,9 @@ Examples
     TriggerAIAABenchmark
     CsmAIAABenchmark
     MicAIAABenchmark
-"""
+"""  # noqa: W505
 
 import contextlib
-from os import path
 
 from numpy import array
 from traits.api import (
@@ -38,11 +37,13 @@ from traits.api import (
     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
 from acoular.sources import TimeSamples
 from acoular.spectra import PowerSpectraImport
+from acoular.tools.utils import get_file_basename
 
 
 class TimeSamplesAIAABenchmark(TimeSamples):
@@ -54,13 +55,13 @@ class TimeSamplesAIAABenchmark(TimeSamples):
     objects.
     """
 
-    def load_timedata(self):
+    def _load_timedata(self):
         """Loads timedata from .h5 file. Only for internal use."""
         self.data = self.h5f.get_data_by_reference('MicrophoneData/microphoneDataPa')
         self.sample_freq = self.h5f.get_node_attribute(self.data, 'sampleRateHz')
-        (self.numsamples, self.numchannels) = self.data.shape
+        (self.num_samples, self.num_channels) = self.data.shape
 
-    def load_metadata(self):
+    def _load_metadata(self):
         """Loads metadata from .h5 file. Only for internal use."""
         self.metadata = {}
         if '/MetaData' in self.h5f:
@@ -76,27 +77,28 @@ class TriggerAIAABenchmark(TimeSamplesAIAABenchmark):
     and and provides information about this data.
     """
 
-    def load_timedata(self):
+    def _load_timedata(self):
         """Loads timedata from .h5 file. Only for internal use."""
         self.data = self.h5f.get_data_by_reference('TachoData/tachoDataV')
         self.sample_freq = self.h5f.get_node_attribute(self.data, 'sampleRateHz')
-        (self.numsamples, self.numchannels) = self.data.shape
+        (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."""
 
     #: Full name of the .h5 file with data
-    name = File(filter=['*.h5'], desc='name of data file')
+    file = File(filter=['*.h5'], exists=True, desc='name of data file')
 
     #: Basename of the .h5 file with data, is set automatically.
     basename = Property(
-        depends_on='name',
+        depends_on=['file'],
         desc='basename of data file',
     )
 
     #: number of channels
-    numchannels = Property()
+    num_channels = Property()
 
     #: HDF5 file object
     h5f = Instance(H5FileBase, transient=True)
@@ -110,19 +112,16 @@ class CsmAIAABenchmark(PowerSpectraImport):
 
     @cached_property
     def _get_basename(self):
-        return path.splitext(path.basename(self.name))[0]
+        return get_file_basename(self.file)
 
     @on_trait_change('basename')
     def load_data(self):
         """Open the .h5 file and set attributes."""
-        if not path.isfile(self.name):
-            # no file there
-            raise OSError('No such file: %s' % self.name)
         if self.h5f is not None:
             with contextlib.suppress(OSError):
                 self.h5f.close()
         file = _get_h5file_class()
-        self.h5f = file(self.name)
+        self.h5f = file(self.file)
 
     # @property_depends_on( 'block_size, ind_low, ind_high' )
     def _get_indices(self):
@@ -131,15 +130,15 @@ class CsmAIAABenchmark(PowerSpectraImport):
         except IndexError:
             return range(0)
 
-    @property_depends_on('digest')
-    def _get_numchannels(self):
+    @property_depends_on(['digest'])
+    def _get_num_channels(self):
         try:
             attrs = self.h5f.get_data_by_reference('MetaData/ArrayAttributes')
             return self.h5f.get_node_attribute(attrs, 'microphoneCount')
         except IndexError:
             return 0
 
-    @property_depends_on('digest')
+    @property_depends_on(['digest'])
     def _get_csm(self):
         """Loads cross spectral matrix from file."""
         csmre = self.h5f.get_data_by_reference('/CsmData/csmReal')[:].transpose((2, 0, 1))
@@ -167,19 +166,15 @@ class MicAIAABenchmark(MicGeom):
     file containing the measurement data.
     """
 
-    #: Name of the .h5-file from wich to read the data.
-    from_file = File(filter=['*.h5'], desc='name of the h5 file containing the microphone geometry')
+    #: Name of the .h5-file from which to read the data.
+    file = File(filter=['*.h5'], exists=True, desc='name of the h5 file containing the microphone geometry')
 
-    @on_trait_change('basename')
+    @on_trait_change('file')
     def import_mpos(self):
         """Import the microphone positions from .h5 file.
         Called when :attr:`basename` changes.
         """
-        if not path.isfile(self.from_file):
-            # no file there
-            raise OSError('No such file: %s' % self.from_file)
-
         file = _get_h5file_class()
-        h5f = file(self.from_file, mode='r')
-        self.mpos_tot = h5f.get_data_by_reference('MetaData/ArrayAttributes/microphonePositionsM')[:].swapaxes(0, 1)
+        h5f = file(self.file, mode='r')
+        self.pos_total = h5f.get_data_by_reference('MetaData/ArrayAttributes/microphonePositionsM')[:].swapaxes(0, 1)
         h5f.close()