This repository has been archived by the owner on Sep 16, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.html
382 lines (163 loc) · 11.6 KB
/
index.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
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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Introduction · GitBook</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-navigator/plugin.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="01-overview/gallery.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Overview</li>
<li class="chapter active" data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="01-overview/gallery.html">
<a href="01-overview/gallery.html">
gallery
</a>
</li>
<li class="chapter " data-level="1.3" data-path="01-overview/examples.html">
<a href="01-overview/examples.html">
code examples
</a>
</li>
<li class="header">Installation</li>
<li class="chapter " data-level="2.1" data-path="02-installation/installation.html">
<a href="02-installation/installation.html">
installing brainrender
</a>
</li>
<li class="header">Usage</li>
<li class="chapter " data-level="3.1" data-path="03-usage/overview.html">
<a href="03-usage/overview.html">
overview
</a>
</li>
<li class="chapter " data-level="3.2" data-path="03-usage/atlas.html">
<a href="03-usage/atlas.html">
the Atlas class
</a>
</li>
<li class="chapter " data-level="3.3" data-path="03-usage/scene.html">
<a href="03-usage/scene.html">
the Scene class
</a>
</li>
<li class="divider"></li>
<li class="chapter " data-level="4.1" data-path="03-usage/public.html">
<a href="03-usage/public.html">
publicly available datasets
</a>
</li>
<li class="chapter " data-level="4.2" data-path="03-usage/user.html">
<a href="03-usage/user.html">
user-generated data
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Introduction</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="brainrender-docs">brainrender-docs</h1>
<p>
<img style="width:100%; maring:0px; padding:0px; background-color:rgb(240, 240, 240); border-radius:12px" src="data/overview/aba.png">
</p>
<hr>
<p>  </p>
<h2 id="Welcome_to_the_brainrender_docs">1. Welcome to the brainrender docs</h2>
<p style="background-color:rgb(240, 240, 240); padding:8px; border-radius:8px;">
brainrender is a python package for the visualization of three dimensional neuroanatomical data.
It can be used to render data from publicly available dataset (e.g. Allen Brain atlas) as well as user generated experimental data.
The goal of brainrender is to faciliate the exploration and dissemination of neuroanatomical data by providing a user-friendly platform to create high-quality 3D renderings.
</p>
<p>  </p>
<p>When developing <code>brainrender</code> we aimed to create a flexible and easy-to-use tool for the neuroscience community to use for all their rendering needs. </p>
<p>For this reason:</p>
<ul>
<li>we've build upon (brainglobe)[linkmissing]'s atlas API, ensuring that you can use <code>brainrender</code> to visualise data from a wide range of species. </li>
<li>we've created a simple and intuitive interface to download and render data from publicly available datasets like the Allen Mouse Connectome and Janelia's Mouse Light projects.</li>
<li>we've built a ton of functionality into <code>brainrender</code> to ensure that we can cover all of your visualisation needs. If we missed something, and you'd like to see a new feature added, get in touch on <a href="https://github.com/BrancoLab/BrainRender" target="_blank">github</a>!</li>
<li>we're using <code>vedo</code>, a powerful <code>vtk</code>-based rendering package in python. <code>vedo</code>'s flexibility ensures that you can render in brainrender any 3d object you can put into a <code>.obj</code> or <code>.stl</code> file. It's therefore easier than ever to add your custom experimental implant to the renderings. </li>
</ul>
<!-- `brainrender` can be used to create:
* [beautiful]() renderings of neuroanatomical data
* <a href='01-overview/regions.html' target='_blank'> interactive </a> 3d renderings to quickly share your data with collaborators and colleagues.
* videos and animations to showcase the intricate details of the neuroanatomy of you --><div id="anchors-navbar"><i class="fa fa-anchor"></i><ul><p><a href="#brainrender-docs">brainrender-docs</a></p><li><a href="#Welcome_to_the_brainrender_docs">1. Welcome to the brainrender docs</a></li></ul></div><a href="#Welcome_to_the_brainrender_docs" id="goTop"><i class="fa fa-arrow-up"></i></a>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="01-overview/gallery.html" class="navigation navigation-next navigation-unique" aria-label="Next page: gallery">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"next":{"title":"gallery","level":"1.2","depth":1,"path":"01-overview/gallery.md","ref":"01-overview/gallery.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["navigator"],"pluginsConfig":{"navigator":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"README.md","mtime":"2020-07-01T21:21:09.194Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2020-07-01T22:13:07.663Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>