:py:mod:`vamtoolbox.display`
============================

.. py:module:: vamtoolbox.display


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

Classes
~~~~~~~

.. autoapisummary::

   vamtoolbox.display.CursorFormatter
   vamtoolbox.display.IndexTracker
   vamtoolbox.display.BodiesIndexTracker
   vamtoolbox.display.VolumeSlicer
   vamtoolbox.display.SlicePlot
   vamtoolbox.display.ErrorPlot
   vamtoolbox.display.HistogramPlot
   vamtoolbox.display.EvolvingPlot



Functions
~~~~~~~~~

.. autoapisummary::

   vamtoolbox.display.showVolumeSlicer
   vamtoolbox.display.showSinoSlicer
   vamtoolbox.display.showErrorPlot
   vamtoolbox.display.showHistogramPlot
   vamtoolbox.display.errorTolerancePlot
   vamtoolbox.display.saveFigure



.. py:class:: CursorFormatter(im, slice_index=None)


   .. py:method:: cursorString(x, y, body_str)


   .. py:method:: __call__(x, y)



.. py:class:: IndexTracker(array, vol_type, slice_index, label, slice_step, ax=None, fig=None, **kwargs)


   .. py:method:: onscroll(event)


   .. py:method:: update()



.. py:class:: BodiesIndexTracker(array, vol_type, slice_index, label, slice_step, ax=None, fig=None, **kwargs)


   .. py:method:: onscroll(event)


   .. py:method:: update()



.. py:class:: VolumeSlicer(array, vol_type, slice_step=1, show_bodies=False, ax=None, fig=None, **kwargs)



.. py:function:: showVolumeSlicer(array, vol_type, slice_step=1, **kwargs)


.. py:function:: showSinoSlicer(array, **kwargs)


.. py:class:: SlicePlot(array, vol_type, show_bodies=False, ax=None, fig=None, **kwargs)


   .. py:method:: update(vol)



.. py:class:: ErrorPlot(*args, ax=None, fig=None)


   .. py:method:: update(error)



.. py:function:: showErrorPlot(*args, **kwargs)


.. py:class:: HistogramPlot(x, target, scale='linear', ax=None, fig=None)


   .. py:method:: update(x)


   .. py:method:: save(savepath, **kwargs)

      Save the current plot

      :param savepath:
      :type savepath: str
      :param \*\*kwargs: kwargs from matplotlib.pyplot.savefig



.. py:function:: showHistogramPlot(*args, **kwargs)


.. py:class:: EvolvingPlot(target_geo, n_iter)


   .. py:method:: update(error, x=None)


   .. py:method:: ioff()



.. py:function:: errorTolerancePlot(x, target_geo, dh, tol, savepath=None)


.. py:function:: saveFigure(savepath)