-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
409 lines (278 loc) · 18.6 KB
/
index.html
File metadata and controls
409 lines (278 loc) · 18.6 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
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
<!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 content="homepage of dmritool" name="description" />
<meta content="Diffusion MRI, software, tool, dmritool, diffusionmritool, dmri, Spherical Polar Fourier Imaging, Spherical Polar Fourier, Sampling scheme, Uniform sampling, sphere, HARDI, Orientation Distribution Function, ODF, Ensemble Average Propagator, EAP, Diffusion Propagator, q-space, q space, visualization, spherical function, spherical harmonics" name="keywords" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>DMRITool’s documentation — DMRITool</title>
<link rel="shortcut icon" href="_static/linux-icon.png"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="DMRITool" href="#"/>
<link rel="next" title="News" href="news.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<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="#" class="icon icon-home"> DMRITool
</a>
<div class="version">
v0.1.1-139-g860d86b4
</div>
<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">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="news.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="building.html">Building</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="userguide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="commands/commandlist.html">Command List</a></li>
<li class="toctree-l1"><a class="reference internal" href="matlabfiles/matlabfunctions.html">Matlab Function List</a></li>
<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="citation.html">Citation</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Developers</a></li>
<li class="toctree-l1"><a class="reference external" href="http://diffusionmritool.github.io/dmritool-doxygen">Doxygen Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="codemodules.html">Code Modules</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">DMRITool</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="#">Docs</a> »</li>
<li>DMRITool’s documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.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="dmritool-s-documentation">
<h1>DMRITool’s documentation<a class="headerlink" href="#dmritool-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id1">Introduction</a></li>
<li><a class="reference internal" href="#download" id="id2">Download</a></li>
<li><a class="reference internal" href="#acknowledgements" id="id3">Acknowledgements</a></li>
<li><a class="reference internal" href="#users-documentation" id="id4">Users Documentation</a></li>
<li><a class="reference internal" href="#developers-documentation" id="id5">Developers Documentation</a></li>
</ul>
</div>
<a class="reference external image-reference" href="https://travis-ci.org/DiffusionMRITool/dmritool"><img alt="travis-ci Status" src="https://travis-ci.org/DiffusionMRITool/dmritool.svg?branch=master" /></a>
<a class="reference external image-reference" href="https://www.codacy.com/app/JianCheng/dmritool?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=DiffusionMRITool/dmritool&amp;utm_campaign=Badge_Grade"><img alt="Codacy Status" src="https://api.codacy.com/project/badge/Grade/13b3fe25b4b84ac6a413bb31e29d58fc" /></a>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id1">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a> is a <strong>free</strong> and <strong>open source</strong> toolbox for <a class="reference external" href="http://en.wikipedia.org/wiki/Diffusion_MRI">diffusion MRI</a> data processing.
It is written in C++ with <a class="reference external" href="http://www.mathworks.com">Matlab</a> interface.
Currently <a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a> has no GUI. It only provides executables for command line usage.
You can also use the released mex executables in <a class="reference external" href="http://www.mathworks.com">matlab</a>.</p>
<p>With <a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a>, you can:</p>
<ul class="simple">
<li>perform reconstruction/estimation of diffusion data, including diffusion weighted signal,
ensemble average propagator (EAP), diffusion orientation distribution function (dODF),
and some meaningful scalar maps, etc.</li>
<li>generate spherically uniform sampling schemes for single or multiple shells.</li>
<li>perform diffusion MRI data simulation.</li>
<li>visualize spherical function field (e.g. dODF field, EAP profile field)</li>
</ul>
<p>Citations will help us support the continued development of <a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a>.
If you use the methods and codes released in <a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a>, please cite the
related references. See <a class="reference internal" href="citation.html"><span class="doc">citation page</span></a>.</p>
</div>
<div class="section" id="download">
<h2><a class="toc-backref" href="#id2">Download</a><a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
<p>You can download the latest source codes from <a class="reference external" href="https://github.com/DiffusionMRITool/dmritool">github</a>:</p>
<div>
<IMG SRC="_static/GitHub.png" height="40" width="40">
<a href="https://github.com/DiffusionMRITool/dmritool/zipball/master"> [ZIP] </a>
<a href="https://github.com/DiffusionMRITool/dmritool/tarball/master">[TAR.GZ] </a>
<p></p>
</div><p>Or use <a class="reference external" href="http://git-scm.com">git</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">DiffusionMRITool</span><span class="o">/</span><span class="n">dmritool</span>
</pre></div>
</div>
</div>
<div class="section" id="acknowledgements">
<h2><a class="toc-backref" href="#id3">Acknowledgements</a><a class="headerlink" href="#acknowledgements" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="https://diffusionmritool.github.io">DMRITool</a> is/was supported by the following research groups:</p>
<ul class="simple">
<li><a class="reference external" href="https://science.nichd.nih.gov/confluence/display/sqits/Home">Section on Quantitative Imaging and Tissue Sciences (SQITS)</a>, <a class="reference external" href="http://www.nih.gov">National Institutes of Health</a></li>
<li><a class="reference external" href="http://www.unc.edu/~ptyap">MIND Lab</a>, <a class="reference external" href="https://www.med.unc.edu/bric/ideagroup">IDEA Group</a>, <a class="reference external" href="http://www.unc.edu">University of North Carolina at Chapel Hill</a></li>
<li><a class="reference external" href="https://team.inria.fr/athena">Athena project team</a>, <a class="reference external" href="https://www.inria.fr/en">INRIA</a></li>
<li><a class="reference external" href="http://www.brainnetome.org">Brainnetome center</a>, <a class="reference external" href="http://english.ia.cas.cn">Institute of Automation, Chinese Academy of Sciences</a></li>
</ul>
</div>
<div class="section" id="users-documentation">
<h2><a class="toc-backref" href="#id4">Users Documentation</a><a class="headerlink" href="#users-documentation" title="Permalink to this headline">¶</a></h2>
<div class="sidebar">
<p class="first sidebar-title">Contact Us</p>
<p class="last">If you have questions about dmritool, please contact us: <a class="reference external" href="mailto:dmritool-discussion%40www.nitrc.org">dmritool-discussion<span>@</span>www<span>.</span>nitrc<span>.</span>org</a></p>
</div>
<div class="toctree-wrapper compound">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="news.html">News</a></li>
<li class="toctree-l1"><a class="reference internal" href="building.html">Building</a><ul>
<li class="toctree-l2"><a class="reference internal" href="building.html#matlab-codes">Matlab codes</a></li>
<li class="toctree-l2"><a class="reference internal" href="building.html#dependent-packages">Dependent Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="building.html#build-souce-code">Build Souce Code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial_dwisimulation.html">DWI data simulation</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial_spfi.html">Spherical Polar Fourier Imaging</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial_qspacesampling.html">Sampling in Q-Space</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="userguide.html">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="userguide.html#d-image-format-and-conversion">4D image format and conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="userguide.html#dwi-data-input-format">DWI data input format</a></li>
<li class="toctree-l2"><a class="reference internal" href="userguide.html#configuration-file-format-for-dwi-data-simulation">Configuration file format for DWI data simulation</a></li>
<li class="toctree-l2"><a class="reference internal" href="userguide.html#visualization-of-spherical-function-field">Visualization of spherical function field</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="commands/commandlist.html">Command List</a><ul>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#dwiprocessing">DWIProcessing</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#diffusionmodels">DiffusionModels</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#samplingscheme">SamplingScheme</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#scripts">Scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#utilities">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands/commandlist.html#visualization">Visualization</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="matlabfiles/matlabfunctions.html">Matlab Function List</a><ul>
<li class="toctree-l2"><a class="reference internal" href="matlabfiles/matlabfunctions.html#common">Common</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlabfiles/matlabfunctions.html#dwiprocessing">DWIProcessing</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlabfiles/matlabfunctions.html#diffusionmodels">DiffusionModels</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlabfiles/matlabfunctions.html#samplingscheme">SamplingScheme</a></li>
<li class="toctree-l2"><a class="reference internal" href="matlabfiles/matlabfunctions.html#utils">Utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a><ul>
<li class="toctree-l2"><a class="reference internal" href="support.html#mailing-list">Mailing List</a></li>
<li class="toctree-l2"><a class="reference internal" href="support.html#issue-tracker">Issue Tracker</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="citation.html">Citation</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a><ul>
<li class="toctree-l2"><a class="reference internal" href="license.html#license-for-dmritool">License for DMRITool</a></li>
<li class="toctree-l2"><a class="reference internal" href="license.html#licenses-for-third-parties">Licenses for third parties</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="developers-documentation">
<h2><a class="toc-backref" href="#id5">Developers Documentation</a><a class="headerlink" href="#developers-documentation" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="developers.html">Developers</a></li>
<li class="toctree-l1"><a class="reference external" href="http://diffusionmritool.github.io/dmritool-doxygen">Doxygen Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="codemodules.html">Code Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="HelperFunctions.html">UTL HelperFunctions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="news.html" class="btn btn-neutral float-right" title="News" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright DMRITool developers <dmritool-discussion@www.nitrc.org>.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'v0.1.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
<a href="https://github.com/DiffusionMRITool/dmritool"><img style="position: absolute; top: 0; right: 0; border: 0; width: 150px; height: 150px;"
src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67"
alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-60718632-2', 'auto');
ga('send', 'pageview');
</script>
<!-- Start of StatCounter Code for Default Guide -->
<script type="text/javascript">
var sc_project=11048608;
var sc_invisible=0;
var sc_security="4e279a87";
var scJsHost = (("https:" == document.location.protocol) ?
"https://secure." : "http://www.");
document.write("<sc"+"ript type='text/javascript' src='" +
scJsHost+
"statcounter.com/counter/counter.js'></"+"script>");
</script>
<noscript><div class="statcounter"><a title="web counter"
href="http://statcounter.com/free-hit-counter/"
target="_blank"><img class="statcounter"
src="//c.statcounter.com/11048608/0/4e279a87/0/" alt="web
counter"></a></div></noscript>
<!-- End of StatCounter Code for Default Guide -->
<!-- <a href="http://statcounter.com/p11048608/?guest=1">View My -->
<!-- Stats</a> -->
</body>
</html>