Skip to content

Commit

Permalink
docs: add intersphinx mappings and update library alternatives
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmueller committed Mar 14, 2018
1 parent 414a404 commit 5acfd4a
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions examples/tif_hologram.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
corresponding `Python example <http://shampoo.readthedocs.io/en/latest
/getting_started.html#simple-numerical-reconstruction>`_.
The object returned by the `get_qpimage` function is an instance of
:class:`qpimage.QPImage <qpimage.core.QPImage>` which allows for
field refocusing. The refocused QPImage is background-corrected
The object returned by the
:func:`get_qpimage <qpformat.file_formats.dataset.SingleData.get_qpimage`
function is an instance of :class:`qpimage.QPImage <qpimage.core.QPImage>`
which allows for field refocusing. The refocused QPImage is background-corrected
using a polynomial fit to the phase data at locations where the
amplitude data is not attenuated (bright regions in the amplitude
image).
Expand Down

0 comments on commit 5acfd4a

Please sign in to comment.