Skip to content

Commit 2caae5c

Browse files
committed
📝 Update default config line numbers
1 parent 30bc2d3 commit 2caae5c

File tree

15 files changed

+81
-21
lines changed

15 files changed

+81
-21
lines changed

docs/_sources/user/after_warp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following nested key/value pairs that will be set to these defaults if not d
4242

4343
.. literalinclude:: /references/default_pipeline.yml
4444
:language: YAML
45-
:lines: 1161-1191
45+
:lines: 1184-1214
4646

4747
External Resources
4848
^^^^^^^^^^^^^^^^^^

docs/_sources/user/alff.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The following nested key/value pairs that will be set to these defaults if not d
4444

4545
.. literalinclude:: /references/default_pipeline.yml
4646
:language: YAML
47-
:lines: 1270-1280
47+
:lines: 1290-1300
4848

4949
References
5050
^^^^^^^^^^

docs/_sources/user/anat.rst

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ Configuring CPAC to run initial preprocessing:
2828

2929
#. **N4 Bias Field Correction - [On,Off]:** ANTs N4BiasFieldCorrection - a variant of the popular N3 (nonparametric nonuniform normalization) retrospective bias correction algorithm. Default is Off.
3030

31+
Configuration Without the GUI
32+
""""""""""""""""""""""""""""""
33+
34+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
35+
36+
.. literalinclude:: /references/default_pipeline.yml
37+
:language: YAML
38+
:lines: 197-209
39+
3140
Configuring ACPC Alignment options:
3241
""""""""""""""""""""""""""""""""""""""
3342
**Note:** These options are pre-set for ACPC Alignment's default values. These do not need to be modified unless you are looking to optimize the results of ACPC alignment for your particular dataset.
@@ -38,6 +47,14 @@ Configuring ACPC Alignment options:
3847
#. **ACPC Aligned Skull Template - [path]:** Skull template to be used for ACPC alignment. It is not necessary to change this path unless you intend to use a non-standard template.
3948
#. **ACPC Aligned Brain Template - [path]:** Brain template to be used for ACPC alignment. For human data, it can be 'None'. It is not necessary to change this path unless you intend to use a non-standard template.
4049

50+
Configuration Without the GUI
51+
""""""""""""""""""""""""""""""
52+
53+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
54+
55+
.. literalinclude:: /references/default_pipeline.yml
56+
:language: YAML
57+
:lines: 197-198,207-226
4158

4259
Skull-Stripping
4360
^^^^^^^^^^^^^^^
@@ -62,6 +79,15 @@ Configuring CPAC to run Skull-Stripping:
6279

6380
#. **Which tool for skull-stripping - [FSL, AFNI, niworkflows-ants]:** Choose if you’d like to use FSL BET, AFNI 3dSkullStrip, or run all options in parallel.
6481

82+
Configuration Without the GUI
83+
""""""""""""""""""""""""""""""
84+
85+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
86+
87+
.. literalinclude:: /references/default_pipeline.yml
88+
:language: YAML
89+
:lines: 197-198,228-232
90+
6591
Configuring AFNI 3dSkullStrip options:
6692
""""""""""""""""""""""""""""""""""""""
6793
**Note:** These options are pre-set for AFNI 3dSkullStrip's default values. These do not need to be modified unless you are looking to optimize the results of skull-stripping for your particular dataset.
@@ -104,6 +130,15 @@ Configuring AFNI 3dSkullStrip options:
104130

105131
#. **blur_fwhm - [2]:** Blur datasets after spatial normalization. Default value is 2.
106132

133+
Configuration Without the GUI
134+
""""""""""""""""""""""""""""""
135+
136+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
137+
138+
.. literalinclude:: /references/default_pipeline.yml
139+
:language: YAML
140+
:lines: 197-198,228-229,234-298
141+
107142
Configuring FSL BET options:
108143
""""""""""""""""""""""""""""
109144
**Note:** These options are pre-set for FSL BET's default values. These do not need to be modified unless you are looking to optimize the results of skull-stripping for your particular dataset.
@@ -136,6 +171,15 @@ Configuring FSL BET options:
136171

137172
#. **Robust brain center - [Off, On]:** Robust brain center estimation. Mutually exclusive with functional, reduce_bias, robust, padding, remove_eyes, surfaces.
138173

174+
Configuration Without the GUI
175+
""""""""""""""""""""""""""""""
176+
177+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
178+
179+
.. literalinclude:: /references/default_pipeline.yml
180+
:language: YAML
181+
:lines: 197-198,228-229,300-339
182+
139183
Configuring niworkflows-ants options:
140184
"""""""""""""""""""""""""""""""""""""
141185
**Note:** These templates are used during niworkflows-ants skull stripping. e.g. OASIS template can be downloaded `here <https://s3-eu-west-1.amazonaws.com/pfigshare-u-files/3133832/Oasis.zip>`_.
@@ -148,6 +192,14 @@ Configuring niworkflows-ants options:
148192

149193
#. **niworkflows_ants_regmask_path:** Set the brain extraction registration mask, used for registration to limit the metric computation to a specific region. e.g. OASIStemplate/T_template0_BrainCerebellumRegistrationMask.nii.gz
150194

195+
Configuration Without the GUI
196+
""""""""""""""""""""""""""""""
197+
198+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
199+
200+
.. literalinclude:: /references/default_pipeline.yml
201+
:language: YAML
202+
:lines: 197-198,228-229,346-358
151203

152204
Anatomical Registration
153205
^^^^^^^^^^^^^^^^^^^^^^^
@@ -194,7 +246,7 @@ The following nested key/value pairs that will be set to these defaults if not d
194246

195247
.. literalinclude:: /references/default_pipeline.yml
196248
:language: YAML
197-
:lines: 192-353
249+
:lines: 482-600
198250

199251
Anatomical Tissue Segmentation
200252
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -298,7 +350,7 @@ The following nested key/value pairs that will be set to these defaults if not d
298350

299351
.. literalinclude:: /references/default_pipeline.yml
300352
:language: YAML
301-
:lines: 356-476
353+
:lines: 361-479
302354

303355
References
304356
^^^^^^^^^^

docs/_sources/user/aroma_ica.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The following nested key/value pairs that will be set to these defaults if not d
4040

4141
.. literalinclude:: /references/default_pipeline.yml
4242
:language: YAML
43-
:lines: 1024-1035
43+
:lines: 1022-1033
4444

4545
EXTERNAL RESOURCES:
4646
^^^^^^^^^^^^^^^^^^^

docs/_sources/user/centrality.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The following nested key/value pairs that will be set to these defaults if not d
6464

6565
.. literalinclude:: /references/default_pipeline.yml
6666
:language: YAML
67-
:lines: 1326-1393
67+
:lines: 1346-1413
6868

6969
References
7070
^^^^^^^^^^

docs/_sources/user/compute_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The following nested key/value pairs that will be set to these defaults if not d
3131

3232
.. literalinclude:: /references/default_pipeline.yml
3333
:language: YAML
34-
:lines: 10-11,76-131
34+
:lines: 10-11,81-136
3535

3636
Setting up SGE
3737
"""""""""""""""

