Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathpython_reference.html
More file actions
Latest commit
165 lines (157 loc) · 8.29 KB
/
Copy pathpython_reference.html
File metadata and controls
165 lines (157 loc) · 8.29 KB
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>
<htmlxmlns="http://www.w3.org/1999/xhtml">
<head>
<metacharset="utf-8" />
<title>PySurfer Python Neuroimaging Visualization — PySurfer 0.10.0 documentation</title>
<linkrel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<linkrel="stylesheet" href="_static/pygments.css" type="text/css" />
<linkrel="stylesheet" type="text/css" href="_static/gallery.css" />
<linkrel="stylesheet" type="text/css" href="_static/gallery-binder.css" />
<linkrel="stylesheet" type="text/css" href="_static/gallery-dataframe.css" />
<scripttype="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<scripttype="text/javascript" src="_static/jquery.js"></script>
<scripttype="text/javascript" src="_static/underscore.js"></script>
<scripttype="text/javascript" src="_static/doctools.js"></script>
<scripttype="text/javascript" src="_static/language_data.js"></script>
<linkrel="shortcut icon" href="_static/favicon.ico"/>
<linkrel="index" title="Index" href="genindex.html" />
<linkrel="search" title="Search" href="search.html" />
<linkrel="next" title="surfer.Brain" href="generated/surfer.Brain.html" />
<linkrel="prev" title="Working with a split-screen brain" href="documentation/split_brain.html" />
<linkrel="stylesheet" href="_static/navy.css " type="text/css" />
</head><body>
<divstyle="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<ahref="index.html">
<imgsrc="_static/banner.png" alt="PySurfer logo" height=180pxwidth=600pxborder="0" />
</div>
<divclass="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<liclass="right" style="margin-right: 10px">
<ahref="genindex.html" title="General Index"
accesskey="I">index</a></li>
<liclass="right" >
<ahref="generated/surfer.Brain.html" title="surfer.Brain"
accesskey="N">next</a> |</li>
<liclass="right" >
<ahref="documentation/split_brain.html" title="Working with a split-screen brain"
accesskey="P">previous</a> |</li>
<liclass="nav-item nav-item-0"><ahref="index.html">PySurfer 0.10.0 documentation</a> »</li>
</ul>
</div>
<divclass="sphinxsidebar" role="navigation" aria-label="main navigation">
<divclass="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<pclass="topless"><ahref="documentation/split_brain.html"
title="previous chapter">Working with a split-screen brain</a></p>
<h4>Next topic</h4>
<pclass="topless"><ahref="generated/surfer.Brain.html"
title="next chapter">surfer.Brain</a></p>
<divid="searchbox" style="display: none" role="search">
<h3id="searchlabel">Quick search</h3>
<divclass="searchformwrapper">
<formclass="search" action="search.html" method="get">
<inputtype="text" name="q" aria-labelledby="searchlabel" />
<inputtype="submit" value="Go" />
</form>
</div>
</div>
<scripttype="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<divclass="document">
<divclass="documentwrapper">
<divclass="bodywrapper">
<divclass="body" role="main">
<divclass="section" id="python-api-reference">
<spanid="api-reference"></span><h1>Python API Reference<aclass="headerlink" href="#python-api-reference" title="Permalink to this headline">¶</a></h1>
<p>This is the reference for classes (<codeclass="docutils literal notranslate"><spanclass="pre">CamelCase</span></code> names) and functions
(<codeclass="docutils literal notranslate"><spanclass="pre">underscore_case</span></code> names) of PySurfer.</p>
<p><aclass="reference internal" href="#module-surfer" title="surfer"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">surfer</span></code></a>:</p>
<spanclass="target" id="module-surfer"></span><tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="generated/surfer.Brain.html#surfer.Brain" title="surfer.Brain"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="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>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="generated/surfer.TimeViewer.html#surfer.TimeViewer" title="surfer.TimeViewer"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">TimeViewer</span></code></a>(brain)</p></td>
<td><p>TimeViewer object providing a GUI for visualizing time series</p></td>
</tr>
</tbody>
</table>
<tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="generated/surfer.project_volume_data.html#surfer.project_volume_data" title="surfer.project_volume_data"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="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><aclass="reference internal" href="#module-surfer.io" title="surfer.io"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">surfer.io</span></code></a>:</p>
<spanclass="target" id="module-surfer.io"></span><tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="generated/surfer.io.read_scalar_data.html#surfer.io.read_scalar_data" title="surfer.io.read_scalar_data"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="pre">read_scalar_data</span></code></a>(filepath)</p></td>
<td><p>Load in scalar data from an image.</p></td>
</tr>
<trclass="row-even"><td><p><aclass="reference internal" href="generated/surfer.io.read_stc.html#surfer.io.read_stc" title="surfer.io.read_stc"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="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><aclass="reference internal" href="#module-surfer.utils" title="surfer.utils"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">surfer.utils</span></code></a>:</p>
<spanclass="target" id="module-surfer.utils"></span><tableclass="longtable docutils align-default">
<colgroup>
<colstyle="width: 10%" />
<colstyle="width: 90%" />
</colgroup>
<tbody>
<trclass="row-odd"><td><p><aclass="reference internal" href="generated/surfer.utils.coord_to_label.html#surfer.utils.coord_to_label" title="surfer.utils.coord_to_label"><codeclass="xref py py-obj docutils literal notranslate"><spanclass="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>
<divclass="clearer"></div>
</div>
<divclass="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<liclass="right" style="margin-right: 10px">
<ahref="genindex.html" title="General Index"
>index</a></li>
<liclass="right" >
<ahref="generated/surfer.Brain.html" title="surfer.Brain"
>next</a> |</li>
<liclass="right" >
<ahref="documentation/split_brain.html" title="Working with a split-screen brain"
>previous</a> |</li>
<liclass="nav-item nav-item-0"><ahref="index.html">PySurfer 0.10.0 documentation</a> »</li>
</ul>
</div>
<divclass="footer" role="contentinfo">
© Copyright 2012-2020, Michael Waskom, Alexandre Gramfort, Scott Burns, Martin Luessi, Eric Larson.
Created using <ahref="http://sphinx-doc.org/">Sphinx</a> 3.0.0+/4499fda.
</div>
</body>
</html>