-
Notifications
You must be signed in to change notification settings - Fork 0
/
getting-started.html
988 lines (891 loc) · 54.7 KB
/
getting-started.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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta http-equiv="X-UA-Compatible" content="IE=EDGE" />
<title>Getting started</title>
<script src="site_libs/header-attrs-2.28/header-attrs.js"></script>
<script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link href="site_libs/bootstrap-3.3.5/css/lumen.min.css" rel="stylesheet" />
<script src="site_libs/bootstrap-3.3.5/js/bootstrap.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/html5shiv.min.js"></script>
<script src="site_libs/bootstrap-3.3.5/shim/respond.min.js"></script>
<style>h1 {font-size: 34px;}
h1.title {font-size: 38px;}
h2 {font-size: 30px;}
h3 {font-size: 24px;}
h4 {font-size: 18px;}
h5 {font-size: 16px;}
h6 {font-size: 12px;}
code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
pre:not([class]) { background-color: white }</style>
<script src="site_libs/jqueryui-1.13.2/jquery-ui.min.js"></script>
<link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
<script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
<script src="site_libs/navigation-1.1/tabsets.js"></script>
<script src="site_libs/navigation-1.1/codefolding.js"></script>
<script src="site_libs/navigation-1.1/sourceembed.js"></script>
<link href="site_libs/anchor-sections-1.1.0/anchor-sections.css" rel="stylesheet" />
<link href="site_libs/anchor-sections-1.1.0/anchor-sections-hash.css" rel="stylesheet" />
<script src="site_libs/anchor-sections-1.1.0/anchor-sections.js"></script>
<link href="site_libs/font-awesome-6.4.2/css/all.min.css" rel="stylesheet" />
<link href="site_libs/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet" />
<!DOCTYPE html>
<link rel="shortcut icon" href="images/logo.png" />
<style type="text/css">
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
</style>
<style type="text/css">
code {
white-space: pre;
}
.sourceCode {
overflow: visible;
}
</style>
<style type="text/css" data-origin="pandoc">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ background-color: #f8f8f8; }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ef2929; } /* Alert */
code span.an { color: #8f5902; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #204a87; } /* Attribute */
code span.bn { color: #0000cf; } /* BaseN */
code span.cf { color: #204a87; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4e9a06; } /* Char */
code span.cn { color: #8f5902; } /* Constant */
code span.co { color: #8f5902; font-style: italic; } /* Comment */
code span.cv { color: #8f5902; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #8f5902; font-weight: bold; font-style: italic; } /* Documentation */
code span.dt { color: #204a87; } /* DataType */
code span.dv { color: #0000cf; } /* DecVal */
code span.er { color: #a40000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #0000cf; } /* Float */
code span.fu { color: #204a87; font-weight: bold; } /* Function */
code span.im { } /* Import */
code span.in { color: #8f5902; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #204a87; font-weight: bold; } /* Keyword */
code span.op { color: #ce5c00; font-weight: bold; } /* Operator */
code span.ot { color: #8f5902; } /* Other */
code span.pp { color: #8f5902; font-style: italic; } /* Preprocessor */
code span.sc { color: #ce5c00; font-weight: bold; } /* SpecialChar */
code span.ss { color: #4e9a06; } /* SpecialString */
code span.st { color: #4e9a06; } /* String */
code span.va { color: #000000; } /* Variable */
code span.vs { color: #4e9a06; } /* VerbatimString */
code span.wa { color: #8f5902; font-weight: bold; font-style: italic; } /* Warning */
</style>
<script>
// apply pandoc div.sourceCode style to pre.sourceCode instead
(function() {
var sheets = document.styleSheets;
for (var i = 0; i < sheets.length; i++) {
if (sheets[i].ownerNode.dataset["origin"] !== "pandoc") continue;
try { var rules = sheets[i].cssRules; } catch (e) { continue; }
var j = 0;
while (j < rules.length) {
var rule = rules[j];
// check if there is a div.sourceCode rule
if (rule.type !== rule.STYLE_RULE || rule.selectorText !== "div.sourceCode") {
j++;
continue;
}
var style = rule.style.cssText;
// check if color or background-color is set
if (rule.style.color === '' && rule.style.backgroundColor === '') {
j++;
continue;
}
// replace div.sourceCode by a pre.sourceCode rule
sheets[i].deleteRule(j);
sheets[i].insertRule('pre.sourceCode{' + style + '}', j);
}
}
})();
</script>
<style type="text/css">
#rmd-source-code {
display: none;
}
</style>
<link rel="stylesheet" href="styles.css" type="text/css" />
<style type = "text/css">
.main-container {
max-width: 940px;
margin-left: auto;
margin-right: auto;
}
img {
max-width:100%;
}
.tabbed-pane {
padding-top: 12px;
}
.html-widget {
margin-bottom: 20px;
}
button.code-folding-btn:focus {
outline: none;
}
summary {
display: list-item;
}
details > summary > p:only-child {
display: inline;
}
pre code {
padding: 0;
}
</style>
<style type="text/css">
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #adb5bd;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
</style>
<script type="text/javascript">
// manage active state of menu based on current page
$(document).ready(function () {
// active menu anchor
href = window.location.pathname
href = href.substr(href.lastIndexOf('/') + 1)
if (href === "")
href = "index.html";
var menuAnchor = $('a[href="' + href + '"]');
// mark the anchor link active (and if it's in a dropdown, also mark that active)
var dropdown = menuAnchor.closest('li.dropdown');
if (window.bootstrap) { // Bootstrap 4+
menuAnchor.addClass('active');
dropdown.find('> .dropdown-toggle').addClass('active');
} else { // Bootstrap 3
menuAnchor.parent().addClass('active');
dropdown.addClass('active');
}
// Navbar adjustments
var navHeight = $(".navbar").first().height() + 15;
var style = document.createElement('style');
var pt = "padding-top: " + navHeight + "px; ";
var mt = "margin-top: -" + navHeight + "px; ";
var css = "";
// offset scroll position for anchor links (for fixed navbar)
for (var i = 1; i <= 6; i++) {
css += ".section h" + i + "{ " + pt + mt + "}\n";
}
style.innerHTML = "body {" + pt + "padding-bottom: 40px; }\n" + css;
document.head.appendChild(style);
});
</script>
<!-- tabsets -->
<style type="text/css">
.tabset-dropdown > .nav-tabs {
display: inline-table;
max-height: 500px;
min-height: 44px;
overflow-y: auto;
border: 1px solid #ddd;
border-radius: 4px;
}
.tabset-dropdown > .nav-tabs > li.active:before, .tabset-dropdown > .nav-tabs.nav-tabs-open:before {
content: "\e259";
font-family: 'Glyphicons Halflings';
display: inline-block;
padding: 10px;
border-right: 1px solid #ddd;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
content: "\e258";
font-family: 'Glyphicons Halflings';
border: none;
}
.tabset-dropdown > .nav-tabs > li.active {
display: block;
}
.tabset-dropdown > .nav-tabs > li > a,
.tabset-dropdown > .nav-tabs > li > a:focus,
.tabset-dropdown > .nav-tabs > li > a:hover {
border: none;
display: inline-block;
border-radius: 4px;
background-color: transparent;
}
.tabset-dropdown > .nav-tabs.nav-tabs-open > li {
display: block;
float: none;
}
.tabset-dropdown > .nav-tabs > li {
display: none;
}
</style>
<!-- code folding -->
<style type="text/css">
.code-folding-btn { margin-bottom: 4px; }
</style>
<style type="text/css">
#TOC {
margin: 25px 0px 20px 0px;
}
@media (max-width: 768px) {
#TOC {
position: relative;
width: 100%;
}
}
@media print {
.toc-content {
/* see https://github.com/w3c/csswg-drafts/issues/4434 */
float: right;
}
}
.toc-content {
padding-left: 30px;
padding-right: 40px;
}
div.main-container {
max-width: 1200px;
}
div.tocify {
width: 20%;
max-width: 260px;
max-height: 85%;
}
@media (min-width: 768px) and (max-width: 991px) {
div.tocify {
width: 25%;
}
}
@media (max-width: 767px) {
div.tocify {
width: 100%;
max-width: none;
}
}
.tocify ul, .tocify li {
line-height: 20px;
}
.tocify-subheader .tocify-item {
font-size: 0.90em;
}
.tocify .list-group-item {
border-radius: 0px;
}
.tocify-subheader {
display: inline;
}
.tocify-subheader .tocify-item {
font-size: 0.95em;
}
</style>
</head>
<body>
<div class="container-fluid main-container">
<!-- setup 3col/9col grid for toc_float and main content -->
<div class="row">
<div class="col-xs-12 col-sm-4 col-md-3">
<div id="TOC" class="tocify">
</div>
</div>
<div class="toc-content col-xs-12 col-sm-8 col-md-9">
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-bs-toggle="collapse" data-target="#navbar" data-bs-target="#navbar">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">Gannet</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fa fa-home"></span>
Home
</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Documentation
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="getting-started.html">Getting started</a>
</li>
<li>
<a href="reference.html">Reference</a>
</li>
<li>
<a href="output-structure-attributes.html">Output structure attributes</a>
</li>
<li>
<a href="preprocessing.html">Preprocessing</a>
</li>
<li>
<a href="signal-modeling.html">Signal modeling</a>
</li>
<li>
<a href="data-quality-metrics.html">Data quality metrics</a>
</li>
<li>
<a href="quantification-tissue-correction.html">Quantification & tissue correction</a>
</li>
<li>
<a href="additional-tools.html">Additional tools</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Examples
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="gannetpreinitialise-settings.html">GannetPreInitialise settings</a>
</li>
<li>
<a href="batch-script.html">Batch processing script</a>
</li>
<li>
<a href="joining-data-files.html">Joining data files</a>
</li>
</ul>
</li>
<li>
<a href="faq.html">FAQ</a>
</li>
<li>
<a href="release-notes.html">Release notes</a>
</li>
<li>
<a href="https://forum.mrshub.org/c/mrs-software/gannet/9">Forum</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/markmikkelsen/Gannet/issues">Report an issue</a>
</li>
<li>
<a href="https://github.com/markmikkelsen/Gannet">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
<li>
<a href="mailto:[email protected]?subject=[Gannet]%20<Please enter the subject of your query here>">
<span class="fa fa-envelope fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
<div id="header">
<div class="btn-group pull-right float-right">
<button type="button" class="btn btn-default btn-xs btn-secondary btn-sm dropdown-toggle" data-toggle="dropdown" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="false"><span>Code</span> <span class="caret"></span></button>
<ul class="dropdown-menu dropdown-menu-right" style="min-width: 50px;">
<li><a id="rmd-download-source" href="#">Download Rmd</a></li>
</ul>
</div>
<h1 class="title toc-ignore">Getting started</h1>
<h4 class="date">Last updated: October 14, 2024</h4>
</div>
<button onclick="topFunction()" id="myBtn" title="Go to top">
Back to top
</button>
<script>
//Get the button
var mybutton = document.getElementById("myBtn");
// When the user scrolls down 20px from the top of the document, show the button
window.onscroll = function() {scrollFunction()};
function scrollFunction() {
if (document.body.scrollTop > 20 || document.documentElement.scrollTop > 20) {
mybutton.style.display = "block";
} else {
mybutton.style.display = "none";
}
}
// When the user clicks on the button, scroll to the top of the document
function topFunction() {
document.body.scrollTop = 0;
document.documentElement.scrollTop = 0;
}
</script>
<p><br></p>
<p>Gannet simplifies the preprocessing, signal fitting, and
quantification pipeline of edited MRS data. All you need to get started
is a basic understanding of MATLAB and the five Gannet modules (listed
below).</p>
<p>If this is your first time using Gannet, you should read through the
<a
href="https://markmikkelsen.github.io/Gannet-docs/reference.html">Reference</a>
as well. If you have previously worked with Gannet and only need a quick
refresher about the command syntax, this page will probably be all you
need to get started again.</p>
<div id="modules" class="section level2 hasAnchor">
<h2 class="hasAnchor">Modules<a href="#modules" class="anchor-section"
aria-label="Anchor link to header"></a></h2>
<p>The linear workflow of Gannet is made up of five modules. For proper
functionality, they need to be executed in the following order:</p>
<table>
<colgroup>
<col width="16%" />
<col width="83%" />
</colgroup>
<thead>
<tr class="header">
<th align="left"><u>Module</u></th>
<th align="left"><u>Description</u></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left"><strong>GannetLoad</strong></td>
<td align="left">Loads raw data exported from the scanner; preprocesses
them; plots the edited spectra; and gives information about the time
course of the experiment.</td>
</tr>
<tr class="even">
<td align="left"><strong>GannetFit</strong></td>
<td align="left">Models the metabolite signals of interest in the
difference spectra and the reference compounds; plots the data and the
model fits; and gives basic quantification results and information about
spectral quality.</td>
</tr>
<tr class="odd">
<td align="left"><strong>GannetCoRegister</strong></td>
<td align="left">Loads the provided structural image data files;
co-registers the loaded MRS voxel to them; and produces a figure showing
the localization of the voxel on the structural image on three
orthogonal slices.</td>
</tr>
<tr class="even">
<td align="left"><strong>GannetSegment</strong></td>
<td align="left">Calls SPM to segment the structural images; determines
the fractional tissue composition (gray matter, white matter, and CSF)
within the MRS voxel; produces a figure showing the tissue fractions as
overlays and displays CSF-corrected metabolite estimates.</td>
</tr>
<tr class="odd">
<td align="left"><strong>GannetQuantify</strong></td>
<td align="left">Uses the segmentation information to perform partial
volume tissue correction and produces a figure displaying several
tissue-corrected metabolite measurements.</td>
</tr>
</tbody>
</table>
<p>Familiarize yourself with the five basic Gannet commands, as
described below. The number of commands is deliberately kept to a
minimum, as is the number of possible input arguments to these commands.
Incorrect syntax is a common source of user error, so make sure that you
understand the argument structure of each function you intend to
use.</p>
</div>
<div id="usage" class="section level2 hasAnchor">
<h2 class="hasAnchor">Usage<a href="#usage" class="anchor-section"
aria-label="Anchor link to header"></a></h2>
<div id="gannetpreinitialise" class="section level3 hasAnchor">
<h3 class="hasAnchor">GannetPreInitialise<a href="#gannetpreinitialise"
class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>The first step in using Gannet is to set up the
<code>GannetPreInitialise.m</code> function. While the toolkit has many
routines that automatically recognize data formats, sequences, and
acquisition parameters from data file headers; some settings need to be
set by the user to run Gannet properly. Additionally,
<code>GannetPreInitialise.m</code> allows the user to choose how to
process their data (for example, which frequency-and-phase correction
algorithm to use).</p>
<div class="warning">
<p><i class="fa fa-exclamation-circle" style="color: white"></i> Any
time you run Gannet, make sure to check that the settings in
<code>GannetPreInitialise.m</code> are correct. Many errors can be
avoided by following this simple step.</p>
</div>
<p>The default settings pre-initialize a standard analysis for in vivo
GABA-edited MEGA-PRESS data. If you want to analyze data acquired with a
different method or from a phantom, or target a different metabolite,
you will need to make changes to this file. Please read the <a
href="https://markmikkelsen.github.io/Gannet-docs/reference.html#pre-initializing-gannet">Reference</a>
for detailed explanations of the options and flags in
<code>GannetPreInitialise.m</code>.</p>
<p><img src="images/getting-started/GannetPreInitialise-example.png" alt="A screenshot example of GannetPreInitialise.m"></p>
</div>
<div id="loading-and-fitting-data" class="section level3 hasAnchor">
<h3 class="hasAnchor">Loading and fitting data<a
href="#loading-and-fitting-data" class="anchor-section"
aria-label="Anchor link to header"></a></h3>
<p>Depending on the format of your data, and if you have water reference
data and/or structural images, the commands for running Gannet to load
and fit your data follow a specific syntax.</p>
<p>For all modules, an output argument containing a structure should
always be included, for example <code>MRS_struct</code>. Input arguments
for <code>GannetLoad.m</code> are usually given as cell arrays.
Water-suppressed metabolite files must be given as the first input
argument, while unsuppressed water reference files must be given as the
second input argument. The remaining modules require input of the output
structure from <code>GannetLoad.m</code>. (The exception is
<code>GannetCoRegister.m</code>, which additionally requires a cell
array of structural images.)</p>
<p>Some examples for different data file formats:</p>
<div id="dicom-data-.dcm-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>DICOM data (*.dcm files)</strong><a
href="#dicom-data-.dcm-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p>The DICOM format saves each transient in a separate file, such that
for an acquisition with 320 transients, there will be 320 DICOM files.
Data from each acquisition should be stored in an individual directory.
To run such data, use the following commands:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'metab/file1.dcm'</span>}<span class="op">,</span> {<span class="st">'water/file1.dcm'</span>})<span class="op">;</span></span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
<div class="info">
<p><i class="fa fa-info-circle" style="color: white"></i> Note how the
metabolite and water data are stored in separate directories and that a
single DICOM file is selected for data loading (it does not matter which
file in each directory is chosen).</p>
</div>
</div>
<div id="ge-data-.7-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>GE data (*.7 files)</strong><a
href="#ge-data-.7-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p>Data from GE scanners are exported as a P-file, with the extension
*.7. Standard GE acquisitions automatically acquire a water reference,
which is stored within the P-file. To run such data, use the following
commands:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb2-1"><a href="#cb2-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'sub-01.7'</span>})<span class="op">;</span></span>
<span id="cb2-2"><a href="#cb2-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
</div>
<div id="nifti-data-.nii.gz-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>NIfTI data (*.nii[.gz] files)</strong><a
href="#nifti-data-.nii.gz-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p><a href="https://doi.org/10.1002/mrm.29418" target="_blank">NIfTI-MRS</a>
was developed to serve as an open-source data format standard for MRS.
Both compressed and uncompressed files can be processed in Gannet. To
run such data, use the following commands:</p>
<div class="sourceCode" id="cb3"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb3-1"><a href="#cb3-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'sub-01.nii'</span>}<span class="op">,</span> {<span class="st">'sub-01_ref.nii'</span>})<span class="op">;</span></span>
<span id="cb3-2"><a href="#cb3-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
</div>
<div id="philips-data-.sdat.spar-files"
class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>Philips data (*.sdat/*.spar
files)</strong><a href="#philips-data-.sdat.spar-files"
class="anchor-section" aria-label="Anchor link to header"></a></h4>
<p>Data from Philips scanners are most commonly exported as a pair of
*.sdat/*.spar files, where the *.sdat file contains the data and the
*.spar contains the acquisition parameters. A water reference usually is
also acquired and exported as a separate pair of files. The two are
distinguished by the suffices <code>_act</code> and <code>_ref</code>.
To run such data, use the following commands:</p>
<div class="sourceCode" id="cb4"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb4-1"><a href="#cb4-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'sub-01_act.sdat'</span>}<span class="op">,</span> {<span class="st">'sub-01_ref.sdat'</span>})<span class="op">;</span></span>
<span id="cb4-2"><a href="#cb4-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
<div class="info">
<p><i class="fa fa-info-circle" style="color: white"></i> The *.spar
files must be in the same directory as the *.sdat files, otherwise an
error will occur.</p>
</div>
</div>
<div id="siemens-data-.dat-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>Siemens data (*.dat files)</strong><a
href="#siemens-data-.dat-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p>It is highly recommended that users export data in the TWIX format
for Siemens data. This is a raw format that saves the MRS signal for
each transient from each RF coil element separately. To run such data,
use the following commands:</p>
<div class="sourceCode" id="cb5"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb5-1"><a href="#cb5-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'sub-01.dat'</span>}<span class="op">,</span> {<span class="st">'sub-01_water.dat'</span>})<span class="op">;</span></span>
<span id="cb5-2"><a href="#cb5-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
</div>
<div id="siemens-data-.ima-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>Siemens data (*.ima files)</strong><a
href="#siemens-data-.ima-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p>The Siemens DICOM-structured IMA format saves each transient in a
separate file, such that for an acquisition with 320 transients, there
will be 320 IMA files. Data from each acquisition should be stored in an
individual directory. To run such data, use the following commands:</p>
<div class="sourceCode" id="cb6"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb6-1"><a href="#cb6-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'metab/file1.ima'</span>}<span class="op">,</span> {<span class="st">'water/file1.ima'</span>})<span class="op">;</span></span>
<span id="cb6-2"><a href="#cb6-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
<div class="info">
<p><i class="fa fa-info-circle" style="color: white"></i> Note how the
metabolite and water data are stored in separate directories and that a
single IMA file is selected for data loading (it does not matter which
file in each directory is chosen).</p>
</div>
</div>
<div id="siemens-data-.rda-files" class="section level4 hasAnchor">
<h4 class="hasAnchor"><strong>Siemens data (*.rda files)</strong><a
href="#siemens-data-.rda-files" class="anchor-section"
aria-label="Anchor link to header"></a></h4>
<p>The Siemens RDA format for edited MRS data usually sums the edit-ON
and edit-OFF transients and exports them as single files. A third file
with the resulting difference spectrum may also be exported. This format
is not recommended for use in Gannet as a number of important
preprocessing steps cannot be run. However, to run such data, use the
following commands:</p>
<div class="sourceCode" id="cb7"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb7-1"><a href="#cb7-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'OFF.rda'</span><span class="op">,</span> <span class="st">'ON.rda'</span>})<span class="op">;</span></span>
<span id="cb7-2"><a href="#cb7-2" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span></code></pre></div>
<div class="info">
<p><i class="fa fa-info-circle" style="color: white"></i> Take note
that the edit-OFF file must be input first.</p>
</div>
</div>
</div>
<div id="co-registration-to-mr-images" class="section level3 hasAnchor">
<h3 class="hasAnchor">Co-registration to MR images<a
href="#co-registration-to-mr-images" class="anchor-section"
aria-label="Anchor link to header"></a></h3>
<p>After MRS data files are loaded and fitted, and if an structural MR
image was acquired and used to place MRS voxels, Gannet can co-register
the two. To do so, use the following command:</p>
<div class="sourceCode" id="cb8"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb8-1"><a href="#cb8-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetCoRegister(MRS_struct<span class="op">,</span> {<span class="st">'T1w.nii'</span>})<span class="op">;</span></span></code></pre></div>
</div>
<div id="segmenting-mr-images" class="section level3 hasAnchor">
<h3 class="hasAnchor">Segmenting MR images<a
href="#segmenting-mr-images" class="anchor-section"
aria-label="Anchor link to header"></a></h3>
<p>Gannet uses SPM12’s segmentation routine to segment structural MR
images. The grey matter, white matter, and cerebrospinal fluid fractions
are then used in subsequent tissue corrections of metabolite
concentration estimates.</p>
<p>Installation instructions for SPM12 can be found <a
href="https://markmikkelsen.github.io/Gannet-docs/index.html#installation">here</a>.</p>
<p>Run segmentation using the following command:</p>
<div class="sourceCode" id="cb9"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb9-1"><a href="#cb9-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetSegment(MRS_struct)<span class="op">;</span></span></code></pre></div>
</div>
<div id="quantification" class="section level3 hasAnchor">
<h3 class="hasAnchor">Quantification<a href="#quantification"
class="anchor-section" aria-label="Anchor link to header"></a></h3>
<p>Following tissue segmentation, and assuming a water reference was
inputted at data loading, pseudo-absolute quantification can be
performed using the following command:</p>
<div class="sourceCode" id="cb10"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb10-1"><a href="#cb10-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetQuantify(MRS_struct)<span class="op">;</span></span></code></pre></div>
</div>
</div>
<div id="batch-processing" class="section level2 hasAnchor">
<h2 class="hasAnchor">Batch processing<a href="#batch-processing"
class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>One of the major strengths of Gannet is its ability to process
datasets in batches using the same pipeline. To load and fit multiple
files, simply add more filenames to the respective cell arrays that are
passed to <code>GannetLoad.m</code>, as shown below for Philips
data:</p>
<div class="sourceCode" id="cb11"><pre
class="sourceCode octave"><code class="sourceCode octave"><span id="cb11-1"><a href="#cb11-1" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetLoad({<span class="st">'sub-01_act.sdat'</span><span class="op">,</span> <span class="st">'sub-02_act.sdat'</span><span class="op">,</span> <span class="st">'sub-03_act.sdat'</span>}<span class="op">,</span> <span class="op">...</span></span>
<span id="cb11-2"><a href="#cb11-2" tabindex="-1"></a> {<span class="st">'sub-01_ref.sdat'</span><span class="op">,</span> <span class="st">'sub-02_ref.sdat'</span><span class="op">,</span> <span class="st">'sub-03_ref.sdat'</span>})<span class="op">;</span></span>
<span id="cb11-3"><a href="#cb11-3" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetFit(MRS_struct)<span class="op">;</span></span>
<span id="cb11-4"><a href="#cb11-4" tabindex="-1"></a><span class="co"># Only if structural MR images are available can the next lines can be run</span></span>
<span id="cb11-5"><a href="#cb11-5" tabindex="-1"></a><span class="co"># Note that the number of structural images must match the number of MRS metabolite data files inputted in GannetLoad</span></span>
<span id="cb11-6"><a href="#cb11-6" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetCoRegister(MRS_struct<span class="op">,</span> {<span class="st">'T1w.nii'</span><span class="op">,</span> <span class="st">'T1w.nii'</span><span class="op">,</span> <span class="st">'T1w.nii'</span>})<span class="op">;</span></span>
<span id="cb11-7"><a href="#cb11-7" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetSegment(MRS_struct)<span class="op">;</span></span>
<span id="cb11-8"><a href="#cb11-8" tabindex="-1"></a>MRS_struct <span class="op">=</span> GannetQuantify(MRS_struct)<span class="op">;</span></span></code></pre></div>
<p>The respective water reference files <code>sub-01_ref.sdat</code>,
<code>sub-02_ref.sdat</code>, etc. need to be listed in the same order
as the water-suppressed files <code>sub-01_act.sdat</code>,
<code>sub-01_act.sdat</code>, etc. If you intend to process a large
number of datasets, we recommend writing a script as a clear way of
defining the input cell arrays.</p>
<p>We have provided an <a
href="https://markmikkelsen.github.io/Gannet-docs/batch-script.html">example
batch processing script</a> that you may modify for your own
purposes.</p>
</div>
<div id="joining-data-files" class="section level2 hasAnchor">
<h2 class="hasAnchor">Joining data files<a href="#joining-data-files"
class="anchor-section" aria-label="Anchor link to header"></a></h2>
<p>In some instances users may want to conjoin consecutively acquired
data files, such that they are processed as if they were one single
dataset. Gannet is able to do this. To enable this functionality, the
<code>join</code> flag in <code>GannetPreInitialise.m</code> must be set
to <code>1</code>.</p>
<p>However, there is a different command syntax when batch-processing
across multiple subjects’ datasets In such cases, rather than entering
files as vectors, the input cell arrays must be M <span
class="math inline">\(\times\)</span> N matrices, where M is the number
of files per subject to be conjoined and N is the number of
subjects.</p>
<p>We have provided an <a
href="https://markmikkelsen.github.io/Gannet-docs/joining-data-files.html">example
script</a> for joining files.</p>
</div>
<div id="output" class="section level2 hasAnchor">
<h2 class="hasAnchor">Output<a href="#output" class="anchor-section"
aria-label="Anchor link to header"></a></h2>
<p>As shown in the syntax above, Gannet saves all relevant data and
results in a structure (e.g., <code>MRS_struct</code>) at all steps in
the analysis pipeline. After creating the initial output from
<code>GannetLoad.m</code>, <code>MRS_struct</code> is used as both the
output and input arguments for the other Gannet modules. (You need not
use <code>MRS_struct</code>; you can use something more descriptive and
relevant to your purposes if you wish.)</p>
<p>The output structure contains several fields and subfields, which
grow in number as your proceed through the Gannet analysis pipeline. See
the list of <a
href="https://markmikkelsen.github.io/Gannet-docs/output-structure-attributes.html">output
structure attributes</a> for a complete description.</p>
<p>You can also output a CSV file containing useful values from the
output structure for further analysis in a statistical program of your
choice. This functionality is set in
<code>GannetPreInitialise.m</code>.</p>
</div>
<div id="rmd-source-code">---
title: "Getting started"
date: "Last updated: `r format(Sys.time(), '%B %d, %Y')`"
output:
  html_document:
    toc: TRUE
    toc_depth: 3
    toc_float:
      collapsed: FALSE
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(echo = TRUE)
```

```{r, child = "js/back-to-top.js"}
```

<br>

Gannet simplifies the preprocessing, signal fitting, and quantification pipeline of edited MRS data. All you need to get started is a basic understanding of MATLAB and the five Gannet modules (listed below).

If this is your first time using Gannet, you should read through the [Reference](https://markmikkelsen.github.io/Gannet-docs/reference.html) as well. If you have previously worked with Gannet and only need a quick refresher about the command syntax, this page will probably be all you need to get started again.

## Modules

The linear workflow of Gannet is made up of five modules. For proper functionality, they need to be executed in the following order:

| <u>Module</u> | <u>Description</u> |
| :- | :--------- |
| **GannetLoad** | Loads raw data exported from the scanner; preprocesses them; plots the edited spectra; and gives information about the time course of the experiment. |
| **GannetFit** | Models the metabolite signals of interest in the difference spectra and the reference compounds; plots the data and the model fits; and gives basic quantification results and information about spectral quality. |
| **GannetCoRegister** | Loads the provided structural image data files; co-registers the loaded MRS voxel to them; and produces a figure showing the localization of the voxel on the structural image on three orthogonal slices. |
| **GannetSegment** | Calls SPM to segment the structural images; determines the fractional tissue composition (gray matter, white matter, and CSF) within the MRS voxel; produces a figure showing the tissue fractions as overlays and displays CSF-corrected metabolite estimates. |
| **GannetQuantify** | Uses the segmentation information to perform partial volume tissue correction and produces a figure displaying several tissue-corrected metabolite measurements. |

Familiarize yourself with the five basic Gannet commands, as described below. The number of commands is deliberately kept to a minimum, as is the number of possible input arguments to these commands. Incorrect syntax is a common source of user error, so make sure that you understand the argument structure of each function you intend to use.

## Usage

### GannetPreInitialise

The first step in using Gannet is to set up the `GannetPreInitialise.m` function. While the toolkit has many routines that automatically recognize data formats, sequences, and acquisition parameters from data file headers; some settings need to be set by the user to run Gannet properly. Additionally, `GannetPreInitialise.m` allows the user to choose how to process their data (for example, which frequency-and-phase correction algorithm to use).

::: warning
<i class="fa fa-exclamation-circle" style="color: white"></i>&nbsp; Any time you run Gannet, make sure to check that the settings in `GannetPreInitialise.m` are correct. Many errors can be avoided by following this simple step.
:::

The default settings pre-initialize a standard analysis for in vivo GABA-edited MEGA-PRESS data. If you want to analyze data acquired with a different method or from a phantom, or target a different metabolite, you will need to make changes to this file. Please read the [Reference](https://markmikkelsen.github.io/Gannet-docs/reference.html#pre-initializing-gannet) for detailed explanations of the options and flags in `GannetPreInitialise.m`.

<img src="images/getting-started/GannetPreInitialise-example.png" alt="A screenshot example of GannetPreInitialise.m">

### Loading and fitting data

Depending on the format of your data, and if you have water reference data and/or structural images, the commands for running Gannet to load and fit your data follow a specific syntax.

For all modules, an output argument containing a structure should always be included, for example `MRS_struct`. Input arguments for `GannetLoad.m` are usually given as cell arrays. Water-suppressed metabolite files must be given as the first input argument, while unsuppressed water reference files must be given as the second input argument. The remaining modules require input of the output structure from `GannetLoad.m`. (The exception is `GannetCoRegister.m`, which additionally requires a cell array of structural images.)

Some examples for different data file formats:

#### **DICOM data (\*.dcm files)**

The DICOM format saves each transient in a separate file, such that for an acquisition with 320 transients, there will be 320 DICOM files. Data from each acquisition should be stored in an individual directory. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'metab/file1.dcm'}, {'water/file1.dcm'});
MRS_struct = GannetFit(MRS_struct);
```

::: info
<i class="fa fa-info-circle" style="color: white"></i>&nbsp; Note how the metabolite and water data are stored in separate directories and that a single DICOM file is selected for data loading (it does not matter which file in each directory is chosen).
:::

#### **GE data (\*.7 files)**

Data from GE scanners are exported as a P-file, with the extension \*.7. Standard GE acquisitions automatically acquire a water reference, which is stored within the P-file. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'sub-01.7'});
MRS_struct = GannetFit(MRS_struct);
```

#### **NIfTI data (\*.nii[.gz] files)**

<a href="https://doi.org/10.1002/mrm.29418" target="_blank">NIfTI-MRS</a> was developed to serve as an open-source data format standard for MRS. Both compressed and uncompressed files can be processed in Gannet. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'sub-01.nii'}, {'sub-01_ref.nii'});
MRS_struct = GannetFit(MRS_struct);
```

#### **Philips data (\*.sdat/\*.spar files)**

Data from Philips scanners are most commonly exported as a pair of \*.sdat/\*.spar files, where the \*.sdat file contains the data and the \*.spar contains the acquisition parameters. A water reference usually is also acquired and exported as a separate pair of files. The two are distinguished by the suffices `_act` and `_ref`. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'sub-01_act.sdat'}, {'sub-01_ref.sdat'});
MRS_struct = GannetFit(MRS_struct);
```

::: info
<i class="fa fa-info-circle" style="color: white"></i>&nbsp; The \*.spar files must be in the same directory as the \*.sdat files, otherwise an error will occur.
:::

#### **Siemens data (\*.dat files)**

It is highly recommended that users export data in the TWIX format for Siemens data. This is a raw format that saves the MRS signal for each transient from each RF coil element separately. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'sub-01.dat'}, {'sub-01_water.dat'});
MRS_struct = GannetFit(MRS_struct);
```

#### **Siemens data (\*.ima files)**

The Siemens DICOM-structured IMA format saves each transient in a separate file, such that for an acquisition with 320 transients, there will be 320 IMA files. Data from each acquisition should be stored in an individual directory. To run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'metab/file1.ima'}, {'water/file1.ima'});
MRS_struct = GannetFit(MRS_struct);
```

::: info
<i class="fa fa-info-circle" style="color: white"></i>&nbsp; Note how the metabolite and water data are stored in separate directories and that a single IMA file is selected for data loading (it does not matter which file in each directory is chosen).
:::

#### **Siemens data (\*.rda files)**

The Siemens RDA format for edited MRS data usually sums the edit-ON and edit-OFF transients and exports them as single files. A third file with the resulting difference spectrum may also be exported. This format is not recommended for use in Gannet as a number of important preprocessing steps cannot be run. However, to run such data, use the following commands:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'OFF.rda', 'ON.rda'});
MRS_struct = GannetFit(MRS_struct);
```

::: info
<i class="fa fa-info-circle" style="color: white"></i>&nbsp; Take note that the edit-OFF file must be input first.
:::

### Co-registration to MR images

After MRS data files are loaded and fitted, and if an structural MR image was acquired and used to place MRS voxels, Gannet can co-register the two. To do so, use the following command: 

```{octave, eval = FALSE}
MRS_struct = GannetCoRegister(MRS_struct, {'T1w.nii'});
```

### Segmenting MR images

Gannet uses SPM12's segmentation routine to segment structural MR images. The grey matter, white matter, and cerebrospinal fluid fractions are then used in subsequent tissue corrections of metabolite concentration estimates.

Installation instructions for SPM12 can be found [here](https://markmikkelsen.github.io/Gannet-docs/index.html#installation).

Run segmentation using the following command:

```{octave, eval = FALSE}
MRS_struct = GannetSegment(MRS_struct);
```

### Quantification

Following tissue segmentation, and assuming a water reference was inputted at data loading, pseudo-absolute quantification can be performed using the following command:

```{octave, eval = FALSE}
MRS_struct = GannetQuantify(MRS_struct);
```

## Batch processing

One of the major strengths of Gannet is its ability to process datasets in batches using the same pipeline. To load and fit multiple files, simply add more filenames to the respective cell arrays that are passed to `GannetLoad.m`, as shown below for Philips data:

```{octave, eval = FALSE}
MRS_struct = GannetLoad({'sub-01_act.sdat', 'sub-02_act.sdat', 'sub-03_act.sdat'}, ...
                        {'sub-01_ref.sdat', 'sub-02_ref.sdat', 'sub-03_ref.sdat'});
MRS_struct = GannetFit(MRS_struct);
# Only if structural MR images are available can the next lines can be run
# Note that the number of structural images must match the number of MRS metabolite data files inputted in GannetLoad
MRS_struct = GannetCoRegister(MRS_struct, {'T1w.nii', 'T1w.nii', 'T1w.nii'});
MRS_struct = GannetSegment(MRS_struct);
MRS_struct = GannetQuantify(MRS_struct);
```

The respective water reference files `sub-01_ref.sdat`, `sub-02_ref.sdat`, etc. need to be listed in the same order as the water-suppressed files `sub-01_act.sdat`, `sub-01_act.sdat`, etc. If you intend to process a large number of datasets, we recommend writing a script as a clear way of defining the input cell arrays.

We have provided an [example batch processing script](https://markmikkelsen.github.io/Gannet-docs/batch-script.html) that you may modify for your own purposes.

## Joining data files

In some instances users may want to conjoin consecutively acquired data files, such that they are processed as if they were one single dataset. Gannet is able to do this. To enable this functionality, the `join` flag in `GannetPreInitialise.m` must be set to `1`.

However, there is a different command syntax when batch-processing across multiple subjects' datasets In such cases, rather than entering files as vectors, the input cell arrays must be M $\times$ N matrices, where M is the number of files per subject to be conjoined and N is the number of subjects.

We have provided an [example script](https://markmikkelsen.github.io/Gannet-docs/joining-data-files.html) for joining files.

## Output

As shown in the syntax above, Gannet saves all relevant data and results in a structure (e.g., `MRS_struct`) at all steps in the analysis pipeline. After creating the initial output from `GannetLoad.m`, `MRS_struct` is used as both the output and input arguments for the other Gannet modules. (You need not use `MRS_struct`; you can use something more descriptive and relevant to your purposes if you wish.)

The output structure contains several fields and subfields, which grow in number as your proceed through the Gannet analysis pipeline. See the list of [output structure attributes](https://markmikkelsen.github.io/Gannet-docs/output-structure-attributes.html) for a complete description.

You can also output a CSV file containing useful values from the output structure for further analysis in a statistical program of your choice. This functionality is set in `GannetPreInitialise.m`.



</div>
<!DOCTYPE html>
<br>
<hr>
<p style="text-align: right;">Built with <a href="https://rmarkdown.rstudio.com/" target="_blank">R Markdown</a> in <a
href="https://posit.co/products/open-source/rstudio/" target="_blank">RStudio</a>
<br>
</p>
<p style="text-align: right;">Copyright © 2020–2024, Mark Mikkelsen <a
href="https://creativecommons.org/licenses/by/4.0" target="_blank"><img id="cc"
style="height:22px!important;margin-left: 3px;vertical-align:text-bottom;" src="images/license/cc-xlarge.png"><img
id="cc" style="height:22px!important;margin-left: 3px;vertical-align:text-bottom;"
src="images/license/by-xlarge.png"></a>
</p>
</div>
</div>
</div>
<script>
// add bootstrap table styles to pandoc tables
function bootstrapStylePandocTables() {
$('tr.odd').parent('tbody').parent('table').addClass('table table-condensed');
}
$(document).ready(function () {
bootstrapStylePandocTables();
});
</script>
<!-- tabsets -->
<script>
$(document).ready(function () {
window.buildTabsets("TOC");
});
$(document).ready(function () {
$('.tabset-dropdown > .nav-tabs > li').click(function () {
$(this).parent().toggleClass('nav-tabs-open');
});
});
</script>
<!-- code folding -->
<script>
$(document).ready(function () {
window.initializeSourceEmbed("getting-started.Rmd");
});
</script>
<script>
$(document).ready(function () {
// temporarily add toc-ignore selector to headers for the consistency with Pandoc
$('.unlisted.unnumbered').addClass('toc-ignore')
// move toc-ignore selectors from section div to header
$('div.section.toc-ignore')
.removeClass('toc-ignore')
.children('h1,h2,h3,h4,h5').addClass('toc-ignore');
// establish options
var options = {
selectors: "h1,h2,h3",
theme: "bootstrap3",
context: '.toc-content',
hashGenerator: function (text) {
return text.replace(/[.\\/?&!#<>]/g, '').replace(/\s/g, '_');
},
ignoreSelector: ".toc-ignore",
scrollTo: 0
};
options.showAndHide = false;
options.smoothScroll = true;
// tocify
var toc = $("#TOC").tocify(options).data("toc-tocify");
});
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement("script");
script.type = "text/javascript";
script.src = "https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML";
document.getElementsByTagName("head")[0].appendChild(script);
})();
</script>
</body>
</html>