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

acoular/fbeamform.py

@@ -99,37 +99,38 @@ class SteeringVector(HasStrictTraits):
     """
 
     #: :class:`~acoular.grids.Grid`-derived object that provides the grid locations.
-    grid = Instance(Grid, desc='beamforming grid')
+    grid = Instance(Grid)
 
     #: :class:`~acoular.microphones.MicGeom` object that provides the microphone locations.
-    mics = Instance(MicGeom, desc='microphone geometry')
+    mics = Instance(MicGeom)
 
     #: Type of steering vectors, see also :cite:`Sarradj2012`. Defaults to 'true level'.
-    steer_type = Enum('true level', 'true location', 'classic', 'inverse', desc='type of steering vectors used')
+    steer_type = Enum('true level', 'true location', 'classic', 'inverse')
 
     #: :class:`~acoular.environments.Environment` or derived object,
     #: which provides information about the sound propagation in the medium.
     #: Defaults to standard :class:`~acoular.environments.Environment` object.
     env = Instance(Environment(), Environment)
 
-    # Sound travel distances from microphone array center to grid
-    # points or reference position (readonly). Feature may change.
-    r0 = Property(desc='array center to grid distances')
+    #: Sound travel distances from microphone array center to grid : points or reference position
+    #: (readonly). Feature may change.
+    r0 = Property()
 
-    # Sound travel distances from array microphones to grid
-    # points (readonly). Feature may change.
-    rm = Property(desc='all array mics to grid distances')
+    #: Sound travel distances from array microphones to grid : points (readonly). Feature may
+    #: change.
+    rm = Property()
 
-    # mirror trait for ref
-    _ref = Any(np.array([0.0, 0.0, 0.0]), desc='reference position or distance')
+    # reference position or distance
+    _ref = Any(np.array([0.0, 0.0, 0.0]))
 
     #: Reference position or distance at which to evaluate the sound pressure
     #: of a grid point.
     #: If set to a scalar, this is used as reference distance to the grid points.
     #: If set to a vector, this is interpreted as x,y,z coordinates of the reference position.
     #: Defaults to [0.,0.,0.].
-    ref = Property(desc='reference position or distance')
+    ref = Property()
 
+    #: dictionary of frequency domain steering vector functions
     _steer_funcs_freq = Dict(
         {
             'classic': lambda x: x / np.abs(x) / x.shape[-1],
@@ -138,9 +139,9 @@ class SteeringVector(HasStrictTraits):
             'true location': lambda x: x / np.sqrt(np.einsum('ij,ij->i', x, x.conj()) * x.shape[-1])[:, np.newaxis],
         },
         transient=True,
-        desc='dictionary of frequency domain steering vector functions',
     )
 
+    #: dictionary of time domain steering vector functions
     _steer_funcs_time = Dict(
         {
             'classic': _steer_I,
@@ -149,7 +150,6 @@ class SteeringVector(HasStrictTraits):
             'true location': _steer_IV,
         },
         transient=True,
-        desc='dictionary of time domain steering vector functions',
     )
 
     def _set_ref(self, ref):
@@ -166,10 +166,11 @@ class SteeringVector(HasStrictTraits):
     def _get_ref(self):
         return self._ref
 
-    # internal identifier
+    #: A unique identifier for the steering vector, based on its properties. (read-only)
     digest = Property(depends_on=['steer_type', 'env.digest', 'grid.digest', 'mics.digest', '_ref'])
 
-    # internal identifier, use for inverse methods, excluding steering vector type
+    #: A unique identifier for the grid, excluding :attr:`steer_type`.
+    #: Use for inverse methods. (read-only)
     inv_digest = Property(depends_on=['env.digest', 'grid.digest', 'mics.digest', '_ref'])
 
     @property_depends_on(['grid.digest', 'env.digest', '_ref'])
@@ -277,52 +278,55 @@ class LazyBfResult:
 class BeamformerBase(HasStrictTraits):
     """Beamforming using the basic delay-and-sum algorithm in the frequency domain."""
 
-    # Instance of :class:`~acoular.fbeamform.SteeringVector` or its derived classes
-    # that contains information about the steering vector. This is a private trait.
-    # Do not set this directly, use `steer` trait instead.
+    #: Instance of :class:`~acoular.fbeamform.SteeringVector` or its derived classes
+    #: that contains information about the steering vector. This is a private trait.
+    #: Do not set this directly, use `steer` trait instead.
     steer = Instance(SteeringVector, args=())
 
     #: :class:`~acoular.spectra.PowerSpectra` object that provides the
     #: cross spectral matrix and eigenvalues
-    freq_data = Instance(PowerSpectra, desc='freq data object')
+    freq_data = Instance(PowerSpectra)
 
     #: Boolean flag, if 'True' (default), the main diagonal is removed before beamforming.
-    r_diag = Bool(True, desc='removal of diagonal')
+    r_diag = Bool(True)
 
-    #: If r_diag==True: if r_diag_norm==0.0, the standard
+    #: If diagonal of the CSM is removed, some signal energy is lost.
+    #: This is handled via this normalization factor.
+    #: Internally, the default is: num_mics / (num_mics - 1).
+    #:
+    #: If r_diag==True: if r_diag_norm==0.0, the default
     #: normalization = num_mics/(num_mics-1) is used.
     #: If r_diag_norm !=0.0, the user input is used instead.
     #: If r_diag==False, the normalization is 1.0 either way.
-    r_diag_norm = Float(
-        0.0,
-        desc='If diagonal of the csm is removed, some signal energy is lost.'
-        'This is handled via this normalization factor.'
-        'Internally, the default is: num_mics / (num_mics - 1).',
-    )
+    r_diag_norm = Float(0.0)
 
     #: Floating point precision of property result. Corresponding to numpy dtypes. Default = 64 Bit.
-    precision = Enum('float64', 'float32', desc='precision (32/64 Bit) of result, corresponding to numpy dtypes')
+    precision = Enum('float64', 'float32')
 
     #: Boolean flag, if 'True' (default), the result is cached in h5 files.
-    cached = Bool(True, desc='cached flag')
+    cached = Bool(True)
 
-    # hdf5 cache file
+    #: hdf5 cache file
     h5f = Instance(H5CacheFileBase, transient=True)
 
     #: The beamforming result as squared sound pressure values
     #: at all grid point locations (readonly).
     #: Returns a (number of frequencies, number of gridpoints) array-like
     #: of floats. Values can only be accessed via the index operator [].
-    result = Property(desc='beamforming result')
+    result = Property()
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES)
 
     # private traits
-    _ac = Any(desc='beamforming result')
-    _fr = Any(desc='flag for beamforming result at frequency index')
-    _f = CArray(dtype='float64', desc='frequencies')
-    _numfreq = Int(desc='number of frequencies')
+    #: beamforming result
+    _ac = Any()
+    #: flag for beamforming result at frequency index
+    _fr = Any()
+    #: frequencies
+    _f = CArray(dtype='float64')
+    #: number of frequencies
+    _numfreq = Int()
 
     @cached_property
     def _get_digest(self):
@@ -677,19 +681,16 @@ class BeamformerFunctional(BeamformerBase):
     """
 
     #: Functional exponent, defaults to 1 (= Classic Beamforming).
