acoular 23.11__py3-none-any.whl → 24.5__py3-none-any.whl

acoular/__init__.py

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

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]
-

acoular/configuration.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-#pylint: disable-msg=E0611, E1101, C0103, R0901, R0902, R0903, R0904, W0232
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 # Copyright (c) Acoular Development Team.
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 """Implements global configuration of Acoular.
 
 .. autosummary::
@@ -12,9 +10,10 @@
     config
 """
 
-from os import path, mkdir, environ
+import importlib.util
+import sys
+from os import environ, mkdir, path
 from warnings import warn
-import sys 
 
 # When numpy is using OpenBLAS then it runs with OPENBLAS_NUM_THREADS which may lead to
 # overcommittment when called from within numba jitted function that run on
@@ -23,56 +22,64 @@ import sys
 # only respected once numpy starts. Later on, it cannot be changed.
 
 # we check if numpy already loaded
-if 'numpy' in sys.modules: 
-    # numpy is loaded 
+if 'numpy' in sys.modules:
+    # numpy is loaded
     # temporarily route stdout to string
     import io
-    import numpy 
+
+    import numpy as np
+
     orig_stdout = sys.stdout
     temp_stdout = io.StringIO()
     sys.stdout = temp_stdout
-    numpy.show_config()
+    np.show_config()
     sys.stdout = orig_stdout
     # check if it uses OpenBLAS or another library
     if 'openblas' in temp_stdout.getvalue().lower():
         # it's OpenBLAS, set numba threads=1 to avoid overcommittment
         import numba
+
         numba.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 "
-             "execution for now and processing might be slower. To speed up, "
-             "either import Numpy after Acoular or set environment variable "
-             "OPENBLAS_NUM_THREADS=1 before start of the program.",
-             UserWarning, stacklevel = 2)
+        warn(
+            'We detected that Numpy is already loaded and uses OpenBLAS. Because '
+            'this conflicts with Numba parallel execution, we disable parallel '
+            'execution for now and processing might be slower. To speed up, '
+            'either import Numpy after Acoular or set environment variable '
+            'OPENBLAS_NUM_THREADS=1 before start of the program.',
+            UserWarning,
+            stacklevel=2,
+        )
 else:
     # numpy is not loaded
-    environ['OPENBLAS_NUM_THREADS'] = "1"
+    environ['OPENBLAS_NUM_THREADS'] = '1'
 
 # this loads numpy, so we have to defer loading until OpenBLAS check is done
-from traits.api import Trait, Bool, Str, Property, HasStrictTraits
+from traits.api import Bool, Either, HasStrictTraits, Property, Str, Trait, cached_property
+
 
 class Config(HasStrictTraits):
-    """
-    This class implements the global configuration of the Acoular package.
+    """Implements the global configuration of the Acoular package.
 
-    An instance of this class can be accessed for adjustment of the following 
+    An instance of this class can be accessed for adjustment of the following
     properties.
     General caching behaviour can be controlled by :attr:`global_caching`.
-    The package used to read and write .h5 files can be specified 
-    by :attr:`h5library`.    
+    The package used to read and write .h5 files can be specified
+    by :attr:`h5library`.
 
-    Example: 
+    Example:
+    --------
         For using Acoular with h5py package and overwrite existing cache:
-        
+
         >>>    import acoular
         >>>    acoular.config.h5library = "h5py"
         >>>    acoular.config.global_caching = "overwrite"
