microcorrelate.callbacks
========================

.. py:module:: microcorrelate.callbacks

.. autoapi-nested-parse::

   Registration callbacks taken from https://github.com/InsightSoftwareConsortium/SimpleITK-Notebooks/tree/master/Python



Functions
---------

.. autoapisummary::

   microcorrelate.callbacks.metric_end_plot
   microcorrelate.callbacks.metric_plot_values
   microcorrelate.callbacks.metric_start_plot


Module Contents
---------------

.. py:function:: metric_end_plot()

   Clean up metric plot state and close the figure at the end of a registration run.


.. py:function:: metric_plot_values(registration_method)

   Update and display the metric plot at each optimiser iteration.

   :param registration_method: The active SimpleITK registration method.
   :type registration_method: sitk.ImageRegistrationMethod


.. py:function:: metric_start_plot()

   Initialise metric plot state at the start of a registration run.