-    gamma = Float(1, desc='functional exponent')
+    gamma = Float(1)
 
     #: Functional Beamforming is only well defined for full CSM
-    r_diag = Enum(False, desc='False, as Functional Beamformer is only well defined for the full CSM')
+    r_diag = Enum(False)
 
     #: Normalization factor in case of CSM diagonal removal. Defaults to 1.0 since Functional
     #: Beamforming is only well defined for full CSM.
-    r_diag_norm = Enum(
-        1.0,
-        desc='No normalization needed. Functional Beamforming is only well defined for full CSM.',
-    )
+    r_diag_norm = Enum(1.0)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['gamma'])
 
     @cached_property
@@ -768,16 +769,13 @@ class BeamformerCapon(BeamformerBase):
     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'.
-    r_diag = Enum(False, desc='removal of diagonal')
+    #: Boolean flag, if ``True``, the main diagonal is removed before beamforming;
+    #: for Capon beamforming :attr:`r_diag` is set to ``False``.
+    r_diag = Enum(False)
 
-    #: Normalization factor in case of CSM diagonal removal. Defaults to 1.0 since Beamformer Capon
-    #: is only well defined for full CSM.
-    r_diag_norm = Enum(
-        1.0,
-        desc='No normalization. BeamformerCapon is only well defined for full CSM.',
-    )
+    #: Normalization factor in case of CSM diagonal removal.
+    #: Defaults to ``1.0`` since Beamformer Capon is only well defined for full CSM.
+    r_diag_norm = Enum(1.0)
 
     def _calc(self, ind):
         """
@@ -816,14 +814,15 @@ class BeamformerEig(BeamformerBase):
     """
 
     #: Number of component to calculate:
