trx.viz
=======

.. py:module:: trx.viz

.. autoapi-nested-parse::

   Optional 3D visualization using FURY/VTK.

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   trx.viz.fury_available


Functions
---------

.. autoapisummary::

   trx.viz.display


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

.. py:data:: fury_available
   :value: True


.. py:function:: display(volume, volume_affine=None, streamlines=None, title='FURY', display_bounds=True)

   
   Display a volume with optional streamlines using fury.


   :Parameters:

       **volume** : np.ndarray
           3D volume to display.

       **volume_affine** : np.ndarray or None, optional
           Affine matrix for the volume; None assumes identity.

       **streamlines** : sequence or None, optional
           Streamlines to render as lines.

       **title** : str, optional
           Window title.

       **display_bounds** : bool, optional
           If True, draw bounding box and coordinate annotations.



   :Returns:

       None
           Opens an interactive visualization window when fury is available.











   ..
       !! processed by numpydoc !!