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

acoular/aiaa/aiaa.py

@@ -102,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

acoular/base.py

@@ -55,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
@@ -63,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):
@@ -96,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):
@@ -137,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):
@@ -181,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
@@ -237,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
@@ -285,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

@@ -78,26 +78,26 @@ 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'])
 
     @observe('data')

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()

acoular/environments.py

@@ -182,7 +182,7 @@ class Environment(HasStrictTraits):
 
     #: The speed of sound in the environment. Default is ``343.0``, which corresponds to the
     #: approximate speed of sound at 20°C in dry air at sea level, if the unit is m/s.
-    c = Float(343.0, desc='speed of sound')
+    c = Float(343.0)
 
     #: The region of interest (ROI) for calculations. (Not needed for most types of environment.)
     #: Default is :obj:`None`.
@@ -250,11 +250,11 @@ class UniformFlowEnvironment(Environment):
 
     #: The Mach number of the flow, defined as the ratio of the flow velocity to the speed of sound.
     #: Default is ``0.0``, which corresponds to no flow.
-    ma = Float(0.0, desc='flow mach number')
+    ma = Float(0.0)
 
     #: A unit vector specifying the direction of the flow in 3D Cartesian coordinates.
     #: Default is ``(1.0, 0, 0)``, which corresponds to flow in the x-direction.
-    fdv = CArray(dtype=np.float64, shape=(3,), value=np.array((1.0, 0, 0)), desc='flow direction')
+    fdv = CArray(dtype=np.float64, shape=(3,), value=np.array((1.0, 0, 0)))
 
     #: A unique identifier based on the environment properties. (read-only)
     digest = Property(
@@ -344,24 +344,24 @@ class SlotJet(FlowField):
     """
 
     #: Exit velocity at the :attr:`slot jet origin<origin>` (nozzle). Default is ``0.0``.
-    v0 = Float(0.0, desc='exit velocity')
+    v0 = Float(0.0)
 
     #: The location of the slot nozzle center. Default is ``(0.0, 0.0, 0.0)``.
-    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)), desc='center of nozzle')
+    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)))
 
     #: Unit vector representing the flow direction. Default is ``(1.0, 0.0, 0.0)``.
-    flow = CArray(dtype=np.float64, shape=(3,), value=np.array((1.0, 0.0, 0.0)), desc='flow direction')
+    flow = CArray(dtype=np.float64, shape=(3,), value=np.array((1.0, 0.0, 0.0)))
 
     #: Unit vector parallel to the slot center plane, used to define the slot orientation.
     #: Default is ``(0.0, 1.0, 0.0)``.
-    plane = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 1.0, 0.0)), desc='slot center line direction')
+    plane = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 1.0, 0.0)))
 
     #: Width of the slot (slot diameter). Default is ``0.2``.
-    B = Float(0.2, desc='nozzle diameter')
+    B = Float(0.2)
 
     #: Non-dimensional length of the zone of flow establishment (jet core length).
     #: Default is ``5.2``.
-    l = Float(5.2, desc='flow establishment length')  # noqa: E741
+    l = Float(5.2)  # noqa: E741
 
     #: A unique identifier based on the field properties. (read-only)
     digest = Property(
@@ -465,17 +465,17 @@ class OpenJet(FlowField):
     """
 
     #: Exit velocity at the jet origin (nozzle). Default is ``0.0``.
-    v0 = Float(0.0, desc='exit velocity')
+    v0 = Float(0.0)
 
     #: The location of the nozzle center. Default is ``(0.0, 0.0, 0.0)``.
-    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)), desc='center of nozzle')
+    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)))
 
     #: Diameter of the nozzle. Default is ``0.2``.
-    D = Float(0.2, desc='nozzle diameter')
+    D = Float(0.2)
 
     #: Non-dimensional length of the zone of flow establishment (jet core length).
     #: Default is ``6.2``. :cite:`Albertson1950`
-    l = Float(6.2, desc='flow establishment length')  # noqa: E741
+    l = Float(6.2)  # noqa: E741
 
     #: A unique identifier based on the field properties. (read-only)
     digest = Property(
@@ -575,11 +575,11 @@ class RotatingFlow(FlowField):
            [ 0.        ,  0.        ,  0.        ]])
     """
 
-    # Revolutions per minute (RPM). Default is ``0.0``.
-    # Positive values indicate clockwise rotation of the flow.
-    # This is contrary to the usual definition of the direction of rotation.
-    # Deprecated! Please use the differently defined :attr:`rps` attribute instead.
-    rpm = Property(transient=True, desc='revolutions per minute of the flow; positive values for clockwise rotation')
+    #: Revolutions per minute (RPM). Default is ``0.0``.
+    #: Positive values indicate clockwise rotation of the flow.
+    #: This is contrary to the usual definition of the direction of rotation.
+    #: Deprecated! Please use the differently defined :attr:`rps` attribute instead.
+    rpm = Property(transient=True)
 
     def _get_rpm(self):
         warn(
@@ -601,14 +601,14 @@ class RotatingFlow(FlowField):
 
     #: Rotational speed in revolutions per second. Negative values indicate clockwise
     #: rigid-body-like rotation of the flow. Default is ``0.0``.
-    rps = Float(0.0, desc='rotational speed of the flow in Hz')
+    rps = Float(0.0)
 
     #: Constant flow velocity in the z-direction. Default is ``0.0``.
-    v0 = Float(0.0, desc='flow velocity')
+    v0 = Float(0.0)
 
     #: The location of the center of rotation.
     #: Default is ``(0.0, 0.0, 0.0)``.
-    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)), desc='center of rotation')
+    origin = CArray(dtype=np.float64, shape=(3,), value=np.array((0.0, 0.0, 0.0)))
 
     #: A unique identifier based on the field properties. (read-only)
     digest = Property(
@@ -798,14 +798,14 @@ class GeneralFlowEnvironment(Environment):
 
     #: The flow field object describing the velocity field,
     #: which must be an instance of :class:`~acoular.environments.FlowField`.
-    ff = Instance(FlowField, desc='flow field')
+    ff = Instance(FlowField)
 
     #: The number of rays used per solid angle :math:`\Omega`. Defaults to ``200``.
-    N = Int(200, desc='number of rays per Om')
+    N = Int(200)
 
     #: The maximum solid angle (in steradians) used in the ray-tracing algorithm.
     #: Default is :obj:`numpy.pi`.
-    Om = Float(np.pi, desc='maximum solid angle')
+    Om = Float(np.pi)
 
     #: A unique identifier based on the environment properties. (read-only)
     digest = Property(