-    #: 0 (smallest) ... :attr:`~acoular.base.SamplesGenerator.num_channels`-1;
-    #: defaults to -1, i.e. num_channels-1
-    n = Int(-1, desc='No. of eigenvalue')
+    #: ``0`` (smallest) ... :attr:`~acoular.base.SamplesGenerator.num_channels`-1;
+    #: defaults to ``-1``, i.e. :attr:`~acoular.base.SamplesGenerator.num_channels`-1.
+    n = Int(-1)
 
     # Actual component to calculate, internal, readonly.
-    na = Property(desc='No. of eigenvalue')
+    #: No. of eigenvalue
+    na = Property()
 
-    # internal identifier
+    #: A uniquernal identifier for the beamformer, based on its properties. (read-only)
     digest = Property(depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['n'])
 
     @cached_property
@@ -884,20 +883,18 @@ class BeamformerMusic(BeamformerEig):
     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'.
-    r_diag = Enum(False, desc='removal of diagonal')
+    #: Boolean flag, if ``True``, the main diagonal is removed before beamforming;
+    #: for MUSIC beamforming :attr:`r_diag` is set to ``False``.
+    r_diag = Enum(False)
 
     #: Normalization factor in case of CSM diagonal removal. Defaults to 1.0 since BeamformerMusic
     #: is only well defined for full CSM.
-    r_diag_norm = Enum(
-        1.0,
-        desc='No normalization. BeamformerMusic is only well defined for full CSM.',
-    )
+    r_diag_norm = Enum(1.0)
 
     # assumed number of sources, should be set to a value not too small
     # defaults to 1
-    n = Int(1, desc='assumed number of sources')
+    #: assumed number of sources
+    n = Int(1)
 
     def _calc(self, ind):
         """
@@ -946,16 +943,15 @@ class PointSpreadFunction(HasStrictTraits):
     the aberrations when using simple delay-and-sum beamforming.
     """
 
-    # Instance of :class:`~acoular.fbeamform.SteeringVector` or its derived classes
-    # that contains information about the steering vector. This is a private trait.
-    # Do not set this directly, use `steer` trait instead.
+    #: Instance of :class:`~acoular.fbeamform.SteeringVector` or its derived classes
+    #: that contains information about the steering vector. This is a private trait.
+    #: Do not set this directly, use :attr:`steer` trait instead.
     steer = Instance(SteeringVector, args=())
 
     #: Indices of grid points to calculate the PSF for.
     grid_indices = CArray(
         dtype=int,
         value=np.array([]),
-        desc='indices of grid points for psf',
     )  # value=array([]), value=self.steer.grid.pos(),
 
     #: Flag that defines how to calculate and store the point spread function
@@ -969,21 +965,21 @@ class PointSpreadFunction(HasStrictTraits):
     #:            (useful if not all PSFs are needed, as with :class:`CLEAN<BeamformerClean>`)
     #: * 'readonly': Do not attempt to calculate the PSF since it should already be cached (useful
     #:               if multiple processes have to access the cache file)
-    calcmode = Enum('single', 'block', 'full', 'readonly', desc='mode of calculation / storage')
+    calcmode = Enum('single', 'block', 'full', 'readonly')
 
     #: Floating point precision of property psf. Corresponding to numpy dtypes. Default = 64 Bit.
-    precision = Enum('float64', 'float32', desc='precision (32/64 Bit) of result, corresponding to numpy dtypes')
+    precision = Enum('float64', 'float32')
 
     #: The actual point spread function.
-    psf = Property(desc='point spread function')
+    psf = Property()
 
     #: Frequency to evaluate the PSF for; defaults to 1.0.
-    freq = Float(1.0, desc='frequency')
+    freq = Float(1.0)
 
     # hdf5 cache file
     h5f = Instance(H5CacheFileBase, transient=True)
 
-    # internal identifier
+    #: A unique identifier for the object, based on its properties. (read-only)
     digest = Property(depends_on=['steer.digest', 'precision'], cached=True)
 
     @cached_property