docs/_sources/user/func.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ The following nested key/value pairs that will be set to these defaults if not d
3838

3939
.. literalinclude:: /references/default_pipeline.yml
4040
:language: YAML
41-
:lines: 602-619,815-847,855-936
42-
41+
:lines: 602-606,609-610,615-619,815-936
4342

4443
.. _motion_estimate_filter_valid_options:
4544

@@ -84,7 +83,7 @@ The following nested key/value pairs that will be set to these defaults if not d
8483

8584
.. literalinclude:: /references/default_pipeline.yml
8685
:language: YAML
87-
:lines: 812-814,844-850
86+
:lines: 815-816,848-853
8887

8988
Through the Data Configuration
9089
""""""""""""""""""""""""""""""
@@ -170,7 +169,7 @@ The following nested key/value pairs that will be set to these defaults if not d
170169

171170
.. literalinclude:: /references/default_pipeline.yml
172171
:language: YAML
173-
:lines: 812-814,916-944
172+
:lines: 815-816,938-965
174173

175174
Functional to Anatomical Registration
176175
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -188,6 +187,15 @@ Functional to Anatomical Registration
188187

189188
#. **Functional Masking - [AFNI, FSL, FSL_AFNI, Anatomical_Refined]:** Choose which tool to be used in functional masking - AFNI (3dAutoMask), FSL (BET), FSL_AFNI (BET+3dAutoMask) or Anatomical_Refined (generate functional mask by registering anatomical mask to functional space). Default is AFNI.
190189

190+
Configuration Without the GUI
191+
"""""""""""""""""""""""""""""
192+
193+
The following nested key/value pairs that will be set to these defaults if not defined in your :doc:`pipeline configuration YAML </user/pipelines/pipeline_config>`:
194+
195+
.. literalinclude:: /references/default_pipeline.yml
196+
:language: YAML
197+
:lines: 482-483,602-614,621-635,815-816,967-971
198+
191199
Configuring FSL BET options:
192200
""""""""""""""""""""""""""""
193201

@@ -231,7 +239,7 @@ The following nested key/value pairs that will be set to these defaults if not d
231239

232240
.. literalinclude:: /references/default_pipeline.yml
233241
:language: YAML
234-
:lines: 479-480,599-631,812-813,946-998
242+
:lines: 815-816,973-1014
235243

236244
Functional to Template Registration
237245
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -264,4 +272,4 @@ The following nested key/value pairs that will be set to these defaults if not d
264272

265273
.. literalinclude:: /references/default_pipeline.yml
266274
:language: YAML
267-
:lines: 479-480,599-600,633-809
275+
:lines: 482-483,602-603,636-812

docs/_sources/user/longitudinal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The following nested key/value pairs that will be set to these defaults if not d
2929

3030
.. literalinclude:: /references/default_pipeline.yml
3131
:language: YAML
32-
:lines: 157-189
32+
:lines: 162-194
3333

3434
References
3535
^^^^^^^^^^

docs/_sources/user/nuisance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The following nested key/value pairs that will be set to these defaults if not d
136136

137137
.. literalinclude:: /references/default_pipeline.yml
138138
:language: YAML
139-
:lines: 1001-1158
139+
:lines: 1022-1023,1035-1181
140140

141141
An example of nuisance regressors
142142
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/_sources/user/output_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ The following nested key/value pairs that will be set to these defaults if not d
3838

3939
.. literalinclude:: /references/default_pipeline.yml
4040
:language: YAML
41-
:lines: 10-75,133-144
41+
:lines: 10-80,138-149

0 commit comments

Comments
 (0)