acoular 25.3__tar.gz → 25.4__tar.gz

{acoular-25.3 → acoular-25.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: acoular
-Version: 25.3
+Version: 25.4
 Summary: Python library for acoustic beamforming
 Project-URL: homepage, https://acoular.org
 Project-URL: documentation, https://acoular.org

{acoular-25.3 → acoular-25.4}/acoular/aiaa/aiaa.py

@@ -32,6 +32,7 @@ from traits.api import (
     File,
     Instance,
     Property,
+    Union,
     cached_property,
     on_trait_change,
     property_depends_on,
@@ -89,7 +90,7 @@ class CsmAIAABenchmark(PowerSpectraImport):
     """Class to load the CSM that is stored in AIAA Benchmark HDF5 file."""
 
     #: Full name of the .h5 file with data
-    file = File(filter=['*.h5'], exists=True, desc='name of data file')
+    file = Union(None, File(filter=['*.h5'], exists=True), desc='name of data file')
 
     #: Basename of the .h5 file with data, is set automatically.
     basename = Property(
@@ -167,10 +168,12 @@ class MicAIAABenchmark(MicGeom):
     """
 
     #: 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')
+    file = Union(
+        None, File(filter=['*.h5'], exists=True), desc='name of the h5 file containing the microphone geometry'
+    )
 
     @on_trait_change('file')
-    def import_mpos(self):
+    def _import_mpos(self):
         """Import the microphone positions from .h5 file.
         Called when :attr:`basename` changes.
         """

{acoular-25.3 → acoular-25.4}/acoular/calib.py

@@ -13,7 +13,7 @@
 import xml.dom.minidom
 
 from numpy import array, newaxis
-from traits.api import CArray, CInt, File, List, Property, cached_property, on_trait_change
+from traits.api import CArray, CInt, File, List, Property, Union, cached_property, on_trait_change
 
 import acoular as ac
 
@@ -78,7 +78,7 @@ class Calib(InOut):
     """
 
     #: Name of the .xml file to be imported.
-    file = File(filter=['*.xml'], exists=True, desc='name of the xml file to import')
+    file = Union(None, File(filter=['*.xml'], exists=True), desc='name of the xml file to import')
 
     #: Number of microphones in the calibration data,
     #: is set automatically when read from file or when data is set.

{acoular-25.3 → acoular-25.4}/acoular/deprecation.py

@@ -66,7 +66,10 @@ def deprecated_alias(old2new, read_only=False, removal_version=''):
             else:
                 current_removal_version = ''
             # Define Trait Property type
-            trait_type = Property(*_alias_accessor_factory(old, new, current_read_only, current_removal_version))
+            trait_type = Property(
+                *_alias_accessor_factory(old, new, current_read_only, current_removal_version),
+                transient=True,
+            )
 
             # If the new trait exists, set or update alias
             if new in cls.class_traits():

{acoular-25.3 → acoular-25.4}/acoular/environments.py

@@ -591,7 +591,7 @@ class RotatingFlow(FlowField):
     # 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(desc='revolutions per minute of the flow; positive values for clockwise rotation')
+    rpm = Property(transient=True, desc='revolutions per minute of the flow; positive values for clockwise rotation')
 
     def _get_rpm(self):
         warn(

{acoular-25.3 → acoular-25.4}/acoular/fbeamform.py

@@ -170,6 +170,7 @@ class SteeringVector(HasStrictTraits):
             'true level': lambda x: x / einsum('ij,ij->i', x, x.conj())[:, newaxis],
             'true location': lambda x: x / sqrt(einsum('ij,ij->i', x, x.conj()) * x.shape[-1])[:, newaxis],
         },
+        transient=True,
         desc='dictionary of frequency domain steering vector functions',
     )
 
@@ -180,6 +181,7 @@ class SteeringVector(HasStrictTraits):
             'true level': _steer_III,
             'true location': _steer_IV,
         },
+        transient=True,
         desc='dictionary of time domain steering vector functions',
     )
 