@@ -1129,19 +1125,28 @@ class BeamformerDamas(BeamformerBase):
     """
 
     #: The floating-number-precision of the PSFs. Default is 64 bit.
-    psf_precision = Enum('float64', 'float32', desc='precision of PSF')
+    psf_precision = Enum('float64', 'float32')
 
     #: Number of iterations, defaults to 100.
-    n_iter = Int(100, desc='number of iterations')
+    n_iter = Int(100)
 
     #: Damping factor in modified gauss-seidel
-    damp = Float(1.0, desc='damping factor in modified gauss-seidel-DAMAS-approach')
+    damp = Float(1.0)
 
-    #: Flag that defines how to calculate and store the point spread function,
-    #: defaults to 'full'. See :attr:`PointSpreadFunction.calcmode` for details.
-    calcmode = Enum('full', 'single', 'block', 'readonly', desc='mode of psf calculation / storage')
+    #: Flag that defines how to calculate and store the point spread function
+    #: defaults to 'single'.
+    #:
+    #: * 'full': Calculate the full PSF (for all grid points) in one go (should be used if the PSF
+    #:           at all grid points is needed, as with :class:`DAMAS<BeamformerDamas>`)
+    #: * 'single': Calculate the PSF for the grid points defined by :attr:`grid_indices`, one by one
+    #:             (useful if not all PSFs are needed, as with :class:`CLEAN<BeamformerClean>`)
+    #: * 'block': Calculate the PSF for the grid points defined by :attr:`grid_indices`, in one go
+    #:            (useful if not all PSFs are needed, as with :class:`CLEAN<BeamformerClean>`)
+    #: * 'readonly': Do not attempt to calculate the PSF since it should already be cached (useful
+    #:               if multiple processes have to access the cache file)
+    calcmode = Enum('full', 'single', 'block', 'readonly')
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['n_iter', 'damp', 'psf_precision'],
     )
@@ -1206,25 +1211,25 @@ class BeamformerDamasPlus(BeamformerDamas):
     #: These methods are implemented in
     #: the `scikit-learn <http://scikit-learn.org/stable/user_guide.html>`_
     #: module or within scipy.optimize respectively.
-    method = Enum('NNLS', 'LP', 'LassoLars', 'OMPCV', desc='method used for solving deconvolution problem')
+    method = Enum('NNLS', 'LP', 'LassoLars', 'OMPCV')
 
     #: Weight factor for LassoLars method,
     #: defaults to 0.0.
     # (Values in the order of 10^⁻9 should produce good results.)
-    alpha = Range(0.0, 1.0, 0.0, desc='Lasso weight factor')
+    alpha = Range(0.0, 1.0, 0.0)
 
     #: Maximum number of iterations,
     #: tradeoff between speed and precision;
     #: defaults to 500
-    n_iter = Int(500, desc='maximum number of iterations')
+    n_iter = Int(500)
 
     #: Unit multiplier for evaluating, e.g., nPa instead of Pa.
     #: Values are converted back before returning.
     #: Temporary conversion may be necessary to not reach machine epsilon
     #: within fitting method algorithms. Defaults to 1e9.
-    unit_mult = Float(1e9, desc='unit multiplier')
+    unit_mult = Float(1e9)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['alpha', 'method', 'n_iter', 'unit_mult'],
     )
@@ -1319,15 +1324,15 @@ class BeamformerOrth(BeamformerBase):
 
     #: List of components to consider, use this to directly set the eigenvalues
     #: used in the beamformer. Alternatively, set :attr:`n`.
-    eva_list = CArray(dtype=int, value=np.array([-1]), desc='components')
+    eva_list = CArray(dtype=int, value=np.array([-1]))
 
-    #: Number of components to consider, defaults to 1. If set,
+    #: Number of components to consider, defaults to ``1``. If set,
     #: :attr:`eva_list` will contain
     #: the indices of the n largest eigenvalues. Setting :attr:`eva_list`
     #: afterwards will override this value.
     n = Int(1)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['eva_list'],
     )
@@ -1388,18 +1393,18 @@ class BeamformerCleansc(BeamformerBase):
 
     #: no of CLEAN-SC iterations
     #: defaults to 0, i.e. automatic (max 2*num_channels)
-    n_iter = Int(0, desc='no of iterations')
+    n_iter = Int(0)
 
     #: iteration damping factor
     #: defaults to 0.6
-    damp = Range(0.01, 1.0, 0.6, desc='damping factor')
+    damp = Range(0.01, 1.0, 0.6)
 
     #: iteration stop criterion for automatic detection
     #: iteration stops if power[i]>power[i-stopn]
     #: defaults to 3
-    stopn = Int(3, desc='stop criterion index')
+    stopn = Int(3)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['n_iter', 'damp', 'stopn'])
 
     @cached_property
@@ -1478,19 +1483,31 @@ class BeamformerClean(BeamformerBase):
     """
 
     #: The floating-number-precision of the PSFs. Default is 64 bit.
