Fixes and improvement of mask handling in lazy decomposition

[ericpre]

Fix #2605: mask is not supported with SVD decomposition and the error message is misleading.

Progress of the PR

• Fix error message when performing svd decomposition of lazy signals and using mask,
• improve docstring,
• check signal and navigation mask,
• add entry to CHANGES.rst (if appropriate),
• add tests,
• ready for review.

import hyperspy.api as hs
import numpy as np
import pytest

rng = np.random.RandomState(123)
s = hs.signals.Signal1D(rng.random_sample(size=(20, 100))).as_lazy()
sig_mask = (s.inav[0].data < 0.5).compute()
with pytest.raises(NotImplementedError):
    s.decomposition(algorithm="SVD", signal_mask=sig_mask)

[codecov]

Codecov Report

Merging #2657 (dad6a71) into RELEASE_next_patch (477d488) will increase coverage by 0.61%.
The diff coverage is 88.86%.

@@                  Coverage Diff                   @@
##           RELEASE_next_patch    #2657      +/-   ##
======================================================
+ Coverage               75.97%   76.59%   +0.61%     
======================================================
  Files                     202      201       -1     
  Lines                   29588    29675      +87     
  Branches                 6448     6496      +48     
======================================================
+ Hits                    22480    22730     +250     
+ Misses                   5311     5182     -129     
+ Partials                 1797     1763      -34     

Impacted Files	Coverage Δ
hyperspy/__init__.py	100.00% <ø> (ø)
hyperspy/_components/arctan.py	66.66% <ø> (ø)
hyperspy/_components/bleasdale.py	100.00% <ø> (ø)
hyperspy/_components/doniach.py	94.44% <ø> (ø)
hyperspy/_components/eels_arctan.py	89.47% <ø> (ø)
hyperspy/_components/eels_cl_edge.py	75.14% <ø> (ø)
hyperspy/_components/eels_double_power_law.py	96.42% <ø> (ø)
hyperspy/_components/eels_vignetting.py	63.79% <ø> (ø)
hyperspy/_components/error_function.py	81.81% <ø> (ø)
hyperspy/_components/exponential.py	81.81% <ø> (ø)
... and 192 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a2e37c8...19de794. Read the comment docs.