:orphan:

.. _api_reference:

====================
Python API Reference
====================

This is the reference for classes (``CamelCase`` names) and functions
(``underscore_case`` names) of PySurfer.

:py:mod:`surfer`:

.. currentmodule:: surfer

.. automodule:: surfer
   :no-members:
   :no-inherited-members:

.. autosummary::
   :toctree: generated/
   :template: class.rst

   Brain

.. autosummary::
   :toctree: generated/
   :template: class_noinherited.rst

   TimeViewer

.. autosummary::
   :toctree: generated/
   :template: function.rst

   project_volume_data

:py:mod:`surfer.io`:

.. currentmodule:: surfer.io

.. automodule:: surfer.io
   :no-members:
   :no-inherited-members:

.. autosummary::
   :toctree: generated/
   :template: function.rst

   read_scalar_data
   read_stc

:py:mod:`surfer.utils`:

.. currentmodule:: surfer.utils

.. automodule:: surfer.utils
   :no-members:
   :no-inherited-members:

.. autosummary::
   :toctree: generated/
   :template: function.rst

   coord_to_label