-    psf_precision = Enum('float64', 'float32', desc='precision of PSF.')
+    psf_precision = Enum('float64', 'float32')
 
     # iteration damping factor
     # defaults to 0.6
-    damp = Range(0.01, 1.0, 0.6, desc='damping factor')
+    #: damping factor
+    damp = Range(0.01, 1.0, 0.6)
 
     # max number of iterations
-    n_iter = Int(100, desc='maximum number of iterations')
+    #: maximum number of iterations
+    n_iter = Int(100)
 
-    # how to calculate and store the psf
-    calcmode = Enum('block', 'full', 'single', 'readonly', desc='mode of psf calculation / storage')
+    #: Flag that defines how to calculate and store the point spread function
+    #: defaults to 'single'.
+    #:
+    #: * 'full': Calculate the full PSF (for all grid points) in one go (should be used if the PSF
+    #:           at all grid points is needed, as with :class:`DAMAS<BeamformerDamas>`)
+    #: * 'single': Calculate the PSF for the grid points defined by :attr:`grid_indices`, one by one
+    #:             (useful if not all PSFs are needed, as with :class:`CLEAN<BeamformerClean>`)
+    #: * 'block': Calculate the PSF for the grid points defined by :attr:`grid_indices`, in one go
+    #:            (useful if not all PSFs are needed, as with :class:`CLEAN<BeamformerClean>`)
+    #: * 'readonly': Do not attempt to calculate the PSF since it should already be cached (useful
+    #:               if multiple processes have to access the cache file)
+    calcmode = Enum('block', 'full', 'single', 'readonly')
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=BEAMFORMER_BASE_DIGEST_DEPENDENCIES + ['n_iter', 'damp', 'psf_precision'],
     )
@@ -1581,37 +1598,33 @@ class BeamformerCMF(BeamformerBase):
         'fmin_l_bfgs_b',
         'Split_Bregman',
         'FISTA',
-        desc='fit method used',
     )
 
     #: Weight factor for LassoLars method,
     #: defaults to 0.0.
     #: (Use values in the order of 10^⁻9 for good results.)
-    alpha = Range(0.0, 1.0, 0.0, desc='Lasso weight factor')
+    alpha = Range(0.0, 1.0, 0.0)
 
     #: Total or maximum number of iterations
     #: (depending on :attr:`method`),
     #: tradeoff between speed and precision;
     #: defaults to 500
-    n_iter = Int(500, desc='maximum number of iterations')
+    n_iter = Int(500)
 
     #: Unit multiplier for evaluating, e.g., nPa instead of Pa.
     #: Values are converted back before returning.
     #: Temporary conversion may be necessary to not reach machine epsilon
     #: within fitting method algorithms. Defaults to 1e9.
-    unit_mult = Float(1e9, desc='unit multiplier')
+    unit_mult = Float(1e9)
 
     #: If True, shows the status of the PyLops solver. Only relevant in case of FISTA or
     #: Split_Bregman
-    show = Bool(False, desc='show output of PyLops solvers')
+    show = Bool(False)
 
     #: Energy normalization in case of diagonal removal not implemented for inverse methods.
