Image Visualization
===================

.. py:module:: petpal.visualizations.image_visualization

.. autoapi-nested-parse::

   Provides a class for creating a GIF from a NIfTI image which iterates through its slices based
   on a specified view ('coronal', 'sagittal', or 'axial').

   Classes defined in the module:
       * :class:`NiftiGifCreator`: This class creates a GIF from a NIfTI image by iterating through its slices based on
         a specified view ('coronal', 'sagittal', or 'axial'). The GIF is then written to the
         specified output directory with a filename prefix specified by the user.

   .. todo::

      * Add functionality to quickly generate slices of images.
      * Add flexibility in :class:`NiftiGifCreator` to accept a NumPy array or a file-path. This could also be added
        to the image slice class.




Attributes
----------

.. autoapisummary::

   petpal.visualizations.image_visualization.nifty_loader


Classes
-------

.. toctree::
   :hidden:

   /autoapi/petpal/visualizations/image_visualization/NiftiGifCreator

.. autoapisummary::

   petpal.visualizations.image_visualization.NiftiGifCreator


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

.. py:data:: nifty_loader