:py:mod:`vamtoolbox.displaygrayscale`
=====================================

.. py:module:: vamtoolbox.displaygrayscale


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

Classes
~~~~~~~

.. autoapisummary::

   vamtoolbox.displaygrayscale.CursorFormatter
   vamtoolbox.displaygrayscale.IndexTracker
   vamtoolbox.displaygrayscale.BodiesIndexTracker
   vamtoolbox.displaygrayscale.VolumeSlicer
   vamtoolbox.displaygrayscale.SlicePlot
   vamtoolbox.displaygrayscale.ErrorPlot
   vamtoolbox.displaygrayscale.MultiErrorPlot
   vamtoolbox.displaygrayscale.HistogramPlot
   vamtoolbox.displaygrayscale.EvolvingPlot
   vamtoolbox.displaygrayscale.EvolvingPlotDemo



Functions
~~~~~~~~~

.. autoapisummary::

   vamtoolbox.displaygrayscale.showVolumeSlicer
   vamtoolbox.displaygrayscale.showSinoSlicer
   vamtoolbox.displaygrayscale.showErrorPlot
   vamtoolbox.displaygrayscale.showHistogramPlot
   vamtoolbox.displaygrayscale.errorTolerancePlot
   vamtoolbox.displaygrayscale.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, title=None, vmin=0, vmax=1, **kwargs)


   .. py:method:: update(vol)



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


   .. py:method:: update(error)



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


.. py:class:: MultiErrorPlot(*args, ax=None, fig=None, title=None, xlabel=None, ylabel=None, legends=None, normalization_flags=False, log_y=False)


   .. py:method:: update(*args)



.. py:class:: HistogramPlot(x, target, scale='linear', ax=None, fig=None, title=None, xlabel=None, ylabel=None, vmin=0, vmax=1, n_bins=100, target_binary=True)


   .. 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, save_img_path=None, vmin=0, vmax=1)


   .. py:method:: update(loss, dose=None, mapped=None, norms_list=None)


   .. py:method:: ioff()



.. py:class:: EvolvingPlotDemo(target_geo, n_iter, save_img_path=None)


   This is a concise form of Evolving Plot for demonstration purposes.

   .. py:method:: update(loss, dose=None, mapped=None)


   .. py:method:: ioff()



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


.. py:function:: saveFigure(savepath)