Renishaw survey image and marker for the mapping area

[ericpre]

Progress of the PR

• Return survey image instead of saving it to the metadata,
• add marker of the mapping area,
• update docstring (if appropriate),
• [n/a] update user guide (if appropriate),
• add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
• Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:rosettasciio build of this PR (link in github checks)
• add tests,
• ready for review.

[codecov]

Codecov Report

Attention: Patch coverage is 98.38710% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 86.29%. Comparing base (921020d) to head (d5a7ef9).
Report is 14 commits behind head on main.

Files	Patch %	Lines
rsciio/renishaw/_api.py	97.22%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #227      +/-   ##
==========================================
+ Coverage   86.23%   86.29%   +0.05%     
==========================================
  Files          82       83       +1     
  Lines       10557    10592      +35     
  Branches     2295     2302       +7     
==========================================
+ Hits         9104     9140      +36     
  Misses        934      934              
+ Partials      519      518       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ericpre]

pre-commit.ci autofix

[ericpre]

pre-commit.ci autofix

[jlaehne]

Looks good. Though I would clarify in the docstring/documentation more exactly what is returned. The survey image is added as additional dictionary after the map's dictionary to the same object.

For HyperSpy, I guess that translates into a stack of signals where first comes the actual map data and second the survey image?

[ericpre]

Looks good. Though I would clarify in the docstring/documentation more exactly what is returned. The survey image is added as additional dictionary after the map's dictionary to the same object.

For HyperSpy, I guess that translates into a stack of signals where first comes the actual map data and second the survey image?

This is the same as for format that contains spectrum image and survey image or other any other data acquired simultaneously: hs.load will return a list of signals (as oppose a stacked signal):

For example with the file from the test suite:

>>> s = hs.load(renishaw_test_streamline.wdf")
[<LumiSpectrum, title: StreamLine image acquisition 5, dimensions: (45, 49|394)>,
 <Signal2D, title: , dimensions: (|376, 240)>]