-    r_diag_norm = Enum(
-        None,
-        desc='Energy normalization in case of diagonal removal not implemented for inverse methods',
-    )
+    r_diag_norm = Enum(None)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=[
             'freq_data.digest',
@@ -1797,30 +1810,27 @@ class BeamformerSODIX(BeamformerBase):
     #: Type of fit method to be used ('fmin_l_bfgs_b').
     #: These methods are implemented in
     #: the scipy module.
-    method = Enum('fmin_l_bfgs_b', desc='fit method used')
+    method = Enum('fmin_l_bfgs_b')
 
     #: Maximum number of iterations,
     #: tradeoff between speed and precision;
     #: defaults to 200
-    n_iter = Int(200, desc='maximum number of iterations')
+    n_iter = Int(200)
 
     #: Weight factor for regularization,
     #: defaults to 0.0.
-    alpha = Range(0.0, 1.0, 0.0, desc='regularization factor')
+    alpha = Range(0.0, 1.0, 0.0)
 
     #: Unit multiplier for evaluating, e.g., nPa instead of Pa.
     #: Values are converted back before returning.
     #: Temporary conversion may be necessary to not reach machine epsilon
     #: within fitting method algorithms. Defaults to 1e9.
-    unit_mult = Float(1e9, desc='unit multiplier')
+    unit_mult = Float(1e9)
 
     #: Energy normalization in case of diagonal removal not implemented for inverse methods.
-    r_diag_norm = Enum(
-        None,
-        desc='Energy normalization in case of diagonal removal not implemented for inverse methods',
-    )
+    r_diag_norm = Enum(None)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=[
             'freq_data.digest',
@@ -1960,13 +1970,13 @@ class BeamformerGIB(BeamformerEig):  # BeamformerEig #BeamformerBase
     #: Values are converted back before returning.
     #: Temporary conversion may be necessary to not reach machine epsilon
     #: within fitting method algorithms. Defaults to 1e9.
-    unit_mult = Float(1e9, desc='unit multiplier')
+    unit_mult = Float(1e9)
 
     #: Total or maximum number of iterations
     #: (depending on :attr:`method`),
     #: tradeoff between speed and precision;
     #: defaults to 10
-    n_iter = Int(10, desc='maximum number of iterations')
+    n_iter = Int(10)
 
     #: Type of fit method to be used ('Suzuki', 'LassoLars', 'LassoLarsCV', 'LassoLarsBIC',
     #: 'OMPCV' or 'NNLS', defaults to 'Suzuki').
@@ -1981,37 +1991,33 @@ class BeamformerGIB(BeamformerEig):  # BeamformerEig #BeamformerBase
         'LassoLarsCV',
         'OMPCV',
         'NNLS',
-        desc='fit method used',
     )
 
     #: Weight factor for LassoLars method,
     #: defaults to 0.0.
-    alpha = Range(0.0, 1.0, 0.0, desc='Lasso weight factor')
+    alpha = Range(0.0, 1.0, 0.0)
     # (use values in the order of 10^⁻9 for good results)
 
     #: Norm to consider for the regularization in InverseIRLS and Suzuki methods
     #: defaults to L-1 Norm
-    pnorm = Float(1, desc='Norm for regularization')
+    pnorm = Float(1)
 
     #: Beta - Fraction of sources maintained after each iteration
     #: defaults to 0.9
-    beta = Float(0.9, desc='fraction of sources maintained')
+    beta = Float(0.9)
 
     #: eps - Regularization parameter for Suzuki algorithm
     #: defaults to 0.05.
-    eps_perc = Float(0.05, desc='regularization parameter')
+    eps_perc = Float(0.05)
 
     # This feature is not fully supported may be changed in the next release
-    # First eigenvalue to consider. Defaults to 0.
-    m = Int(0, desc='First eigenvalue to consider')
+    #: First eigenvalue to consider. Defaults to 0.
+    m = Int(0)
 
     #: Energy normalization in case of diagonal removal not implemented for inverse methods.
-    r_diag_norm = Enum(
-        None,
-        desc='Energy normalization in case of diagonal removal not implemented for inverse methods',
-    )
+    r_diag_norm = Enum(None)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=[
             'steer.inv_digest',
@@ -2244,7 +2250,7 @@ class BeamformerGridlessOrth(BeamformerAdaptiveGrid):
 
     #: List of components to consider, use this to directly set the eigenvalues
     #: used in the beamformer. Alternatively, set :attr:`n`.
-    eva_list = CArray(dtype=int, value=np.array([-1]), desc='components')
+    eva_list = CArray(dtype=int, value=np.array([-1]))
 
     #: Number of components to consider, defaults to 1. If set,
     #: :attr:`eva_list` will contain
@@ -2264,15 +2270,12 @@ class BeamformerGridlessOrth(BeamformerAdaptiveGrid):
     #: and 1 iteration
     shgo = Dict
 
-    #: No normalization implemented. Defaults to 1.0.
-    r_diag_norm = Enum(
-        1.0,
-        desc='If diagonal of the csm is removed, some signal energy is lost.'
-        'This is handled via this normalization factor.'
-        'For this class, normalization is not implemented. Defaults to 1.0.',
-    )
+    #: If diagonal of the csm is removed, some signal energy is lost.
+    #: This is handled via this normalization factor.
+    #: For this class, normalization is not implemented. Defaults to 1.0.
+    r_diag_norm = Enum(1.0)
 
-    # internal identifier
+    #: A unique identifier for the beamformer, based on its properties. (read-only)
     digest = Property(
         depends_on=['freq_data.digest', 'steer.digest', 'precision', 'r_diag', 'eva_list', 'bounds', 'shgo'],
     )