@@ -1149,7 +1151,7 @@ class BeamformerDamas(BeamformerBase):
     #: (only for backward compatibility) :class:`BeamformerBase` object
     #: if set, provides :attr:`freq_data`, :attr:`steer`, :attr:`r_diag`
     #: if not set, these have to be set explicitly.
-    beamformer = Property()
+    beamformer = Property(transient=True)
 
     # private storage of beamformer instance
     _beamformer = Instance(BeamformerBase)
@@ -1366,7 +1368,7 @@ class BeamformerOrth(BeamformerBase):
     #: (only for backward compatibility) :class:`BeamformerEig` object
     #: if set, provides :attr:`freq_data`, :attr:`steer`, :attr:`r_diag`
     #: if not set, these have to be set explicitly.
-    beamformer = Property()
+    beamformer = Property(transient=True)
 
     # private storage of beamformer instance
     _beamformer = Instance(BeamformerEig)
@@ -1555,7 +1557,7 @@ class BeamformerClean(BeamformerBase):
     #: (only for backward compatibility) :class:`BeamformerBase` object
     #: if set, provides :attr:`freq_data`, :attr:`steer`, :attr:`r_diag`
     #: if not set, these have to be set explicitly.
-    beamformer = Property()
+    beamformer = Property(transient=True)
 
     # private storage of beamformer instance
     _beamformer = Instance(BeamformerBase)

{acoular-25.3 → acoular-25.4}/acoular/grids.py

@@ -770,7 +770,7 @@ class ImportGrid(Grid):
     """
 
     #: Name of the .xml-file from which to read the data.
-    file = File(filter=['*.xml'], exists=True, desc='name of the xml file to import')
+    file = Union(None, File(filter=['*.xml'], exists=True), desc='name of the xml file to import')
 
     _gpos = CArray(dtype=float, desc='x, y, z position of all Grid Points')
 

{acoular-25.3 → acoular-25.4}/acoular/microphones.py

@@ -22,6 +22,7 @@ from traits.api import (
     HasStrictTraits,
     List,
     Property,
+    Union,
     cached_property,
     on_trait_change,
 )
@@ -128,7 +129,7 @@ class MicGeom(HasStrictTraits):
 
     #: Path to the XML file containing microphone positions. The XML file should have elements with
     #: the tag ``pos`` and attributes ``Name``, ``x``, ``y``, and ``z``.
-    file = File(filter=['*.xml'], exists=True, desc='name of the xml file to import')
+    file = Union(None, File(filter=['*.xml'], exists=True), desc='name of the xml file to import')
 
     #: Array containing the ``x, y, z`` positions of all microphones, including invalid ones, shape
     #: ``(3,`` :attr:`num_mics` ``)``. This is set automatically when :attr:`file` changes or

{acoular-25.3 → acoular-25.4}/acoular/sources.py

@@ -369,7 +369,7 @@ class TimeSamples(SamplesGenerator):
     """
 
     #: Full path to the ``.h5`` file containing time-domain data.
-    file = File(filter=['*.h5'], exists=True, desc='name of data file')
+    file = Union(None, File(filter=['*.h5'], exists=True), desc='name of data file')
 
     #: Basename of the ``.h5`` file, set automatically from the :attr:`file` attribute.
     basename = Property(depends_on=['file'], desc='basename of data file')

{acoular-25.3 → acoular-25.4}/acoular/spectra.py

