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

acoular/fbeamform.py

@@ -60,7 +60,6 @@ from numpy import (
     integer,
     invert,
     isscalar,
-    linalg,
     log10,
     ndarray,
     newaxis,
@@ -82,9 +81,8 @@ from numpy import (
     zeros,
     zeros_like,
 )
-from numpy.linalg import norm
 from packaging.version import parse
-from scipy.linalg import eigh, eigvals, fractional_matrix_power, inv
+from scipy.linalg import eigh, eigvals, fractional_matrix_power, inv, norm
 from scipy.optimize import fmin_l_bfgs_b, linprog, nnls, shgo
 from sklearn.linear_model import LassoLars, LassoLarsCV, LassoLarsIC, LinearRegression, OrthogonalMatchingPursuitCV
 from traits.api import (
@@ -117,6 +115,7 @@ from .h5files import H5CacheFileBase
 from .internal import digest
 from .microphones import MicGeom
 from .spectra import PowerSpectra
+from .tfastfuncs import _steer_I, _steer_II, _steer_III, _steer_IV
 
 sklearn_ndict = {}
 if parse(sklearn.__version__) < parse('1.4'):
@@ -126,7 +125,10 @@ BEAMFORMER_BASE_DIGEST_DEPENDENCIES = ['freq_data.digest', 'r_diag', 'r_diag_nor
 
 
 class SteeringVector(HasPrivateTraits):
-    """Basic class for implementing steering vectors with monopole source transfer models."""
+    """Basic class for implementing steering vectors with monopole source transfer models.
+
+    Handles four different steering vector formulations. See :cite:`Sarradj2012` for details.
+    """
 
     #: :class:`~acoular.grids.Grid`-derived object that provides the grid locations.
     grid = Trait(Grid, desc='beamforming grid')
@@ -134,7 +136,7 @@ class SteeringVector(HasPrivateTraits):
     #: :class:`~acoular.microphones.MicGeom` object that provides the microphone locations.
     mics = Trait(MicGeom, desc='microphone geometry')
 
-    #: Type of steering vectors, see also :ref:`Sarradj, 2012<Sarradj2012>`. Defaults to 'true level'.
+    #: Type of steering vectors, see also :cite:`Sarradj2012`. Defaults to 'true level'.
     steer_type = Trait('true level', 'true location', 'classic', 'inverse', desc='type of steering vectors used')
 
     #: :class:`~acoular.environments.Environment` or derived object,
@@ -160,6 +162,26 @@ class SteeringVector(HasPrivateTraits):
     #: Defaults to [0.,0.,0.].
     ref = Property(desc='reference position or distance')
 
+    _steer_funcs_freq = Dict(
+        {
+            'classic': lambda x: x / absolute(x) / x.shape[-1],
+            'inverse': lambda x: 1.0 / x.conj() / x.shape[-1],
+            '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],
+        },
+        desc='dictionary of frequency domain steering vector functions',
+    )
+
+    _steer_funcs_time = Dict(
+        {
+            'classic': _steer_I,
+            'inverse': _steer_II,
+            'true level': _steer_III,
+            'true location': _steer_IV,
+        },
+        desc='dictionary of time domain steering vector functions',
+    )
+
     def _set_ref(self, ref):
         if isscalar(ref):
             try:
@@ -186,11 +208,11 @@ class SteeringVector(HasPrivateTraits):
             if self.ref > 0:
                 return full((self.grid.size,), self.ref)
             return self.env._r(self.grid.pos())
-        return self.env._r(self.grid.pos(), self.ref[:, newaxis])
+        return self.env._r(self.grid.gpos, self.ref[:, newaxis])
 
     @property_depends_on('grid.digest, mics.digest, env.digest')
     def _get_rm(self):
-        return atleast_2d(self.env._r(self.grid.pos(), self.mics.mpos))
+        return atleast_2d(self.env._r(self.grid.gpos, self.mics.mpos))
 
     @cached_property
     def _get_digest(self):
@@ -231,8 +253,9 @@ class SteeringVector(HasPrivateTraits):
         return trans
 
     def steer_vector(self, f, ind=None):
-        """Calculates the steering vectors based on the transfer function
-        See also :ref:`Sarradj, 2012<Sarradj2012>`.
+        """Calculates the steering vectors based on the transfer function.
+
+        See also :cite:`Sarradj2012`.
 
         Parameters
         ----------
@@ -249,12 +272,7 @@ class SteeringVector(HasPrivateTraits):
             array of shape (ngridpts, nmics) containing the steering vectors for the given frequency
 
         """
-        func = {
-            'classic': lambda x: x / absolute(x) / x.shape[-1],
-            'inverse': lambda x: 1.0 / x.conj() / x.shape[-1],
-            '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],
-        }[self.steer_type]
+        func = self._steer_funcs_freq[self.steer_type]
         return func(self.transfer(f, ind))
 
 
@@ -305,10 +323,15 @@ class BeamformerBase(HasPrivateTraits):
         if isinstance(steer, SteeringVector):
             self._steer_obj = steer
         elif steer in ('true level', 'true location', 'classic', 'inverse'):
-            # Type of steering vectors, see also :ref:`Sarradj, 2012<Sarradj2012>`.
+            # Type of steering vectors, see also :cite:`Sarradj2012`.
+            msg = (
+                "Deprecated use of 'steer' trait. Please use the 'steer' with an object of class "
+                "'SteeringVector'. Using a string to specify the steer type will be removed in "
+                'version 25.01.'
+            )
             warn(
-                "Deprecated use of 'steer' trait. Please use object of class 'SteeringVector' in the future.",
-                Warning,
+                msg,
+                DeprecationWarning,
                 stacklevel=2,
             )
             self._steer_obj.steer_type = steer
@@ -326,7 +349,11 @@ class BeamformerBase(HasPrivateTraits):
         return self._steer_obj.env
 
     def _set_env(self, env):
-        warn("Deprecated use of 'env' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'env' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'env' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.env = env
 
     # The speed of sound.
@@ -338,7 +365,12 @@ class BeamformerBase(HasPrivateTraits):
         return self._steer_obj.env.c
 
     def _set_c(self, c):
-        warn("Deprecated use of 'c' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'c' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector' that holds an 'Environment' instance."
+            "The 'c' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.env.c = c
 
     # :class:`~acoular.grids.Grid`-derived object that provides the grid locations.
@@ -350,7 +382,11 @@ class BeamformerBase(HasPrivateTraits):
         return self._steer_obj.grid
 
     def _set_grid(self, grid):
-        warn("Deprecated use of 'grid' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'grid' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'grid' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.grid = grid
 
     # :class:`~acoular.microphones.MicGeom` object that provides the microphone locations.
@@ -362,7 +398,11 @@ class BeamformerBase(HasPrivateTraits):
         return self._steer_obj.mics
 
     def _set_mpos(self, mpos):
-        warn("Deprecated use of 'mpos' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'mpos' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'mpos' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.mics = mpos
 
     # Sound travel distances from microphone array center to grid points (r0)
@@ -372,11 +412,21 @@ class BeamformerBase(HasPrivateTraits):
     r0 = Property()
 
     def _get_r0(self):
+        msg = (
+            "Deprecated use of 'r0' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'r0' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         return self._steer_obj.r0
 
     rm = Property()
 
     def _get_rm(self):
+        msg = (
+            "Deprecated use of 'rm' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'rm' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         return self._steer_obj.rm
 
     # --- End of backwards compatibility traits --------------------------------------
@@ -607,7 +657,7 @@ class BeamformerBase(HasPrivateTraits):
             each grid point .
             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>` and
+            the :attr:`sampling frequency<acoular.base.SamplesGenerator.sample_freq>` and
             used :attr:`FFT block size<acoular.spectra.PowerSpectra.block_size>`.
 
         """
@@ -759,7 +809,10 @@ class BeamformerBase(HasPrivateTraits):
 
 
 class BeamformerFunctional(BeamformerBase):
-    """Functional beamforming after :ref:`Dougherty, 2014<Dougherty2014>`."""
+    """Functional beamforming algorithm.
+
+    See :cite:`Dougherty2014` for details.
+    """
 
     #: Functional exponent, defaults to 1 (= Classic Beamforming).
     gamma = Float(1, desc='functional exponent')
@@ -845,7 +898,10 @@ class BeamformerFunctional(BeamformerBase):
 
 
 class BeamformerCapon(BeamformerBase):
-    """Beamforming using the Capon (Mininimum Variance) algorithm, see :ref:`Capon, 1969<Capon1969>`."""
+    """Beamforming using the Capon (Mininimum Variance) algorithm.
+
+    See :cite:`Capon1969` for details.
+    """
 
     # Boolean flag, if 'True', the main diagonal is removed before beamforming;
     # for Capon beamforming r_diag is set to 'False'.
@@ -880,17 +936,20 @@ class BeamformerCapon(BeamformerBase):
         normfactor = self.sig_loss_norm() * nMics**2
         param_steer_type, steer_vector = self._beamformer_params()
         for i in ind:
-            csm = array(linalg.inv(array(self.freq_data.csm[i], dtype='complex128')), order='C')
+            csm = array(inv(array(self.freq_data.csm[i], dtype='complex128')), order='C')
             beamformerOutput = beamformerFreq(param_steer_type, self.r_diag, normfactor, steer_vector(f[i]), csm)[0]
             self._ac[i] = 1.0 / beamformerOutput
             self._fr[i] = 1
 
 
 class BeamformerEig(BeamformerBase):
-    """Beamforming using eigenvalue and eigenvector techniques, see :ref:`Sarradj et al., 2005<Sarradj2005>`."""
+    """Beamforming using eigenvalue and eigenvector techniques.
+
+    See :cite:`Sarradj2005` for details.
+    """
 
     #: Number of component to calculate:
-    #: 0 (smallest) ... :attr:`~acoular.tprocess.SamplesGenerator.numchannels`-1;
+    #: 0 (smallest) ... :attr:`~acoular.base.SamplesGenerator.numchannels`-1;
     #: defaults to -1, i.e. numchannels-1
     n = Int(-1, desc='No. of eigenvalue')
 
@@ -952,7 +1011,10 @@ class BeamformerEig(BeamformerBase):
 
 
 class BeamformerMusic(BeamformerEig):
-    """Beamforming using the MUSIC algorithm, see :ref:`Schmidt, 1986<Schmidt1986>`."""
+    """Beamforming using the MUSIC algorithm.
+
+    See :cite:`Schmidt1986` for details.
+    """
 
     # Boolean flag, if 'True', the main diagonal is removed before beamforming;
     # for MUSIC beamforming r_diag is set to 'False'.
@@ -1030,9 +1092,13 @@ class PointSpreadFunction(HasPrivateTraits):
         if isinstance(steer, SteeringVector):
             self._steer_obj = steer
         elif steer in ('true level', 'true location', 'classic', 'inverse'):
-            # Type of steering vectors, see also :ref:`Sarradj, 2012<Sarradj2012>`.
+            msg = (
+                "Deprecated use of 'steer' trait. Please use object of class 'SteeringVector'."
+                "The functionality of using string values for 'steer' will be removed in version 25.01."
+            )
+            # Type of steering vectors, see also :cite:`Sarradj2012`.
             warn(
-                "Deprecated use of 'steer' trait. Please use object of class 'SteeringVector' in the future.",
+                msg,
                 Warning,
                 stacklevel=2,
             )
@@ -1051,7 +1117,11 @@ class PointSpreadFunction(HasPrivateTraits):
         return self._steer_obj.env
 
     def _set_env(self, env):
-        warn("Deprecated use of 'env' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'env' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'env' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.env = env
 
     # The speed of sound.
@@ -1063,7 +1133,11 @@ class PointSpreadFunction(HasPrivateTraits):
         return self._steer_obj.env.c
 
     def _set_c(self, c):
-        warn("Deprecated use of 'c' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'c' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'c' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.env.c = c
 
     # :class:`~acoular.grids.Grid`-derived object that provides the grid locations.
@@ -1075,7 +1149,11 @@ class PointSpreadFunction(HasPrivateTraits):
         return self._steer_obj.grid
 
     def _set_grid(self, grid):
-        warn("Deprecated use of 'grid' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'grid' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'grid' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.grid = grid
 
     # :class:`~acoular.microphones.MicGeom` object that provides the microphone locations.
@@ -1087,7 +1165,11 @@ class PointSpreadFunction(HasPrivateTraits):
         return self._steer_obj.mics
 
     def _set_mpos(self, mpos):
-        warn("Deprecated use of 'mpos' trait. ", Warning, stacklevel=2)
+        msg = (
+            "Deprecated use of 'mpos' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'mpos' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         self._steer_obj.mics = mpos
 
     # Sound travel distances from microphone array center to grid points (r0)
@@ -1097,11 +1179,21 @@ class PointSpreadFunction(HasPrivateTraits):
     r0 = Property()
 
     def _get_r0(self):
+        msg = (
+            "Deprecated use of 'r0' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'r0' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         return self._steer_obj.r0
 
     rm = Property()
 
     def _get_rm(self):
+        msg = (
+            "Deprecated use of 'rm' trait. Please use the 'steer' trait with an object of class"
+            "'SteeringVector'. The 'rm' trait will be removed in version 25.01."
+        )
+        warn(msg, DeprecationWarning, stacklevel=2)
         return self._steer_obj.rm
 
     # --- End of backwards compatibility traits --------------------------------------
@@ -1269,12 +1361,18 @@ class PointSpreadFunction(HasPrivateTraits):
 
 
 class BeamformerDamas(BeamformerBase):
-    """DAMAS deconvolution, see :ref:`Brooks and Humphreys, 2006<BrooksHumphreys2006>`."""
+    """DAMAS deconvolution algorithm.
+
+    See :cite:`Brooks2006` for details.
+    """
 
     #: (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 = Trait(BeamformerBase)
+    #: if not set, these have to be set explicitly.
+    beamformer = Property()
+
+    # private storage of beamformer instance
+    _beamformer = Trait(BeamformerBase)
 
     #: The floating-number-precision of the PSFs. Default is 64 bit.
     psf_precision = Trait('float64', 'float32', desc='precision of PSF')
@@ -1294,11 +1392,27 @@ class BeamformerDamas(BeamformerBase):
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['n_iter', 'damp', 'psf_precision'],
     )
 
+    def _get_beamformer(self):
+        return self._beamformer
+
+    def _set_beamformer(self, beamformer):
+        msg = (
+            f"Deprecated use of 'beamformer' trait in class {self.__class__.__name__}. "
+            'Please set :attr:`freq_data`, :attr:`steer`, :attr:`r_diag` directly. '
+            "Using the 'beamformer' trait will be removed in version 25.07."
+        )
+        warn(
+            msg,
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self._beamformer = beamformer
+
     @cached_property
     def _get_digest(self):
         return digest(self)
 
-    @on_trait_change('beamformer.digest')
+    @on_trait_change('_beamformer.digest')
     def delegate_beamformer_traits(self):
         self.freq_data = self.beamformer.freq_data
         self.r_diag = self.beamformer.r_diag
@@ -1347,8 +1461,7 @@ class BeamformerDamas(BeamformerBase):
 
 
 class BeamformerDamasPlus(BeamformerDamas):
-    """DAMAS deconvolution, see :ref:`Brooks and Humphreys, 2006<BrooksHumphreys2006>`,
-    for solving the system of equations, instead of the original Gauss-Seidel
+    """DAMAS deconvolution :cite:`Brooks2006` for solving the system of equations, instead of the original Gauss-Seidel
     iterations, this class employs the NNLS or linear programming solvers from
     scipy.optimize or one  of several optimization algorithms from the scikit-learn module.
     Needs a-priori delay-and-sum beamforming (:class:`BeamformerBase`).
@@ -1465,14 +1578,19 @@ class BeamformerDamasPlus(BeamformerDamas):
 
 
 class BeamformerOrth(BeamformerBase):
-    """Orthogonal deconvolution, see :ref:`Sarradj, 2010<Sarradj2010>`.
+    """Orthogonal deconvolution algorithm.
+
+    See :cite:`Sarradj2010` for details.
     New faster implementation without explicit (:class:`BeamformerEig`).
     """
 
     #: (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 = Trait(BeamformerEig)
+    #: if not set, these have to be set explicitly.
+    beamformer = Property()
+
+    # private storage of beamformer instance
+    _beamformer = Trait(BeamformerEig)
 
     #: List of components to consider, use this to directly set the eigenvalues
     #: used in the beamformer. Alternatively, set :attr:`n`.
@@ -1489,11 +1607,27 @@ class BeamformerOrth(BeamformerBase):
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['eva_list'],
     )
 
+    def _get_beamformer(self):
+        return self._beamformer
+
+    def _set_beamformer(self, beamformer):
+        msg = (
+            f"Deprecated use of 'beamformer' trait in class {self.__class__.__name__}. "
+            'Please set :attr:`freq_data`, :attr:`steer`, :attr:`r_diag` directly. '
+            "Using the 'beamformer' trait will be removed in version 25.07."
+        )
+        warn(
+            msg,
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self._beamformer = beamformer
+
     @cached_property
     def _get_digest(self):
         return digest(self)
 
-    @on_trait_change('beamformer.digest')
+    @on_trait_change('_beamformer.digest')
     def delegate_beamformer_traits(self):
         self.freq_data = self.beamformer.freq_data
         self.r_diag = self.beamformer.r_diag
@@ -1542,7 +1676,9 @@ class BeamformerOrth(BeamformerBase):
 
 
 class BeamformerCleansc(BeamformerBase):
-    """CLEAN-SC deconvolution, see :ref:`Sijtsma, 2007<Sijtsma2007>`.
+    """CLEAN-SC deconvolution algorithm.
+
+    See :cite:`Sijtsma2007` for details.
     Classic delay-and-sum beamforming is already included.
     """
 
@@ -1630,12 +1766,18 @@ class BeamformerCleansc(BeamformerBase):
 
 
 class BeamformerClean(BeamformerBase):
-    """CLEAN deconvolution, see :ref:`Hoegbom, 1974<Hoegbom1974>`."""
+    """CLEAN deconvolution algorithm.
+
+    See :cite:`Hoegbom1974` for details.
+    """
 
     #: (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 = Trait(BeamformerBase)
+    #: if not set, these have to be set explicitly.
+    beamformer = Property()
+
+    # private storage of beamformer instance
+    _beamformer = Trait(BeamformerBase)
 
     #: The floating-number-precision of the PSFs. Default is 64 bit.
     psf_precision = Trait('float64', 'float32', desc='precision of PSF.')
@@ -1659,7 +1801,23 @@ class BeamformerClean(BeamformerBase):
     def _get_digest(self):
         return digest(self)
 
-    @on_trait_change('beamformer.digest')
+    def _get_beamformer(self):
+        return self._beamformer
+
+    def _set_beamformer(self, beamformer):
+        msg = (
+            f"Deprecated use of 'beamformer' trait in class {self.__class__.__name__}. "
+            'Please set :attr:`freq_data`, :attr:`steer`, :attr:`r_diag` directly. '
+            "Using the 'beamformer' trait will be removed in version 25.07."
+        )
+        warn(
+            msg,
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self._beamformer = beamformer
+
+    @on_trait_change('_beamformer.digest')
     def delegate_beamformer_traits(self):
         self.freq_data = self.beamformer.freq_data
         self.r_diag = self.beamformer.r_diag
@@ -1728,8 +1886,10 @@ class BeamformerClean(BeamformerBase):
 
 
 class BeamformerCMF(BeamformerBase):
-    """Covariance Matrix Fitting, see :ref:`Yardibi et al., 2008<Yardibi2008>`.
+    """Covariance Matrix Fitting algorithm.
+
     This is not really a beamformer, but an inverse method.
+    See :cite:`Yardibi2008` for details.
     """
 
     #: Type of fit method to be used ('LassoLars', 'LassoLarsBIC',
@@ -1951,12 +2111,9 @@ class BeamformerCMF(BeamformerBase):
 
 
 class BeamformerSODIX(BeamformerBase):
-    """SODIX, see Funke, Ein Mikrofonarray-Verfahren zur Untersuchung der
-    Schallabstrahlung von Turbofantriebwerken, 2017. and
-    Oertwig, Advancements in the source localization method SODIX and
-    application to short cowl engine data, 2019.
+    """Source directivity modeling in the cross-spectral matrix (SODIX) algorithm.
 
-    Source directivity modeling in the cross-spectral matrix
+    See :cite:`Funke2017` and :cite:`Oertwig2019` for details.
     """
 
     #: Type of fit method to be used ('fmin_l_bfgs_b').
@@ -2112,7 +2269,10 @@ class BeamformerSODIX(BeamformerBase):
 
 
 class BeamformerGIB(BeamformerEig):  # BeamformerEig #BeamformerBase
-    """Beamforming GIB methods with different normalizations,."""
+    """Beamforming GIB methods with different normalizations.
+
+    See :cite:`Suzuki2011` for details.
+    """
 
     #: Unit multiplier for evaluating, e.g., nPa instead of Pa.
     #: Values are converted back before returning.
@@ -2385,7 +2545,10 @@ class BeamformerAdaptiveGrid(BeamformerBase, Grid):
 
 
 class BeamformerGridlessOrth(BeamformerAdaptiveGrid):
-    """Orthogonal beamforming without predefined grid."""
+    """Orthogonal beamforming without predefined grid.
+
+    See :cite:`Sarradj2022` for details.
+    """
 
     #: List of components to consider, use this to directly set the eigenvalues
     #: used in the beamformer. Alternatively, set :attr:`n`.