+
     """
-    
+
     def __init__(self):
         HasStrictTraits.__init__(self)
         self._assert_h5library()
-    
+
     #: Flag that globally defines caching behaviour of Acoular classes
     #: defaults to 'individual'.
     #:
@@ -82,25 +89,26 @@ class Config(HasStrictTraits):
     #: * 'readonly': Acoular classes do not actively cache, but read from cache if existing.
     #: * 'overwrite': Acoular classes replace existing cachefile content with new data.
     global_caching = Property()
-    
-    _global_caching = Trait('individual','all','none','readonly','overwrite') 
 
-    #: Flag that globally defines package used to read and write .h5 files 
-    #: defaults to 'pytables'. If 'pytables' can not be imported, 'h5py' is used
+    _global_caching = Trait('individual', 'all', 'none', 'readonly', 'overwrite')
+
+    #: Flag that globally defines package used to read and write .h5 files
+    #: defaults to 'pytables'. It is also possible to set it to 'tables', which is an alias for 'pytables'.
+    #: If 'pytables' can not be imported, 'h5py' is used.
     h5library = Property()
-    
-    _h5library = Trait('pytables','h5py')
-    
+
+    _h5library = Either('pytables', 'tables', 'h5py', default='pytables')
+
     #: Defines the path to the directory containing Acoulars cache files.
     #: If the specified :attr:`cache_dir` directory does not exist,
-    #: it will be created. attr:`cache_dir` defaults to current session path.  
+    #: it will be created. :attr:`cache_dir` defaults to current session path.
     cache_dir = Property()
 
-    _cache_dir = Str("")
+    _cache_dir = Str('')
 
-    #: Defines the working directory containing files that can be loaded by the
-    #: fileimport.py module. 
-    #: Defaults to current session path.  
+    #: Defines the working directory containing data files. Used only by
+    #: :class:`~acoular.tprocess.WriteH5` class.
+    #: Defaults to current session path.
     td_dir = Property()
 
     _td_dir = Str(path.curdir)
@@ -108,61 +116,96 @@ class Config(HasStrictTraits):
     #: Boolean Flag that determines whether user has access to traitsui features.
     #: Defaults to False.
     use_traitsui = Property()
-    
+
     _use_traitsui = Bool(False)
-    
-    
+
+    #: Boolean Flag that determines whether tables is installed.
+    have_tables = Property()
+
+    #: Boolean Flag that determines whether h5py is installed.
+    have_h5py = Property()
+
+    #: Boolean Flag that determines whether matplotlib is installed.
+    have_matplotlib = Property()
+
+    #: Boolean Flag that determines whether pylops is installed.
+    have_pylops = Property()
+
+    #: Boolean Flag that determines whether sounddevice is installed.
+    have_sounddevice = Property()
+
     def _get_global_caching(self):
         return self._global_caching
 
-    def _set_global_caching(self,globalCachingValue):
+    def _set_global_caching(self, globalCachingValue):
         self._global_caching = globalCachingValue
-        
+
     def _get_h5library(self):
         return self._h5library
-    
-    def _set_h5library(self,libraryName):
-        self._h5library = libraryName 
-    
+
+    def _set_h5library(self, libraryName):
+        self._h5library = libraryName
+
     def _get_use_traitsui(self):
         return self._use_traitsui
-    
+
     def _set_use_traitsui(self, use_tui):
         if use_tui:
-            from  . import traitsviews
+            from . import traitsviews
             # If user tries to use traitsuis and it's not installed, this will throw an error.
-        self._use_traitsui = use_tui 
-    
+        self._use_traitsui = use_tui
+
     def _assert_h5library(self):
-        try:
-            import tables  
-            self.h5library = 'pytables'
-        except:
-            try:
-                import h5py
-                self.h5library = 'h5py'
-            except:
-                raise ImportError("packages h5py and pytables are missing!")
+        if not self.have_tables and not self.have_h5py:
+            msg = 'Packages H5py and PyTables are missing! At least one of them is required for Acoular to work.'
+            raise ImportError(msg)
+        if not self.have_tables:
+            self.h5library = 'h5py'
 
     def _get_cache_dir(self):
-        if self._cache_dir == "":
-            cache_dir = path.join(path.curdir,'cache')
+        if self._cache_dir == '':
+            cache_dir = path.join(path.curdir, 'cache')
             if not path.exists(cache_dir):
                 mkdir(cache_dir)
             self._cache_dir = cache_dir
         return self._cache_dir
-    
-    def _set_cache_dir(self,cdir):
+
+    def _set_cache_dir(self, cdir):
         if not path.exists(cdir):
             mkdir(cdir)
         self._cache_dir = cdir
 
     def _get_td_dir(self):
         return self._td_dir
-    
-    def _set_td_dir(self,tddir):
+
+    def _set_td_dir(self, tddir):
         self._td_dir = tddir
 
+    def _have_module(self, module_name):
+        spec = importlib.util.find_spec(module_name)
+        return spec is not None
+
+    @cached_property
+    def _get_have_matplotlib(self):
+        return self._have_module('matplotlib')
+
+    @cached_property
+    def _get_have_pylops(self):
+        return self._have_module('pylops')
+
+    @cached_property
+    def _get_have_sounddevice(self):
+        return self._have_module('sounddevice')
+
+    @cached_property
+    def _get_have_tables(self):
+        return self._have_module('tables')
+
+    @cached_property
+    def _get_have_h5py(self):
+        return self._have_module('h5py')
+
+
 config = Config()
 """
 This instance implements the global configuration of the Acoular package.
@@ -174,10 +217,10 @@ General caching behaviour can be controlled by the :attr:`global_caching` attrib
 * 'readonly': Acoular classes do not actively cache, but read from cache if existing.
 * 'overwrite': Acoular classes replace existing cachefile content with new data.
 
-The package used to read and write .h5 files can be specified 
-by :attr:`h5library`:  
-* 'pytables': Use 'tables' (or 'pytables', depending on python distribution).
-* 'h5py': Use 'h5py'.
+The package used to read and write .h5 files can be specified
+by :attr:`h5library`:
+* 'PyTables': Use 'tables' (or 'pytables', depending on python distribution).
+* 'H5py': Use 'h5py'.
 
 Some Acoular classes support GUI elements for usage with tools from the TraitsUI package.
 If desired, this package has to be installed manually, as it is not a prerequisite for
@@ -186,9 +229,9 @@ To enable the functionality, the flag attribute :attr:`use_traitsui` has to be s
 Note: this is independent from the GUI tools implemented in the spectAcoular package.
 
 
-Example: 
+Example:
     For using Acoular with h5py package and overwrite existing cache:
-    
+
     >>>    import acoular
     >>>    acoular.config.h5library = "h5py"
     >>>    acoular.config.global_caching = "overwrite"

acoular/demo/__init__.py

@@ -1,7 +1,13 @@
-# coding=UTF-8
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 # Copyright (c) Acoular Development Team.
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+"""The Acoular demo.
 
+.. autosummary::
+    :toctree: generated/
 
-from . import acoular_demo
+    acoular_demo
+
+"""
+
+from . import acoular_demo