Skip to content

Commit

Permalink
fix missing output_shape in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tlambert03 committed Feb 15, 2020
1 parent 70a4706 commit 9b9f37a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ For finer-tuned control, you may wish to make an OTF file from your PSF using :f
>>> with RLContext(imshape, otf_path, dz) as ctx:
... for impath in imlist:
... image = tifffile.imread(impath)
... result = rl_decon(image, ctx.out_shape)
... result = rl_decon(image, output_shape=ctx.out_shape)
... # do something with result...
If you have a 3D PSF volume, the :class:`pycudadecon.TemporaryOTF` context manager facilitates temporary OTF generation...
Expand All @@ -44,7 +44,7 @@ If you have a 3D PSF volume, the :class:`pycudadecon.TemporaryOTF` context manag
... with RLContext(imshape, otf.path, dz) as ctx:
... for impath in imlist:
... image = tifffile.imread(impath)
... result = rl_decon(image, ctx.out_shape)
... result = rl_decon(image, output_shape=ctx.out_shape)
... # do something with result...
... and that bit of code is essentially what the :func:`pycudadecon.decon` function is doing, with a little bit of additional conveniences added in.
Expand Down

0 comments on commit 9b9f37a

Please sign in to comment.