Skip to content

Commit 2023283

Browse files
lucywowenlucywowen
committed
update to brain object tutorial
1 parent 33f4997 commit 2023283

File tree

11 files changed

+113
-113
lines changed

11 files changed

+113
-113
lines changed

‎docs/auto_examples/auto_examples_jupyter.zip‎

0 Bytes
Binary file not shown.

‎docs/auto_examples/auto_examples_python.zip‎

0 Bytes
Binary file not shown.

‎docs/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@
6767
# built documents.
6868
#
6969
# The short X.Y version.
70-
version = u'0.1'
70+
version = u'0.2'
7171
# The full version, including alpha/beta/rc tags.
72-
release = u'0.1.0'
72+
release = u'0.2.0'
7373

7474
# The language for content autogenerated by Sphinx. Refer to documentation
7575
# for a list of supported languages.

‎docs/tutorial/brain_objects.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@
429429
"cell_type": "markdown",
430430
"metadata": {},
431431
"source": [
432-
"## `bo.get_filtered_bo()`\n",
432+
"## `bo.apply_filter()`\n",
433433
"This method will return a filtered copy of the brain object. "
434434
]
435435
},
@@ -441,7 +441,7 @@
441441
},
442442
"outputs": [],
443443
"source": [
444-
"bo_f = bo.get_filtered_bo()"
444+
"bo_f = bo.apply_filter()"
445445
]
446446
},
447447
{

‎docs/tutorial/brain_objects.rst‎

Lines changed: 102 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,16 @@ We’ll also simulate some electrode locations
5858
.. parsed-literal::
5959
6060
x y z
61-
0 -46 -50 -24
62-
1 -44 -13 13
63-
2 -34 -19 43
64-
3 -32 11 -49
65-
4 -25 47 -1
66-
5 -9 -10 -21
67-
6 1 43 2
68-
7 14 47 4
69-
8 19 -15 -44
70-
9 22 -12 10
61+
0 -31 1 -18
62+
1 -26 34 -24
63+
2 -11 9 -12
64+
3 -9 -8 -28
65+
4 6 38 -41
66+
5 10 -42 -3
67+
6 29 47 36
68+
7 32 3 -42
69+
8 41 -18 -16
70+
9 47 -34 32
7171
7272
7373
Creating a brain object
@@ -94,7 +94,7 @@ To view a summary of the contents of the brain object, you can call the
9494
Recording time in seconds: [10.]
9595
Sample Rate in Hz: [100]
9696
Number of sessions: 1
97-
Date created: Fri Jul 27 11:44:41 2018
97+
Date created: Fri Jul 27 16:19:15 2018
9898
Meta data: {}
9999
100100
@@ -115,7 +115,7 @@ each session. For example:
115115
Recording time in seconds: [0.5 0.5]
116116
Sample Rate in Hz: [1000, 1000]
117117
Number of sessions: 2
118-
Date created: Fri Jul 27 11:44:41 2018
118+
Date created: Fri Jul 27 16:19:15 2018
119119
Meta data: {}
120120
121121
@@ -140,7 +140,7 @@ want:
140140
Recording time in seconds: [0.5 0.5]
141141
Sample Rate in Hz: [1000, 1000]
142142
Number of sessions: 2
143-
Date created: Fri Jul 27 11:44:41 2018
143+
Date created: Fri Jul 27 16:19:15 2018
144144
Meta data: {'Hospital': 'DHMC', 'subjectID': '123', 'Investigator': 'Andy'}
145145
146146
@@ -225,68 +225,68 @@ that can be accessed with the ``get_data`` function:
225225
<tbody>
226226
<tr>
227227
<th>0</th>
228-
<td>-0.393679</td>
229-
<td>-0.602264</td>
230-
<td>-0.606419</td>
231-
<td>0.259346</td>
232-
<td>-0.137756</td>
233-
<td>-0.290842</td>
234-
<td>0.547445</td>
235-
<td>-0.236559</td>
236-
<td>-0.747291</td>
237-
<td>-0.216688</td>
228+
<td>0.209741</td>
229+
<td>-0.512392</td>
230+
<td>-0.720984</td>
231+
<td>-0.754342</td>
232+
<td>-1.726174</td>
233+
<td>-0.443516</td>
234+
<td>-1.782753</td>
235+
<td>-0.713155</td>
236+
<td>-0.284680</td>
237+
<td>-0.068902</td>
238238
</tr>
239239
<tr>
240240
<th>1</th>
241-
<td>-0.038067</td>
242-
<td>0.359819</td>
243-
<td>-0.086644</td>
244-
<td>0.252046</td>
245-
<td>0.214539</td>
246-
<td>0.272375</td>
247-
<td>0.591024</td>
248-
<td>0.182487</td>
249-
<td>-0.357187</td>
250-
<td>-0.134848</td>
241+
<td>-1.055684</td>
242+
<td>-0.810194</td>
243+
<td>-0.673013</td>
244+
<td>0.483223</td>
245+
<td>0.008181</td>
246+
<td>-0.190715</td>
247+
<td>2.239795</td>
248+
<td>-0.028814</td>
249+
<td>-0.301845</td>
250+
<td>-1.022902</td>
251251
</tr>
252252
<tr>
253253
<th>2</th>
254-
<td>0.316312</td>
255-
<td>0.402750</td>
256-
<td>0.414525</td>
257-
<td>-0.451867</td>
258-
<td>-0.653271</td>
259-
<td>0.074430</td>
260-
<td>-0.413303</td>
261-
<td>-0.240082</td>
262-
<td>-0.339771</td>
263-
<td>0.061560</td>
254+
<td>-0.346641</td>
255+
<td>-0.239482</td>
256+
<td>-0.370357</td>
257+
<td>0.246060</td>
258+
<td>-0.578913</td>
259+
<td>-0.565974</td>
260+
<td>-0.946681</td>
261+
<td>-0.358038</td>
262+
<td>-0.616623</td>
263+
<td>-0.124095</td>
264264
</tr>
265265
<tr>
266266
<th>3</th>
267-
<td>0.918641</td>
268-
<td>0.226016</td>
269-
<td>0.331112</td>
270-
<td>-0.539660</td>
271-
<td>0.175295</td>
272-
<td>-0.217791</td>
273-
<td>-1.025472</td>
274-
<td>-0.758906</td>
275-
<td>-0.104656</td>
276-
<td>-0.181594</td>
267+
<td>-0.610393</td>
268+
<td>0.130029</td>
269+
<td>-0.152837</td>
270+
<td>-1.142612</td>
271+
<td>-1.017601</td>
272+
<td>-0.409920</td>
273+
<td>-1.533653</td>
274+
<td>-0.806856</td>
275+
<td>-0.701596</td>
276+
<td>-0.249572</td>
277277
</tr>
278278
<tr>
279279
<th>4</th>
280-
<td>0.915811</td>
281-
<td>0.488035</td>
282-
<td>1.191160</td>
283-
<td>-0.248738</td>
284-
<td>0.517692</td>
285-
<td>0.573313</td>
286-
<td>0.434796</td>
287-
<td>-0.023618</td>
288-
<td>0.551721</td>
289-
<td>0.499770</td>
280+
<td>0.290803</td>
281+
<td>0.699244</td>
282+
<td>0.240235</td>
283+
<td>1.122073</td>
284+
<td>0.716814</td>
285+
<td>0.532778</td>
286+
<td>0.992918</td>
287+
<td>1.079572</td>
288+
<td>0.397130</td>
289+
<td>-0.019875</td>
290290
</tr>
291291
</tbody>
292292
</table>
@@ -332,33 +332,33 @@ can be retrieved using the ``get_locs`` method:
332332
<tbody>
333333
<tr>
334334
<th>0</th>
335-
<td>-46</td>
336-
<td>-50</td>
337-
<td>-24</td>
335+
<td>-31</td>
336+
<td>1</td>
337+
<td>-18</td>
338338
</tr>
339339
<tr>
340340
<th>1</th>
341-
<td>-44</td>
342-
<td>-13</td>
343-
<td>13</td>
341+
<td>-26</td>
342+
<td>34</td>
343+
<td>-24</td>
344344
</tr>
345345
<tr>
346346
<th>2</th>
347-
<td>-34</td>
348-
<td>-19</td>
349-
<td>43</td>
347+
<td>-11</td>
348+
<td>9</td>
349+
<td>-12</td>
350350
</tr>
351351
<tr>
352352
<th>3</th>
353-
<td>-32</td>
354-
<td>11</td>
355-
<td>-49</td>
353+
<td>-9</td>
354+
<td>-8</td>
355+
<td>-28</td>
356356
</tr>
357357
<tr>
358358
<th>4</th>
359-
<td>-25</td>
360-
<td>47</td>
361-
<td>-1</td>
359+
<td>6</td>
360+
<td>38</td>
361+
<td>-41</td>
362362
</tr>
363363
</tbody>
364364
</table>
@@ -411,21 +411,21 @@ Brain objects are iterable, so you index a brain object like this:
411411
<tbody>
412412
<tr>
413413
<th>0</th>
414-
<td>-0.393679</td>
415-
<td>-0.602264</td>
416-
<td>-0.606419</td>
414+
<td>0.209741</td>
415+
<td>-0.512392</td>
416+
<td>-0.720984</td>
417417
</tr>
418418
<tr>
419419
<th>1</th>
420-
<td>-0.038067</td>
421-
<td>0.359819</td>
422-
<td>-0.086644</td>
420+
<td>-1.055684</td>
421+
<td>-0.810194</td>
422+
<td>-0.673013</td>
423423
</tr>
424424
<tr>
425425
<th>2</th>
426-
<td>0.316312</td>
427-
<td>0.402750</td>
428-
<td>0.414525</td>
426+
<td>-0.346641</td>
427+
<td>-0.239482</td>
428+
<td>-0.370357</td>
429429
</tr>
430430
</tbody>
431431
</table>
@@ -473,21 +473,21 @@ the brain object.
473473
<tbody>
474474
<tr>
475475
<th>0</th>
476-
<td>-0.393679</td>
477-
<td>-0.602264</td>
478-
<td>-0.606419</td>
476+
<td>0.209741</td>
477+
<td>-0.512392</td>
478+
<td>-0.720984</td>
479479
</tr>
480480
<tr>
481481
<th>1</th>
482-
<td>-0.038067</td>
483-
<td>0.359819</td>
484-
<td>-0.086644</td>
482+
<td>-1.055684</td>
483+
<td>-0.810194</td>
484+
<td>-0.673013</td>
485485
</tr>
486486
<tr>
487487
<th>2</th>
488-
<td>0.316312</td>
489-
<td>0.402750</td>
490-
<td>0.414525</td>
488+
<td>-0.346641</td>
489+
<td>-0.239482</td>
490+
<td>-0.370357</td>
491491
</tr>
492492
</tbody>
493493
</table>
@@ -509,7 +509,7 @@ You can resample your data by specifying a new sample rate
509509
Recording time in seconds: [0.5 0.5]
510510
Sample Rate in Hz: [64, 64]
511511
Number of sessions: 2
512-
Date created: Fri Jul 27 11:44:41 2018
512+
Date created: Fri Jul 27 16:19:15 2018
513513
Meta data: {'Hospital': 'DHMC', 'subjectID': '123', 'Investigator': 'Andy'}
514514
515515
@@ -585,18 +585,18 @@ This method will give you a summary of the brain object:
585585
Recording time in seconds: [0.5 0.5]
586586
Sample Rate in Hz: [64, 64]
587587
Number of sessions: 2
588-
Date created: Fri Jul 27 11:44:41 2018
588+
Date created: Fri Jul 27 16:19:15 2018
589589
Meta data: {'Hospital': 'DHMC', 'subjectID': '123', 'Investigator': 'Andy'}
590590
591591
592-
``bo.get_filtered_bo()``
593-
------------------------
592+
``bo.apply_filter()``
593+
---------------------
594594

595595
This method will return a filtered copy of the brain object.
596596

597597
.. code:: ipython2
598598
599-
bo_f = bo.get_filtered_bo()
599+
bo_f = bo.apply_filter()
600600
601601
``bo.get_data()``
602602
-----------------
@@ -648,7 +648,7 @@ This method allows you resample a brain object in place.
648648
649649
.. parsed-literal::
650650
651-
<supereeg.brain.Brain at 0x117efe510>
651+
<supereeg.brain.Brain at 0x116c298d0>
652652
653653
654654

‎docs/tutorial/brain_objects_files/brain_objects_32_0.png‎

-62 Bytes
Loading

‎docs/tutorial/brain_objects_files/brain_objects_33_0.png‎

184 Bytes
Loading

‎docs/tutorial/brain_objects_files/brain_objects_4_0.png‎

-238 Bytes
Loading

‎docs/tutorial/brain_objects_files/brain_objects_52_0.png‎

-62 Bytes
Loading

‎docs/tutorial/brain_objects_files/brain_objects_57_0.png‎

122 Bytes
Loading

0 commit comments

Comments
 (0)