File: python_reference.rst

package info (click to toggle)
pysurfer 0.11.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 16,352 kB
  • sloc: python: 4,786; makefile: 141; sh: 10
file content (65 lines) | stat: -rw-r--r-- 1,020 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
: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