-
Notifications
You must be signed in to change notification settings - Fork 1
/
python_reference.html
165 lines (157 loc) · 8.29 KB
/
python_reference.html
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>PySurfer Python Neuroimaging Visualization — PySurfer 0.10.0 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="surfer.Brain" href="generated/surfer.Brain.html" />
<link rel="prev" title="Working with a split-screen brain" href="documentation/split_brain.html" />
<link rel="stylesheet" href="_static/navy.css " type="text/css" />
</head><body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="index.html">
<img src="_static/banner.png" alt="PySurfer logo" height=180px width=600px border="0" />
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="generated/surfer.Brain.html" title="surfer.Brain"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="documentation/split_brain.html" title="Working with a split-screen brain"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PySurfer 0.10.0 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="documentation/split_brain.html"
title="previous chapter">Working with a split-screen brain</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="generated/surfer.Brain.html"
title="next chapter">surfer.Brain</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="python-api-reference">
<span id="api-reference"></span><h1>Python API Reference<a class="headerlink" href="#python-api-reference" title="Permalink to this headline">¶</a></h1>
<p>This is the reference for classes (<code class="docutils literal notranslate"><span class="pre">CamelCase</span></code> names) and functions
(<code class="docutils literal notranslate"><span class="pre">underscore_case</span></code> names) of PySurfer.</p>
<p><a class="reference internal" href="#module-surfer" title="surfer"><code class="xref py py-mod docutils literal notranslate"><span class="pre">surfer</span></code></a>:</p>
<span class="target" id="module-surfer"></span><table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/surfer.Brain.html#surfer.Brain" title="surfer.Brain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Brain</span></code></a>(subject_id, hemi, surf[, title, …])</p></td>
<td><p>Class for visualizing a brain using multiple views in mlab</p></td>
</tr>
</tbody>
</table>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/surfer.TimeViewer.html#surfer.TimeViewer" title="surfer.TimeViewer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TimeViewer</span></code></a>(brain)</p></td>
<td><p>TimeViewer object providing a GUI for visualizing time series</p></td>
</tr>
</tbody>
</table>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/surfer.project_volume_data.html#surfer.project_volume_data" title="surfer.project_volume_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">project_volume_data</span></code></a>(filepath, hemi[, …])</p></td>
<td><p>Sample MRI volume onto cortical manifold.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="#module-surfer.io" title="surfer.io"><code class="xref py py-mod docutils literal notranslate"><span class="pre">surfer.io</span></code></a>:</p>
<span class="target" id="module-surfer.io"></span><table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/surfer.io.read_scalar_data.html#surfer.io.read_scalar_data" title="surfer.io.read_scalar_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_scalar_data</span></code></a>(filepath)</p></td>
<td><p>Load in scalar data from an image.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/surfer.io.read_stc.html#surfer.io.read_stc" title="surfer.io.read_stc"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_stc</span></code></a>(filepath)</p></td>
<td><p>Read an STC file from the MNE package</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="#module-surfer.utils" title="surfer.utils"><code class="xref py py-mod docutils literal notranslate"><span class="pre">surfer.utils</span></code></a>:</p>
<span class="target" id="module-surfer.utils"></span><table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/surfer.utils.coord_to_label.html#surfer.utils.coord_to_label" title="surfer.utils.coord_to_label"><code class="xref py py-obj docutils literal notranslate"><span class="pre">coord_to_label</span></code></a>(subject_id, coord, label[, …])</p></td>
<td><p>Create label from MNI coordinate</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="generated/surfer.Brain.html" title="surfer.Brain"
>next</a> |</li>
<li class="right" >
<a href="documentation/split_brain.html" title="Working with a split-screen brain"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">PySurfer 0.10.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012-2020, Michael Waskom, Alexandre Gramfort, Scott Burns, Martin Luessi, Eric Larson.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.0+/4499fda.
</div>
</body>
</html>