-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathNIfTI_handling.html
259 lines (254 loc) · 12.7 KB
/
NIfTI_handling.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
cc<!DOCTYPE html>
<html>
<head>
<title>User manual</title>
<link rel="stylesheet" type="text/css" href="style.css">
<link rel="icon" href="imgs/logo.png">
</head>
<body>
<header class="w3-container w3-center w3-padding-32">
<div class="row">
<div class="column">
<img src="imgs/logo.png" style="width:8%">
</div>
<div class="column">
<h1><b>USER MANUAL</b></h1>
<p>Welcome to the user manual for the <span class="w3-tag">BrainMapper</span> software.</p>
</div>
</div>
</header>
<div class="row">
<div class="column-left">
<div class="w3-card w3-margin w3-margin-top">
<div id="toc_container">
<p class="toc_title">Contents - NIfTI Handling </p>
<a href="index.html" style="color : #5577ee"> Go back to home page </a>
<ul class="toc_list">
<li><a href="#set"><strong>2.1 Set</strong></a></li>
<ul>
<li><a href="#new_set">2.1.1 Create a new set</a></li>
<li><a href="#rename_set">2.1.2 Rename a set</a></li>
<li><a href="#sub_set">2.1.3 Add a sub set</a></li>
</ul>
<li><a href="#collection"><strong>2.2 Collection</strong></a></li>
<ul>
<li><a href="#new_collection">2.2.1 Create a new collection</a></li>
<ul>
<li><a href="#excel"><small>2.2.1.1 From an Excel file</small></a></li>
<li><a href="#nifti"><small>2.2.1.2 From a NIfTI file</small></a></li>
</ul>
<li><a href="#select">2.2.2 Select collections</a></li>
</ul>
<li><a href="#edit"><strong>2.3 Edit Collections</strong></a></li>
<ul>
<li><a href="#select_edit">2.3.1 Select collection to edit</a></li>
<li><a href="#rename_col">2.3.2 Rename a Collection</a></li>
<li><a href="#add_images">2.3.3 Add images</a></li>
<li><a href="#remove_images">2.3.4 Remove images</a></li>
<li><a href="#show">2.3.5 Show one image</a></li>
<li><a href="#del_col">2.3.6 Delete one collection</a></li>
</ul>
</ul>
</div>
</div>
</div>
<div class="column-right">
<h1> NIfTI Handling in BrainMapper</h1>
<h2 id="set">2.1 Set</h2>
<p>
When you launch the software, a set named with the current date is created. It will prevent name problems (when some sets have the same name).
</p>
<h3 id="new_set">2.1.1 Create a new set</h3>
<p>
To create a new set, you can use the shortcut "Ctrl+S" or click on the menu "New Set"/ "Create new set"
<img src="imgs/create_set.jpg" style="width:40%">
</p>
<div style="padding-left: 12%; padding-top:3%; padding-bottom:3%">
<div class="alert note-info" role="alert">
<h5 style="color:#306499;">NOTE</h5>
You cannot delete a set once its created. But you can rename it and change what it inside. You can also delete it manually when you export your workspace <a href="import_export.html#workspace">(see this page)</a>.
</div>
</div>
<h3 id="rename_set">2.2. Rename a set</h3>
<p>
Each set works the same way. You will see a little menu next to the name of your set. Click on the little pen logo to access to the rename pop up.
</p>
<p>
You will not be able to name two sets the same way. Furthermore, the software prevent you to add unauthorized symbols to the name of your set, such as : "/",";"...
</p>
<p>
<img src="imgs/rename_set.jpg" style="width:20%">
</p>
<h3 id="sub_set">2.3. Add a sub set</h3>
<p>
Each set can have an infinity of sub sets. It works exactly like a folder hierarchy. Each set, including the one that contains others, can contain some collections of images and data.
</p>
<p>
Each set (even if its a sub set)works the same way. You will see a little menu next to the name of your set. Click on the arrow logo to access to the sub set pop up.
</p>
<p>
You will not be able to name two sets the same way. Furthermore, the software prevent you to add unauthorized symbols to the name of your set, such as : "/",";"...
</p>
<p>
<img src="imgs/sub_set.jpg" style="width:20%">
</p>
<p>
<div style="padding-left: 12%; padding-top:3%; padding-bottom:3%">
<div class="alert note-info" role="alert">
<h5 style="color:#306499;">NOTE</h5>
You will see the list of a set's subsets by clicking on the little arrow logo on the right. If you click on the name of a set, the right side of the screen will change and show what is inside the set.
</div>
</div>
</p>
<h2 id="collection">3. Collection</h2>
<p>
When you launch the software, a set named with the current date is already created. That means, when you create a collection, it will be added to the current set (named with the current date in this case).
</p>
<p>
A collection is an object where we stock the data. Usually, the data are some images, that's why we will name the Collection object as an Image Collection.
</p>
<h3 id="new_collection">3.1. Create a new collection</h3>
<p>
There are two ways to create a collection : with an Excel file containing the points and some NIfTI files. These two options are available in the menu : "New Collection".
</p>
<p>
<img src="imgs/create_col.jpg" style="width:40%">
</p>
<p>
When you add a collection, it will be created and shown in the home page, related to its set.
</p>
<p>
<img src="imgs/col.jpg" style="width:40%">
</p>
<h4 id="excel">3.1.1. From an Excel file</h4>
<p>
The first line of the CSV contains the header of each column. These are :
<ul>
<li>File_Name_NIfTI : file name of the file associate to voxel. </li>
<li>Surgeon_ID : ID of the surgeon who make this file.</li>
<li>Patient_ID : ID of the patient.</li>
<li>Localisation : area of the brain.</li>
<li>Point_Name : voxel name.</li>
<li>Type_Of_Answer : brain fonctionnality associate to this voxel.</li>
<li>X : X coordinate.</li>
<li>Y : Y coordinate.</li>
<li>Z : Z coordinate.</li>
<li>Intensity : voxel intensity.</li>
</ul>
</p>
<div style="padding-left: 12%; padding-top:3%; padding-bottom:3%">
<div class="alert note-info" role="alert">
<h5 style="color:#306499;">NOTE</h5>
You can add a colllection with Excel files using the shortcut "Ctrl+E".
</div>
</div>
<h4 id="nifti">3.1.2. From a NIfTI file</h4>
<p>
If you choose to create a collection with some NIfTI files, you will have to select them with a file browser. Note that you will be able to select images only if they are all in the same folder. Also, you can add only one image if you need to.
</p>
<p>
<div style="padding-left: 12%; padding-top:3%; padding-bottom:3%">
<div class="alert note-info" role="alert">
<h5 style="color:#306499;">NOTE</h5>
You can add a colllection with NIfTI files using the shortcut "Ctrl+N".
</div>
</div>
</p>
<h3 id="select">3.2. Select collections</h3>
<p>
To work on your data using BrainMapper, you have to select the collections you want to work on. To do so, just click on the collection you want (the selected collections are ticked).
</p>
<p>
Note that you can select collections even if they are not in the same set!
</p>
<p>
<img src="imgs/selected.jpg" style="width:40%">
</p>
<p>
You can use the buttons "Select all" and "Deselect all" on the right side to select or deselect all the image collection you have in your current set. That will be usefull when you have a lot of image collections you (don't) want to use.
</p>
<p>
<img src="imgs/de-select.jpg" style="width:20%">
</p>
<p>
Also, there are the same buttons on the left (under the list of sets). This time, you can use them to select or deselect all the image collection from all the sets. That will be usefull when you want to clean your selection or select all data without forgetting one.
</p>
<h2 id="edit">4. Edit Collections</h2>
<p>
Once you added a collection, using NIfTI files or Excel file, you can edit them by using the menu at the bottom. That will show a new page where you will see the list of your selected Collections on the right.
</p>
<p>
<img src="imgs/edit.jpg" style="width:20%">
</p>
<h3 id="select_edit">4.1. Select the collection to edit</h3>
<p>
On the right, you can see your selected Collections. You can click on the name of the one you want to edit.
</p>
<p>
<img src="imgs/select_edit.jpg" style="width:40%">
</p>
<h3 id="rename_col">4.2. Rename a Collection</h3>
<p>
To rename the selected collection, you just have to click on the button "Change Collection Name" to access to the rename pop up. You will not be able to name two collections the same way. Furthermore, the software prevent you to add unauthorized symbols to the name of your collection, such as : "/",";"...
</p>
<p>
<img src="imgs/rename_col.jpg" style="width:40%">
</p>
<h3 id="add_images">4.3. Add images to a Collection</h3>
<p>
Even if your collection is created, you are still able to add some data into it. To do so, you just have to click on the button "Add new Image(s)". Then, you will add your NIfTI files the same way you added them to create the collection.
</p>
<p>
The new images will immediatly be added to the collection and will appear in the list of images.
</p>
<p>
<img src="imgs/add_image.jpg" style="width:40%">
</p>
<h3 id="remove_images">4.4. Remove images to a Collection</h3>
<p>
To remove one or several images from a collection, you have to click on the button "Remove" next to the name of the image. This name will now appear red. If you change your mind, you can click on the new button "Re Add", to cancel the image removal.
</p>
<p>
This process need a save. When you have choosed your images to remove, click on the button "Save changes" to remove them permanently.
</p>
<p>
Note that this process is not cancelable. But you can re add your images using the <a href="#add_images">"Add images to a Collection" method</a>.
</p>
<p>
<img src="imgs/remove_image.jpg" style="width:40%">
</p>
<h3 id="show">4.5. Show one image in a Collection</h3>
<p>
In order to quickly realize what the chosen image contains, it is possible to click on the "Show" button.
</p>
<p>
A basic visualization appears at the bottom of the screen. Note that this visualization may take a little time if the image contains a lot of information. You can then manipulate the visualization by clicking, moving the mouse in it or by scrolling.
</p>
<p>
This visualization will display the highest intensity in white and fit all others on a "white to black" scale for "higher to lower" intensity.
</p>
<p>
The name of the image shown is displayed at the top of the screen.
</p>
<p>
<img src="imgs/show.jpg" style="width:40%">
</p>
<h3 id="del_col">4.6. Delete one collection</h3>
<p>
You can delete a collection by clicking on the "Delete Collection" button. This action is irreversible and takes effect immediately. The application will go back to the home page.
</p>
<p>
<img src="imgs/del_col.jpg" style="width:40%">
</p>
</div>
</div>
<footer class="w3-container w3-dark-grey w3-padding-32 w3-margin-top">
<div class="column-left">
<p>Source code available on <a href="https://github.com/Brain-Mapper/brainMapper" target="_blank">GitHub repository</a></p>
</div>
<div>
<p> <b>Authors</b>: R. Agathon (@yoshcraft), M. Cluchague (@maximeCluchague), G. Husson (@Graziella-Husson), V. Zelaya (@vz-chameleon)
</div>
</footer>
</body>
</html>