@@ -12,7 +12,6 @@
 """
 
 from abc import abstractmethod
-from warnings import warn
 
 from numpy import (
     arange,
@@ -298,9 +297,10 @@ class PowerSpectra(BaseSpectra):
         return None
 
     def _set_freq_range(self, freq_range):  # by setting this the user sets _freqlc and _freqhc
-        self._index_set_last = False
-        self._freqlc = freq_range[0]
-        self._freqhc = freq_range[1]
+        if freq_range is not None:
+            self._index_set_last = False
+            self._freqlc = freq_range[0]
+            self._freqhc = freq_range[1]
 
     @property_depends_on(['source.sample_freq', 'block_size', '_ind_low', '_freqlc'])
     def _get_ind_low(self):
@@ -309,7 +309,7 @@ class PowerSpectra(BaseSpectra):
             if self._index_set_last:
                 return min(self._ind_low, fftfreq.shape[0] - 1)
             return searchsorted(fftfreq[:-1], self._freqlc)
-        return None
+        return 0
 
     @property_depends_on(['source.sample_freq', 'block_size', '_ind_high', '_freqhc'])
     def _get_ind_high(self):
@@ -631,7 +631,7 @@ class PowerSpectraImport(PowerSpectra):
 
     #: The frequencies included in the CSM in ascending order. Accepts list, array, or a single
     #: float value.
-    frequencies = Union(CArray, Float, desc='frequencies included in the cross-spectral matrix')
+    frequencies = Union(None, CArray, Float, desc='frequencies included in the cross-spectral matrix')
 
     #: Number of time data channels, inferred from the shape of the CSM.
     num_channels = Property(depends_on=['digest'])
@@ -670,7 +670,7 @@ class PowerSpectraImport(PowerSpectra):
     basename = Property(depends_on=['digest'], desc='basename for cache file')
 
     # Shadow trait for storing the CSM, for internal use only.
-    _csm = CArray()
+    _csm = Union(None, CArray(shape=(None, None, None)), desc='cross spectral matrix')
 
     # Checksum for the CSM to trigger digest calculation, for internal use only.
     _csmsum = Float()
@@ -689,12 +689,13 @@ class PowerSpectraImport(PowerSpectra):
         return self._csm
 
     def _set_csm(self, csm):
-        if (len(csm.shape) != 3) or (csm.shape[1] != csm.shape[2]):
-            msg = 'The cross spectral matrix must have the following shape: \
-            (number of frequencies, num_channels, num_channels)!'
-            raise ValueError(msg)
-        self._csmsum = real(self._csm).sum() + (imag(self._csm) ** 2).sum()  # to trigger new digest creation
-        self._csm = csm
+        if csm is not None:
+            if csm.shape[1] != csm.shape[2]:
+                msg = 'The cross spectral matrix must have the following shape: \
+                (number of frequencies, num_channels, num_channels)!'
+                raise ValueError(msg)
+            self._csm = csm
+            self._csmsum = real(self._csm).sum() + (imag(self._csm) ** 2).sum()  # to trigger new digest creation
 
     @property_depends_on(['digest'])
     def _get_eva(self):
@@ -720,6 +721,4 @@ class PowerSpectraImport(PowerSpectra):
             return array([self.frequencies])
         if isinstance(self.frequencies, ndarray):
             return self.frequencies
-        if self.frequencies is None:
-            warn('No frequencies defined for PowerSpectraImport object!', stacklevel=1)
         return self.frequencies

{acoular-25.3 → acoular-25.4}/acoular/tools/utils.py

@@ -26,8 +26,7 @@ def get_file_basename(file, alternative_basename='void'):
     str
         Basename of the file.
     """
-    basename = Path(file).stem
-    return basename if basename else alternative_basename
+    return Path(file).stem if file else alternative_basename
 
 
 def find_basename(source, alternative_basename='void'):

{acoular-25.3 → acoular-25.4}/acoular/tprocess.py

@@ -333,7 +333,7 @@ class Trigger(TimeOut):  # pragma: no cover
     # mean value of the trigger signal. E.g: the mean value is 0 and there are positive
     # extremums at 400 and negative extremums at -800. Then the estimated threshold would be
     # 0.75 * -800 = -600.
-    threshold = Float(None)
+    threshold = Union(None, Float)
 
     # Maximum allowable variation of length of each revolution duration. Default is
     # 2%. A warning is thrown, if any revolution length surpasses this value:

{acoular-25.3 → acoular-25.4}/acoular/version.py

@@ -4,5 +4,5 @@
 
 # separate file to find out about version without importing the acoular lib
 __author__ = 'Acoular Development Team'
-__date__ = '12 March 2025'
-__version__ = '25.03'
+__date__ = '29 April 2025'
+__version__ = '25.04'