acoular 24.7__py3-none-any.whl → 24.10__py3-none-any.whl

acoular/spectra.py

@@ -7,7 +7,6 @@
     :toctree: generated/
 
     BaseSpectra
-    FFTSpectra
     PowerSpectra
     synthetic
     PowerSpectraImport
@@ -33,7 +32,6 @@ from numpy import (
     ones,
     real,
     searchsorted,
-    sqrt,
     sum,
     zeros,
     zeros_like,
@@ -54,13 +52,13 @@ from traits.api import (
     property_depends_on,
 )
 
+from .base import SamplesGenerator
 from .calib import Calib
 from .configuration import config
 from .fastFuncs import calcCSM
 from .h5cache import H5cache
 from .h5files import H5CacheFileBase
 from .internal import digest
-from .tprocess import SamplesGenerator, TimeInOut
 
 
 class BaseSpectra(HasPrivateTraits):
@@ -105,8 +103,8 @@ class BaseSpectra(HasPrivateTraits):
         desc='number of samples per FFT block',
     )
 
-    #: The floating-number-precision of entries of csm, eigenvalues and
-    #: eigenvectors, corresponding to numpy dtypes. Default is 64 bit.
+    #: The floating-number-precision of the resulting spectra, corresponding to numpy dtypes.
+    #: Default is 'complex128'.
     precision = Trait('complex128', 'complex64', desc='precision of the fft')
 
     # internal identifier
@@ -130,7 +128,7 @@ class BaseSpectra(HasPrivateTraits):
         return None
 
     # generator that yields the time data blocks for every channel (with optional overlap)
-    def get_source_data(self):
+    def _get_source_data(self):
         bs = self.block_size
         temp = empty((2 * bs, self.numchannels))
         pos = bs
@@ -146,48 +144,12 @@ class BaseSpectra(HasPrivateTraits):
                 pos -= bs
 
 
-class FFTSpectra(BaseSpectra, TimeInOut):
-    """Provides the spectra of multichannel time data.
-
-    Returns Spectra per block over a Generator.
-    """
-
-    # internal identifier
-    digest = Property(depends_on=['source.digest', 'precision', 'block_size', 'window', 'overlap'])
-
-    @cached_property
-    def _get_digest(self):
-        return digest(self)
-
-    # generator that yields the fft for every channel
-    def result(self):
-        """Python generator that yields the output block-wise.
-
-        Parameters
-        ----------
-        num : integer
-            This parameter defines the size of the blocks to be yielded
-            (i.e. the number of samples per block).
-
-        Returns
-        -------
-        Samples in blocks of shape (numfreq, :attr:`numchannels`).
-            The last block may be shorter than num.
-
-        """
-        wind = self.window_(self.block_size)
-        weight = sqrt(2) / self.block_size * sqrt(self.block_size / dot(wind, wind)) * wind[:, newaxis]
-        for data in self.get_source_data():
-            ft = fft.rfft(data * weight, None, 0).astype(self.precision)
-            yield ft
-
-
 class PowerSpectra(BaseSpectra):
     """Provides the cross spectral matrix of multichannel time data
      and its eigen-decomposition.
 
     This class includes the efficient calculation of the full cross spectral
-    matrix using the Welch method with windows and overlap. It also contains
+    matrix using the Welch method with windows and overlap (:cite:`Welch1967`). It also contains
     the CSM's eigenvalues and eigenvectors and additional properties.
 
     The result is computed only when needed, that is when the :attr:`csm`,
@@ -206,7 +168,7 @@ class PowerSpectra(BaseSpectra):
     #: Data source; :class:`~acoular.sources.SamplesGenerator` or derived object.
     source = Property(_source, desc='time data object')
 
-    #: The :class:`~acoular.tprocess.SamplesGenerator` object that provides the data.
+    #: The :class:`~acoular.base.SamplesGenerator` object that provides the data.
     time_data = Property(
         _source,
         desc='deprecated attribute holding the time data object. Use PowerSpectra.source instead!',
@@ -215,9 +177,11 @@ class PowerSpectra(BaseSpectra):
     #: The :class:`~acoular.calib.Calib` object that provides the calibration data,
     #: defaults to no calibration, i.e. the raw time data is used.
     #:
-    #: **deprecated**:      use :attr:`~acoular.sources.TimeSamples.calib` property of
+    #: **deprecated, will be removed in version 25.01**: use :attr:`~acoular.sources.TimeSamples.calib` property of
     #: :class:`~acoular.sources.TimeSamples` objects
-    calib = Instance(Calib)
+    calib = Property(desc='calibration object (deprecated, will be removed in version 25.01)')
+
+    _calib = Instance(Calib)
 
     # Shadow trait, should not be set directly, for internal use.
     _ind_low = Int(1, desc='index of lowest frequency line')
@@ -292,6 +256,18 @@ class PowerSpectra(BaseSpectra):
     # hdf5 cache file
     h5f = Instance(H5CacheFileBase, transient=True)
 
+    def _get_calib(self):
+        return self._calib
+
+    def _set_calib(self, calib):
+        msg = (
+            "Using 'calib' attribute is deprecated and will be removed in version 25.01. "
+            'use :attr:`~acoular.sources.TimeSamples.calib` property of '
+            ':class:`~acoular.sources.TimeSamples` object instead.'
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
+        self._calib = calib
+
     @property_depends_on('_source.numsamples, block_size, overlap')
     def _get_num_blocks(self):
         return self.overlap_ * self._source.numsamples / self.block_size - self.overlap_ + 1
@@ -341,6 +317,11 @@ class PowerSpectra(BaseSpectra):
         self._ind_low = ind_low
 
     def _set_time_data(self, time_data):
+        msg = (
+            "Using 'time_data' attribute is deprecated and will be removed in version 25.01. "
+            "Use 'source' attribute instead."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._source = time_data
 
     def _set_source(self, source):
@@ -392,7 +373,7 @@ class PowerSpectra(BaseSpectra):
             else:
                 raise ValueError('Calibration data not compatible: %i, %i' % (self.calib.num_mics, t.numchannels))
         # get time data blockwise
-        for data in self.get_source_data():
+        for data in self._get_source_data():
             ft = fft.rfft(data * wind, None, 0).astype(self.precision)
             calcCSM(csm_upper, ft)  # only upper triangular part of matrix is calculated (for speed reasons)
         # create the full csm matrix via transposing and complex conj.
@@ -594,7 +575,7 @@ def synthetic(data, freqs, f, num=3):
         each grid point (the sum of all values that are contained in the band).
         Note that the frequency resolution and therefore the bandwidth
         represented by a single frequency line depends on
-        the :attr:`sampling frequency<acoular.tprocess.SamplesGenerator.sample_freq>`
+        the :attr:`sampling frequency<acoular.base.SamplesGenerator.sample_freq>`
         and used :attr:`FFT block size<acoular.spectra.PowerSpectra.block_size>`.
 
     """