Skip to content

Commit

Permalink
add cmd + special iterator functions to the list of public functions …
Browse files Browse the repository at this point in the history
…in the gclean docs
  • Loading branch information
schiebel committed Feb 2, 2024
1 parent ad4e144 commit 2bcdfb0
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/source/design/boundary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,20 @@ The functions implemented within :xref:`gclean` are :
:green:`creating the restored image` -- :code:`cl.restore( )` called after the completion
of the :xref:`gclean` processing. This creates the final, restored image and
returns a dictionary which contains an :code:`image` field whose value is the
path to the restored image.
path to the restored image.

:green:`retrieve list of executed commands` -- :code:`cl.cmds( history=False )` called
to retrieve the list of :code:`tclean`, :code:`deconvolve` etc. to display as a log
for the user. If :code:`history` is set to :code:`True` then the entire history is
returned. Otherwise, the commands since the last :code:`next(gc)` execution are
returned.

:green:`special Python functions that create an iterator` -- :code:`__next__`, :code:`__anext__`
(:code:`__anext__` is an *asyncio* version of :code:`__next`) should perform one model update
step (deconvolution) is run, followed by one residual update step (major cycle). The special
:code:`__iter__` and :code:`__aiter__` functions should just return :code:`self`, and the
:code:`__del__` function should run :code:`restore`.


The typical interactive clean pattern of :code:`gclean` usage is::

Expand Down

0 comments on commit 2bcdfb0

Please sign in to comment.