-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathQUICKSTART.html
More file actions
284 lines (170 loc) · 11.7 KB
/
QUICKSTART.html
File metadata and controls
284 lines (170 loc) · 11.7 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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Getting started — brainsprite documentation</title>
<link rel="shortcut icon" href="_static/logo_brainsprite_small.png"/>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery-dataframe.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Tutorials" href="auto_examples/index.html" />
<link rel="prev" title="Installation" href="INSTALL.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> brainsprite
<img src="_static/logo_brainsprite.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="INSTALL.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#why-brainsprite">Why brainsprite?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#html-code">HTML code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#javascript-code">Javascript code</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-code">Python code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIJS.html">API Javascript</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIPY.html">API Python</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">brainsprite</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Getting started</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/QUICKSTART.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<div class="section" id="why-brainsprite">
<h2>Why brainsprite?<a class="headerlink" href="#why-brainsprite" title="Permalink to this headline">¶</a></h2>
<p>Brainsprite viewers are designed to be elements on a web dashboard: they load fast,
and can easily be interfaced with other interactive elements.
The brainsprite javascript library is thus as small and fast as possible, while
the heavy lifting of data preparation is done through a python library.</p>
</div>
<div class="section" id="html-code">
<h2>HTML code<a class="headerlink" href="#html-code" title="Permalink to this headline">¶</a></h2>
<p><img alt="_images/sprite_small.jpg" src="_images/sprite_small.jpg" /></p>
<p>Brainsprite works from a sprite image (also known as a mosaic) such as the one
above.The first thing to do is to add a div in an html document with an empty
canvas (which will be populated with the viewer) as well as the sprite image,
which is hidden:</p>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">div</span><span class="p">></span>
<span class="p"><</span><span class="nt">canvas</span> <span class="na">id</span><span class="o">=</span><span class="s">"3Dviewer"</span><span class="p">></span>
<span class="p"><</span><span class="nt">img</span> <span class="na">id</span><span class="o">=</span><span class="s">"spriteImg"</span> <span class="na">class</span><span class="o">=</span><span class="s">"hidden"</span> <span class="na">src</span><span class="o">=</span><span class="s">"sprite.jpg"</span><span class="p">></span>
<span class="p"></</span><span class="nt">div</span><span class="p">></span>
</pre></div>
</div>
</div>
<div class="section" id="javascript-code">
<h2>Javascript code<a class="headerlink" href="#javascript-code" title="Permalink to this headline">¶</a></h2>
<p>Then you include the brainsprite minified library (and jquery for the
<code class="docutils literal notranslate"><span class="pre">$(</span> <span class="pre">window</span> <span class="pre">).load(function()</span></code> instruction below, although brainsprite itself
does not use jquery):</p>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span><span class="p"><</span><span class="nt">script</span> <span class="na">type</span><span class="o">=</span><span class="s">"text/javascript"</span> <span class="na">src</span><span class="o">=</span><span class="s">"https://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
<span class="p"><</span><span class="nt">script</span> <span class="na">type</span><span class="o">=</span><span class="s">"text/javascript"</span> <span class="na">src</span><span class="o">=</span><span class="s">"brainsprite.min.js"</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
</pre></div>
</div>
<p>Finally, once the page is loaded, brainsprite is called to create a
<code class="docutils literal notranslate"><span class="pre">brain</span></code> object. The parameters brainsprite are used to tweak the appearance of
the viewer, as well as specify important meta-data which cannot be infered from
the sprite, such as the size of each slice (in pixel):</p>
<div class="highlight-html notranslate"><div class="highlight"><pre><span></span> <span class="p"><</span><span class="nt">script</span><span class="p">></span>
<span class="nx">$</span><span class="p">(</span> <span class="nb">window</span> <span class="p">).</span><span class="nx">load</span><span class="p">(</span><span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nx">brain</span> <span class="o">=</span> <span class="nx">brainsprite</span><span class="p">({</span>
<span class="nx">canvas</span><span class="o">:</span> <span class="s2">"3Dviewer"</span><span class="p">,</span>
<span class="nx">sprite</span><span class="o">:</span> <span class="s2">"spriteImg"</span><span class="p">,</span>
<span class="nx">nbSlice</span><span class="o">:</span> <span class="p">{</span> <span class="s1">'Y'</span><span class="o">:</span><span class="mi">233</span> <span class="p">,</span> <span class="s1">'Z'</span><span class="o">:</span><span class="mi">189</span> <span class="p">}</span>
<span class="p">});</span>
<span class="p">});</span>
<span class="p"></</span><span class="nt">script</span><span class="p">></span>
</pre></div>
</div>
<p>Other important parameters are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">canvas</span></code>: the ID of the canvas where the brain slices will be added;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sprite</span></code>: the ID of the sprite image;</p></li>
</ul>
<p>The call to <code class="docutils literal notranslate"><span class="pre">brainsprite</span></code> will automatically generate a brain viewer, just like
this one:</p>
<iframe src="_static/example_basic.html" width=500 height=200 style="padding:0; border:0; display: block; margin-left: auto; margin-right: auto"></iframe></div>
<div class="section" id="python-code">
<h2>Python code<a class="headerlink" href="#python-code" title="Permalink to this headline">¶</a></h2>
<p>The brainsprite python library uses <a class="reference external" href="https://nilearn.github.io/">nilearn</a> in
order to generate the sprites, as well as the html and javascript code required
above. This code can be inserted into an html page template based on the
<a class="reference external" href="https://pypi.org/project/Tempita/">tempita</a> library. Altogether, adding a
brain viewer to a webpage only takes a few lines of python. Check the tutorials
to learn more about the syntax.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="auto_examples/index.html" class="btn btn-neutral float-right" title="Tutorials" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="INSTALL.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Brainsprite team
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>