.. currentmodule:: nifti_overlay

API Documentation
=================

Documentation reference for available functions in nifti_overlay.

The most important part here is the `NiftiOverlay`_ section, which documents
the :class:`nifti_overlay.core.NiftiOverlay` object.  This is the tool
which can be used for creating visualizations from a Python session,
and it is what is ultimately called in the command line interface.

NiftiOverlay
------------
.. automodule:: nifti_overlay.core

Image Objects
-------------

Single Images
^^^^^^^^^^^^^

.. automodule:: nifti_overlay.image

Multiple Images
^^^^^^^^^^^^^^^

.. automodule:: nifti_overlay.multiimage