Skip to content

Commit 4fa272a

Browse files
committed
update docs
1 parent b8cfa52 commit 4fa272a

File tree

2 files changed

+9
-39
lines changed

2 files changed

+9
-39
lines changed

docs/dmriprep.workflows.fieldmap.rst

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ dmriprep.workflows.fieldmap package
44
Submodules
55
----------
66

7-
dmriprep.workflows.fieldmap.ants module
8-
---------------------------------------
9-
10-
.. automodule:: dmriprep.workflows.fieldmap.ants
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
14-
157
dmriprep.workflows.fieldmap.base module
168
---------------------------------------
179

docs/workflows.rst

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,16 @@ A (very) high-level view of the simplest pipeline is presented below.
1212
from collections import namedtuple, OrderedDict
1313
from dmriprep.workflows.base import init_single_subject_wf
1414
BIDSLayout = namedtuple('BIDSLayout', ['root'])
15-
wf = init_single_subject_wf(
16-
subject_id='test',
17-
session_list=[],
18-
name='single_subject_wf',
19-
layout=BIDSLayout,
20-
output_dir='.',
21-
work_dir='.',
22-
ignore=[],
23-
b0_thresh=5,
24-
output_resolution=(1, 1, 1),
25-
bet_dwi=0.3,
26-
bet_mag=0.3,
27-
omp_nthreads=1,
28-
synb0_dir=''
29-
)
15+
wf = init_single_subject_wf(subject_id='test', session_list=[], name='single_subject_wf', layout=BIDSLayout, output_dir='.', work_dir='.', ignore=[], b0_thresh=5, output_resolution=(1, 1, 1), bet_dwi=0.3, bet_mag=0.3, omp_nthreads=1, synb0_dir='')
3016

3117
T1w preprocessing
3218
-----------------
3319
:mod:`dmriprep.workflows.anatomical.init_anat_preproc_wf`
3420

21+
The T1w preprocessing workflow skull strips the T1w scan for later use in
22+
tractography or susceptibility distortion correction if using ANTs or
23+
BrainSuite. It uses ``init_brain_extraction_wf`` from `niworkflows`
24+
3525
.. workflow::
3626
:graph2use: orig
3727
:simple_form: yes
@@ -44,28 +34,16 @@ DWI preprocessing
4434
-----------------
4535
:mod:`dmriprep.workflows.dwi.base.init_dwi_preproc_wf`
4636

37+
Preprocessing of DWI files is split into multiple sub-workflows described below.
38+
4739
.. workflow::
4840
:graph2use: orig
4941
:simple_form: yes
5042

5143
from collections import namedtuple
5244
from dmriprep.workflows.dwi import init_dwi_preproc_wf
5345
BIDSLayout = namedtuple('BIDSLayout', ['root'])
54-
wf = init_dwi_preproc_wf(
55-
layout=BIDSLayout('.'),
56-
subject_id='dmripreptest',
57-
dwi_file='/madeup/path/sub-01_dwi.nii.gz',
58-
metadata={},
59-
b0_thresh=5,
60-
output_resolution=(1, 1, 1),
61-
bet_dwi=0.3,
62-
bet_mag=0.3,
63-
omp_nthreads=1,
64-
ignore=[],
65-
synb0_dir='.'
66-
)
67-
68-
Preprocessing of DWI files is split into multiple sub-workflows described below.
46+
wf = init_dwi_preproc_wf(layout=BIDSLayout('.'), subject_id='dmripreptest', dwi_file='/madeup/path/sub-01_dwi.nii.gz', metadata={'PhaseEncodingDirection': '-j', 'TotalReadoutTime': 0.001}, b0_thresh=5, output_resolution=(1, 1, 1), bet_dwi=0.3, bet_mag=0.3, omp_nthreads=1, ignore=[], synb0_dir='')
6947

7048
Concatenating Scans
7149
^^^^^^^^^^^^^^^^^^^
@@ -134,7 +112,7 @@ You can use it in this pipeline by generating the synb0s for the subject(s) and
134112
Once you have a directory of synb0s (recommended to place as derivatives of bids folder, ex. bids/derivatives/synb0/sub-XX), then you are ready to run the pipeline using them! Just run dmripreproc as you usually would, with bids_dir and output_dir, but now add "--synb0_dir <your_synb0_directory>" to your command.
135113
The synb0 acqp for topup and eddy will be automatically generated in the pipeline in the following format:
136114

137-
..code-block:: console
115+
.. code-block:: console
138116
139117
0 -1 0 <total_readout_time>
140118
0 1 0 0

0 commit comments

Comments
 (0)