-
-
Notifications
You must be signed in to change notification settings - Fork 38
/
pipeline_config_default.yml
1813 lines (1328 loc) · 69.8 KB
/
pipeline_config_default.yml
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
989
990
991
992
993
994
995
996
997
998
999
1000
%YAML 1.1
---
# CPAC Pipeline Configuration YAML file
# Version 1.8.5
#
# http://fcp-indi.github.io for more info.
#
# Tip: This file can be edited manually with a text editor for quick modifications.
pipeline_setup:
# Name for this pipeline configuration - useful for identification.
# This string will be sanitized and used in filepaths
pipeline_name: cpac-default-pipeline
output_directory:
# Directory where C-PAC should write out processed data, logs, and crash reports.
# - If running in a container (Singularity/Docker), you can simply set this to an arbitrary
# name like '/outputs', and then map (-B/-v) your desired output directory to that label.
# - If running outside a container, this should be a full path to a directory.
path: /outputs/output
# (Optional) Path to a BIDS-Derivatives directory that already has outputs.
# - This option is intended to ingress already-existing resources from an output
# directory without writing new outputs back into the same directory.
# - If provided, C-PAC will ingress the already-computed outputs from this directory and
# continue the pipeline from where they leave off.
# - If left as 'None', C-PAC will ingress any already-computed outputs from the
# output directory you provide above in 'path' instead, the default behavior.
source_outputs_dir: None
# Set to True to make C-PAC ingress the outputs from the primary output directory if they
# exist, even if a source_outputs_dir is provided
# - Setting to False will pull from source_outputs_dir every time, over-writing any
# calculated outputs in the main output directory
# - C-PAC will still pull from source_outputs_dir if the main output directory is
# empty, however
pull_source_once: True
# Include extra versions and intermediate steps of functional preprocessing in the output directory.
write_func_outputs: False
# Include extra outputs in the output directory that may be of interest when more information is needed.
write_debugging_outputs: False
# Output directory format and structure.
# Options: default, ndmg
output_tree: "default"
# Quality control outputs
quality_control:
# Generate quality control pages containing preprocessing and derivative outputs.
generate_quality_control_images: True
# Generate eXtensible Connectivity Pipeline-style quality control files
generate_xcpqc_files: False
working_directory:
# Directory where C-PAC should store temporary and intermediate files.
# - This directory must be saved if you wish to re-run your pipeline from where you left off (if not completed).
# - NOTE: As it stores all intermediate files, this directory can grow to become very
# large, especially for data with a large amount of TRs.
# - If running in a container (Singularity/Docker), you can simply set this to an arbitrary
# name like '/work', and then map (-B/-v) your desired output directory to that label.
# - If running outside a container, this should be a full path to a directory.
# - This can be written to '/tmp' if you do not intend to save your working directory.
path: /outputs/working
# Deletes the contents of the Working Directory after running.
# This saves disk space, but any additional preprocessing or analysis will have to be completely re-run.
remove_working_dir: True
log_directory:
# Whether to write log details of the pipeline run to the logging files.
run_logging: True
path: /outputs/logs
# Configuration options for logging visualizations of the workflow graph
graphviz:
# Configuration for a graphviz visualization of the entire workflow. See https://fcp-indi.github.io/docs/developer/nodes#CPAC.pipeline.nipype_pipeline_engine.Workflow.write_graph for details about the various options
entire_workflow:
# Whether to generate the graph visualization
generate: Off
# Options: [orig, hierarchical, flat, exec, colored]
graph2use: []
# Options: [svg, png]
format: []
# The node name will be displayed in the form `nodename (package)` when On or `nodename.Class.package` when Off
simple_form: On
crash_log_directory:
# Directory where CPAC should write crash logs.
path: /outputs/crash
system_config:
# Stop worklow execution on first crash?
fail_fast: Off
# Random seed used to fix the state of execution.
# If unset, each process uses its own default.
# If set, a `random.log` file will be generated logging the random seed and each node to which that seed was applied.
# If set to a positive integer (up to 2147483647), that integer will be used to seed each process that accepts a random seed.
# If set to 'random', a random positive integer (up to 2147483647) will be generated and that seed will be used to seed each process that accepts a random seed.
random_seed:
# Select Off if you intend to run CPAC on a single machine.
# If set to On, CPAC will attempt to submit jobs through the job scheduler / resource manager selected below.
on_grid:
run: Off
# Sun Grid Engine (SGE), Portable Batch System (PBS), or Simple Linux Utility for Resource Management (SLURM).
# Only applies if you are running on a grid or compute cluster.
resource_manager: SGE
SGE:
# SGE Parallel Environment to use when running CPAC.
# Only applies when you are running on a grid or compute cluster using SGE.
parallel_environment: mpi_smp
# SGE Queue to use when running CPAC.
# Only applies when you are running on a grid or compute cluster using SGE.
queue: all.q
# The maximum amount of memory each participant's workflow can allocate.
# Use this to place an upper bound of memory usage.
# - Warning: 'Memory Per Participant' multiplied by 'Number of Participants to Run Simultaneously'
# must not be more than the total amount of RAM.
# - Conversely, using too little RAM can impede the speed of a pipeline run.
# - It is recommended that you set this to a value that when multiplied by
# 'Number of Participants to Run Simultaneously' is as much RAM you can safely allocate.
maximum_memory_per_participant: 1
# Prior to running a pipeline C-PAC makes a rough estimate of a worst-case-scenario maximum concurrent memory usage with high-resoltion data, raising an exception describing the recommended minimum memory allocation for the given configuration.
# Turning this option off will allow pipelines to run without allocating the recommended minimum, allowing for more efficient runs at the risk of out-of-memory crashes (use at your own risk)
raise_insufficient: On
# A callback.log file from a previous run can be provided to estimate memory usage based on that run.
observed_usage:
# Path to callback log file with previously observed usage.
# Can be overridden with the commandline flag `--runtime_usage`.
callback_log:
# Percent. E.g., `buffer: 10` would estimate 1.1 * the observed memory usage from the callback log provided in "usage".
# Can be overridden with the commandline flag `--runtime_buffer`.
buffer: 10
# The maximum amount of cores (on a single machine) or slots on a node (on a cluster/grid)
# to allocate per participant.
# - Setting this above 1 will parallelize each participant's workflow where possible.
# If you wish to dedicate multiple cores to ANTS-based anatomical registration (below),
# this value must be equal or higher than the amount of cores provided to ANTS.
# - The maximum number of cores your run can possibly employ will be this setting multiplied
# by the number of participants set to run in parallel (the 'Number of Participants to Run
# Simultaneously' setting).
max_cores_per_participant: 1
# The number of cores to allocate to ANTS-based anatomical registration per participant.
# - Multiple cores can greatly speed up this preprocessing step.
# - This number cannot be greater than the number of cores per participant.
num_ants_threads: 1
# The number of cores to allocate to processes that use OpenMP.
num_OMP_threads: 1
# The number of participant workflows to run at the same time.
# - The maximum number of cores your run can possibly employ will be this setting
# multiplied by the number of cores dedicated to each participant (the 'Maximum Number of Cores Per Participant' setting).
num_participants_at_once: 1
# Full path to the FSL version to be used by CPAC.
# If you have specified an FSL path in your .bashrc file, this path will be set automatically.
FSLDIR: /usr/share/fsl/5.0
Amazon-AWS:
# If setting the 'Output Directory' to an S3 bucket, insert the path to your AWS credentials file here.
aws_output_bucket_credentials:
# Enable server-side 256-AES encryption on data to the S3 bucket
s3_encryption: False
Debugging:
# Verbose developer messages.
verbose: Off
# PREPROCESSING
# -------------
surface_analysis:
# Run freesurfer_abcd_preproc to obtain preprocessed T1w for reconall
abcd_prefreesurfer_prep:
run: Off
# Will run Freesurfer for surface-based analysis. Will output traditional Freesurfer derivatives.
# If you wish to employ Freesurfer outputs for brain masking or tissue segmentation in the voxel-based pipeline,
# select those 'Freesurfer-' labeled options further below in anatomical_preproc.
freesurfer:
run_reconall: Off
# Ingress freesurfer recon-all folder
ingress_reconall: Off
# Add extra arguments to recon-all command
reconall_args:
# Run ABCD-HCP post FreeSurfer and fMRISurface pipeline
post_freesurfer:
run: Off
subcortical_gray_labels: /opt/dcan-tools/pipeline/global/config/FreeSurferSubcorticalLabelTableLut.txt
freesurfer_labels: /opt/dcan-tools/pipeline/global/config/FreeSurferAllLut.txt
surf_atlas_dir: /opt/dcan-tools/pipeline/global/templates/standard_mesh_atlases
gray_ordinates_dir: /opt/dcan-tools/pipeline/global/templates/Greyordinates
gray_ordinates_res: 2
high_res_mesh: 164
low_res_mesh: 32
fmri_res: 2
smooth_fwhm: 2
longitudinal_template_generation:
# If you have multiple T1w's, you can generate your own run-specific custom
# T1w template to serve as an intermediate to the standard template for
# anatomical registration.
# This runs before the main pipeline as it requires multiple T1w sessions
# at once.
run: Off
# Freesurfer longitudinal template algorithm using FSL FLIRT
# Method to average the dataset at each iteration of the template creation
# Options: median, mean or std
average_method: median
# Degree of freedom for FLIRT in the template creation
# Options: 12 (affine), 9 (traditional), 7 (global rescale) or 6 (rigid body)
dof: 12
# Interpolation parameter for FLIRT in the template creation
# Options: trilinear, nearestneighbour, sinc or spline
interp: trilinear
# Cost function for FLIRT in the template creation
# Options: corratio, mutualinfo, normmi, normcorr, leastsq, labeldiff or bbr
cost: corratio
# Number of threads used for one run of the template generation algorithm
thread_pool: 2
# Threshold of transformation distance to consider that the loop converged
# (-1 means numpy.finfo(np.float64).eps and is the default)
convergence_threshold: -1
anatomical_preproc:
run: On
run_t2: Off
# Non-local means filtering via ANTs DenoiseImage
non_local_means_filtering:
# this is a fork option
run: [Off]
# options: 'Gaussian' or 'Rician'
noise_model: 'Gaussian'
# N4 bias field correction via ANTs
n4_bias_field_correction:
# this is a fork option
run: [Off]
# An integer to resample the input image to save computation time. Shrink factors <= 4 are commonly used.
shrink_factor: 2
# Bias field correction based on square root of T1w * T2w
t1t2_bias_field_correction:
run: Off
BiasFieldSmoothingSigma: 5
acpc_alignment:
run: Off
# Run ACPC alignment before non-local means filtering or N4 bias
# correction
run_before_preproc: True
# ACPC size of brain in z-dimension in mm.
# Default: 150mm for human data.
brain_size: 150
# Choose a tool to crop the FOV in ACPC alignment.
# Using FSL's robustfov or flirt command.
# Default: robustfov for human data, flirt for monkey data.
FOV_crop: robustfov
# ACPC Target
# options: 'brain' or 'whole-head'
# note: 'brain' requires T1w_brain_ACPC_template below to be populated
acpc_target: 'whole-head'
# Run ACPC alignment on brain mask
# If the brain mask is in native space, turn it on
# If the brain mask is ACPC aligned, turn it off
align_brain_mask: Off
# ACPC aligned template
T1w_ACPC_template: /usr/share/fsl/5.0/data/standard/MNI152_T1_1mm.nii.gz
T1w_brain_ACPC_template: /usr/share/fsl/5.0/data/standard/MNI152_T1_1mm_brain.nii.gz
T2w_ACPC_template: None
T2w_brain_ACPC_template: None
brain_extraction:
run: On
# using: ['3dSkullStrip', 'BET', 'UNet', 'niworkflows-ants', 'FreeSurfer-ABCD', 'FreeSurfer-BET-Tight', 'FreeSurfer-BET-Loose', 'FreeSurfer-Brainmask']
# this is a fork option
using: ['BET']
# option parameters
AFNI-3dSkullStrip:
# Output a mask volume instead of a skull-stripped volume. The mask volume containes 0 to 6, which represents voxel's postion. If set to True, C-PAC will use this output to generate anatomical brain mask for further analysis.
mask_vol: False
# Set the threshold value controlling the brain vs non-brain voxels. Default is 0.6.
shrink_factor: 0.6
# Vary the shrink factor at every iteration of the algorithm. This prevents the likelihood of surface getting stuck in large pools of CSF before reaching the outer surface of the brain. Default is On.
var_shrink_fac: True
# The shrink factor bottom limit sets the lower threshold when varying the shrink factor. Default is 0.4, for when edge detection is used (which is On by default), otherwise the default value is 0.65.
shrink_factor_bot_lim: 0.4
# Avoids ventricles while skullstripping.
avoid_vent: True
# Set the number of iterations. Default is 250.The number of iterations should depend upon the density of your mesh.
n_iterations: 250
# While expanding, consider the voxels above and not only the voxels below
pushout: True
# Perform touchup operations at the end to include areas not covered by surface expansion.
touchup: True
# Give the maximum number of pixels on either side of the hole that can be filled. The default is 10 only if 'Touchup' is On - otherwise, the default is 0.
fill_hole: 10
# Perform nearest neighbor coordinate interpolation every few iterations. Default is 72.
NN_smooth: 72
# Perform final surface smoothing after all iterations. Default is 20.
smooth_final: 20
# Avoid eyes while skull stripping. Default is On.
avoid_eyes: True
# Use edge detection to reduce leakage into meninges and eyes. Default is On.
use_edge: True
# Speed of expansion.
exp_frac: 0.1
# Perform aggressive push to edge. This might cause leakage. Default is Off.
push_to_edge: False
# Use outer skull to limit expansion of surface into the skull in case of very strong shading artifacts. Use this only if you have leakage into the skull.
use_skull: Off
# Percentage of segments allowed to intersect surface. It is typically a number between 0 and 0.1, but can include negative values (which implies no testing for intersection).
perc_int: 0
# Number of iterations to remove intersection problems. With each iteration, the program automatically increases the amount of smoothing to get rid of intersections. Default is 4.
max_inter_iter: 4
# Multiply input dataset by FAC if range of values is too small.
fac: 1
# Blur dataset after spatial normalization. Recommended when you have lots of CSF in brain and when you have protruding gyri (finger like). If so, recommended value range is 2-4. Otherwise, leave at 0.
blur_fwhm: 0
# Set it as True if processing monkey data with AFNI
monkey: False
FSL-BET:
# Set the threshold value controling the brain vs non-brain voxels, default is 0.5
frac: 0.5
# Mask created along with skull stripping. It should be `On`, if selected functionalMasking : ['Anatomical_Refined'] and `FSL` as skull-stripping method.
mask_boolean: On
# Mesh created along with skull stripping
mesh_boolean: Off
# Create a surface outline image
outline: Off
# Add padding to the end of the image, improving BET.Mutually exclusive with functional,reduce_bias,robust,padding,remove_eyes,surfaces
padding: Off
# Integer value of head radius
radius: 0
# Reduce bias and cleanup neck. Mutually exclusive with functional,reduce_bias,robust,padding,remove_eyes,surfaces
reduce_bias: Off
# Eyes and optic nerve cleanup. Mutually exclusive with functional,reduce_bias,robust,padding,remove_eyes,surfaces
remove_eyes: Off
# Robust brain center estimation. Mutually exclusive with functional,reduce_bias,robust,padding,remove_eyes,surfaces
robust: On
# Create a skull image
skull: Off
# Gets additional skull and scalp surfaces by running bet2 and betsurf. This is mutually exclusive with reduce_bias, robust, padding, remove_eyes
surfaces: Off
# Apply thresholding to segmented brain image and mask
threshold: Off
# Vertical gradient in fractional intensity threshold (-1,1)
vertical_gradient : 0.0
UNet:
# UNet model
unet_model : s3://fcp-indi/resources/cpac/resources/Site-All-T-epoch_36.model
niworkflows-ants:
# Template to be used during niworkflows-ants.
# It is not necessary to change this path unless you intend to use a non-standard template.
# niworkflows-ants Brain extraction template
template_path : /ants_template/oasis/T_template0.nii.gz
# niworkflows-ants probability mask
mask_path : /ants_template/oasis/T_template0_BrainCerebellumProbabilityMask.nii.gz
# niworkflows-ants registration mask (can be optional)
regmask_path : /ants_template/oasis/T_template0_BrainCerebellumRegistrationMask.nii.gz
FreeSurfer-BET:
# Template to be used for FreeSurfer-BET brain extraction in CCS-options pipeline
T1w_brain_template_mask_ccs: /ccs_template/MNI152_T1_1mm_first_brain_mask.nii.gz
segmentation:
# Automatically segment anatomical images into white matter, gray matter,
# and CSF based on prior probability maps.
run: On
tissue_segmentation:
# using: ['FSL-FAST', 'Template_Based', 'ANTs_Prior_Based', 'FreeSurfer']
# this is a fork point
using: ['FSL-FAST']
# option parameters
FSL-FAST:
thresholding:
# thresholding of the tissue segmentation probability maps
# options: 'Auto', 'Custom'
use: 'Auto'
Custom:
# Set the threshold value for the segmentation probability masks (CSF, White Matter, and Gray Matter)
# The values remaining will become the binary tissue masks.
# A good starting point is 0.95.
# CSF (cerebrospinal fluid) threshold.
CSF_threshold_value : 0.95
# White matter threshold.
WM_threshold_value : 0.95
# Gray matter threshold.
GM_threshold_value : 0.95
use_priors:
# Use template-space tissue priors to refine the binary tissue masks generated by segmentation.
run: On
# Full path to a directory containing binarized prior probability maps.
# These maps are included as part of the 'Image Resource Files' package available on the Install page of the User Guide.
# It is not necessary to change this path unless you intend to use non-standard priors.
priors_path: $FSLDIR/data/standard/tissuepriors/2mm
# Full path to a binarized White Matter prior probability map.
# It is not necessary to change this path unless you intend to use non-standard priors.
WM_path: $priors_path/avg152T1_white_bin.nii.gz
# Full path to a binarized Gray Matter prior probability map.
# It is not necessary to change this path unless you intend to use non-standard priors.
GM_path: $priors_path/avg152T1_gray_bin.nii.gz
# Full path to a binarized CSF prior probability map.
# It is not necessary to change this path unless you intend to use non-standard priors.
CSF_path: $priors_path/avg152T1_csf_bin.nii.gz
Template_Based:
# These masks should be in the same space of your registration template, e.g. if
# you choose 'EPI Template' , below tissue masks should also be EPI template tissue masks.
#
# Options: ['T1_Template', 'EPI_Template']
template_for_segmentation: ['T1_Template']
# These masks are included as part of the 'Image Resource Files' package available
# on the Install page of the User Guide.
# Full path to a binarized White Matter mask.
WHITE: $FSLDIR/data/standard/tissuepriors/2mm/avg152T1_white_bin.nii.gz
# Full path to a binarized Gray Matter mask.
GRAY: $FSLDIR/data/standard/tissuepriors/2mm/avg152T1_gray_bin.nii.gz
# Full path to a binarized CSF mask.
CSF: $FSLDIR/data/standard/tissuepriors/2mm/avg152T1_csf_bin.nii.gz
ANTs_Prior_Based:
# Generate white matter, gray matter, CSF masks based on antsJointLabelFusion
# ANTs Prior-based Segmentation workflow that has shown optimal results for non-human primate data.
# The atlas image assumed to be used in ANTs Prior-based Segmentation.
template_brain_list :
- /cpac_templates/MacaqueYerkes19_T1w_0.5mm_desc-JLC_T1w_brain.nii.gz
- /cpac_templates/J_Macaque_11mo_atlas_nACQ_194x252x160space_0.5mm_desc-JLC_T1w_brain.nii.gz
# The atlas segmentation images.
# For performing ANTs Prior-based segmentation method
# the number of specified segmentations should be identical to the number of atlas brain image sets.
# eg.
# ANTs_prior_seg_template_brain_list :
# - atlas1.nii.gz
# - atlas2.nii.gz
# ANTs_prior_seg_template_segmentation_list:
# - segmentation1.nii.gz
# - segmentation1.nii.gz
template_segmentation_list:
- /cpac_templates/MacaqueYerkes19_T1w_0.5mm_desc-JLC_Segmentation.nii.gz
- /cpac_templates/J_Macaque_11mo_atlas_nACQ_194x252x160space_0.5mm_desc-JLC_Segmentation.nii.gz
# Label values corresponding to CSF/GM/WM in atlas file
# It is not necessary to change this values unless your CSF/GM/WM label values are different from Freesurfer Color Lookup Table.
# https://surfer.nmr.mgh.harvard.edu/fswiki/FsTutorial/AnatomicalROI/FreeSurferColorLUT
# Label values corresponding to CSF in multiatlas file
CSF_label : [24]
# Label values corresponding to Gray Matter in multiatlas file
GM_label : [3, 42]
# Label values corresponding to White Matter in multiatlas file
WM_label : [2, 41]
FreeSurfer:
# Use mri_binarize --erode option to erode segmentation masks
erode: 0
# Label values corresponding to CSF in FreeSurfer aseg segmentation file
CSF_label : [24]
# Label values corresponding to Gray Matter in FreeSurfer aseg segmentation file
GM_label : [3, 42]
# Label values corresponding to White Matter in FreeSurfer aseg segmentation file
WM_label : [2, 41]
registration_workflows:
anatomical_registration:
run: On
# The resolution to which anatomical images should be transformed during registration.
# This is the resolution at which processed anatomical files will be output.
resolution_for_anat: 2mm
# Template to be used during registration.
# It is not necessary to change this path unless you intend to use a non-standard template.
T1w_brain_template: /usr/share/fsl/5.0/data/standard/MNI152_T1_${resolution_for_anat}_brain.nii.gz
# Template to be used during registration.
# It is not necessary to change this path unless you intend to use a non-standard template.
T1w_template: /usr/share/fsl/5.0/data/standard/MNI152_T1_${resolution_for_anat}.nii.gz
# Template to be used during registration.
# It is not necessary to change this path unless you intend to use a non-standard template.
T1w_brain_template_mask: /usr/share/fsl/5.0/data/standard/MNI152_T1_${resolution_for_anat}_brain_mask.nii.gz
# Register skull-on anatomical image to a template.
reg_with_skull: True
registration:
# using: ['ANTS', 'FSL', 'FSL-linear']
# this is a fork point
# selecting both ['ANTS', 'FSL'] will run both and fork the pipeline
using: ['ANTS']
# option parameters
ANTs:
# If a lesion mask is available for a T1w image, use it to improve the ANTs' registration
# ANTS registration only.
use_lesion_mask: False
# ANTs parameters for T1-template-based registration
T1_registration:
- collapse-output-transforms: 0
- dimensionality: 3
- initial-moving-transform :
initializationFeature: 0
- transforms:
- Rigid:
gradientStep : 0.1
metric :
type : MI
metricWeight: 1
numberOfBins : 32
samplingStrategy : Regular
samplingPercentage : 0.25
convergence:
iteration : 1000x500x250x100
convergenceThreshold : 1e-08
convergenceWindowSize : 10
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 8x4x2x1
use-histogram-matching : True
- Affine:
gradientStep : 0.1
metric :
type : MI
metricWeight: 1
numberOfBins : 32
samplingStrategy : Regular
samplingPercentage : 0.25
convergence:
iteration : 1000x500x250x100
convergenceThreshold : 1e-08
convergenceWindowSize : 10
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 8x4x2x1
use-histogram-matching : True
- SyN:
gradientStep : 0.1
updateFieldVarianceInVoxelSpace : 3.0
totalFieldVarianceInVoxelSpace : 0.0
metric:
type : CC
metricWeight: 1
radius : 4
convergence:
iteration : 100x100x70x20
convergenceThreshold : 1e-09
convergenceWindowSize : 15
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 6x4x2x1
use-histogram-matching : True
winsorize-image-intensities :
lowerQuantile : 0.01
upperQuantile : 0.99
# Interpolation method for writing out transformed anatomical images.
# Possible values: Linear, BSpline, LanczosWindowedSinc
interpolation: LanczosWindowedSinc
FSL-FNIRT:
# Configuration file to be used by FSL to set FNIRT parameters.
# It is not necessary to change this path unless you intend to use custom FNIRT parameters or a non-standard template.
fnirt_config: T1_2_MNI152_2mm
# The resolution to which anatomical images should be transformed during registration.
# This is the resolution at which processed anatomical files will be output.
# specifically for monkey pipeline
ref_resolution: 2mm
# Reference mask for FSL registration.
ref_mask: /usr/share/fsl/5.0/data/standard/MNI152_T1_${resolution_for_anat}_brain_mask_dil.nii.gz
# Template to be used during registration.
# It is for monkey pipeline specifically.
FNIRT_T1w_brain_template: None
# Template to be used during registration.
# It is for monkey pipeline specifically.
FNIRT_T1w_template: None
# Interpolation method for writing out transformed anatomical images.
# Possible values: trilinear, sinc, spline
interpolation: sinc
# Identity matrix used during FSL-based resampling of anatomical-space data throughout the pipeline.
# It is not necessary to change this path unless you intend to use a different template.
identity_matrix: /usr/share/fsl/5.0/etc/flirtsch/ident.mat
# Reference mask with 2mm resolution to be used during FNIRT-based brain extraction in ABCD-options pipeline.
ref_mask_res-2: /usr/share/fsl/5.0/data/standard/MNI152_T1_2mm_brain_mask_dil.nii.gz
# Template with 2mm resolution to be used during FNIRT-based brain extraction in ABCD-options pipeline.
T1w_template_res-2: /usr/share/fsl/5.0/data/standard/MNI152_T1_2mm.nii.gz
overwrite_transform:
run: Off
# Choose the tool to overwrite transform, currently only support 'FSL' to overwrite 'ANTs' transforms in ABCD-options pipeline.
# using: 'FSL'
using: FSL
functional_registration:
coregistration:
# functional (BOLD/EPI) registration to anatomical (structural/T1)
run: On
# reference: 'brain' or 'restore-brain'
# In ABCD-options pipeline, 'restore-brain' is used as coregistration reference
reference: brain
# Choose FSL or ABCD as coregistration method
using: FSL
# Choose brain or whole-head as coregistration input
input: brain
# Choose coregistration interpolation
interpolation: trilinear
# Choose coregistration cost function
cost: corratio
# Choose coregistration degree of freedom
dof: 6
# Extra arguments for FSL flirt
arguments: None
func_input_prep:
# Choose whether to use functional brain or skull as the input to functional-to-anatomical registration
reg_with_skull: Off
# Choose whether to use the mean of the functional/EPI as the input to functional-to-anatomical registration or one of the volumes from the functional 4D timeseries that you choose.
# input: ['Mean_Functional', 'Selected_Functional_Volume', 'fmriprep_reference']
input: ['Mean_Functional']
Mean Functional:
# Run ANTs’ N4 Bias Field Correction on the input BOLD (EPI)
# this can increase tissue contrast which may improve registration quality in some data
n4_correct_func: False
Selected Functional Volume:
# Only for when 'Use as Functional-to-Anatomical Registration Input' is set to 'Selected Functional Volume'.
#Input the index of which volume from the functional 4D timeseries input file you wish to use as the input for functional-to-anatomical registration.
func_reg_input_volume: 0
boundary_based_registration:
# this is a fork point
# run: [On, Off] - this will run both and fork the pipeline
run: [On]
# Standard FSL 5.0 Scheduler used for Boundary Based Registration.
# It is not necessary to change this path unless you intend to use non-standard MNI registration.
bbr_schedule: /usr/share/fsl/5.0/etc/flirtsch/bbr.sch
# reference for boundary based registration
# options: 'whole-head' or 'brain'
reference: whole-head
# choose which FAST map to generate BBR WM mask
# options: 'probability_map', 'partial_volume_map'
bbr_wm_map: 'probability_map'
# optional FAST arguments to generate BBR WM mask
bbr_wm_mask_args: '-thr 0.5 -bin'
EPI_registration:
# directly register the mean functional to an EPI template
# instead of applying the anatomical T1-to-template transform to the functional data that has been
# coregistered to anatomical/T1 space
run: Off
# using: ['ANTS', 'FSL', 'FSL-linear']
# this is a fork point
# ex. selecting both ['ANTS', 'FSL'] will run both and fork the pipeline
using: ['ANTS']
# EPI template for direct functional-to-template registration
# (bypassing coregistration and the anatomical-to-template transforms)
EPI_template: s3://fcp-indi/resources/cpac/resources/epi_hbn.nii.gz
# EPI template mask.
EPI_template_mask: None
ANTs:
# EPI registration configuration - synonymous with T1_registration
# parameters under anatomical registration above
parameters:
- collapse-output-transforms: 0
- dimensionality: 3
- initial-moving-transform :
initializationFeature: 0
- transforms:
- Rigid:
gradientStep : 0.1
metric :
type : MI
metricWeight: 1
numberOfBins : 32
samplingStrategy : Regular
samplingPercentage : 0.25
convergence:
iteration : 1000x500x250x100
convergenceThreshold : 1e-08
convergenceWindowSize : 10
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 8x4x2x1
use-histogram-matching : True
- Affine:
gradientStep : 0.1
metric :
type : MI
metricWeight: 1
numberOfBins : 32
samplingStrategy : Regular
samplingPercentage : 0.25
convergence:
iteration : 1000x500x250x100
convergenceThreshold : 1e-08
convergenceWindowSize : 10
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 8x4x2x1
use-histogram-matching : True
- SyN:
gradientStep : 0.1
updateFieldVarianceInVoxelSpace : 3.0
totalFieldVarianceInVoxelSpace : 0.0
metric:
type : CC
metricWeight: 1
radius : 4
convergence:
iteration : 100x100x70x20
convergenceThreshold : 1e-09
convergenceWindowSize : 15
smoothing-sigmas : 3.0x2.0x1.0x0.0
shrink-factors : 6x4x2x1
use-histogram-matching : True
winsorize-image-intensities :
lowerQuantile : 0.01
upperQuantile : 0.99
# Interpolation method for writing out transformed EPI images.
# Possible values: Linear, BSpline, LanczosWindowedSinc
interpolation: LanczosWindowedSinc
FSL-FNIRT:
# Configuration file to be used by FSL to set FNIRT parameters.
# It is not necessary to change this path unless you intend to use custom FNIRT parameters or a non-standard template.
fnirt_config: T1_2_MNI152_2mm
# Interpolation method for writing out transformed EPI images.
# Possible values: trilinear, sinc, spline
interpolation: sinc
# Identity matrix used during FSL-based resampling of BOLD-space data throughout the pipeline.
# It is not necessary to change this path unless you intend to use a different template.
identity_matrix: /usr/share/fsl/5.0/etc/flirtsch/ident.mat
func_registration_to_template:
# these options modify the application (to the functional data), not the calculation, of the
# T1-to-template and EPI-to-template transforms calculated earlier during registration
# apply the functional-to-template (T1 template) registration transform to the functional data
run: On
# apply the functional-to-template (EPI template) registration transform to the functional data
run_EPI: Off
output_resolution:
# The resolution (in mm) to which the preprocessed, registered functional timeseries outputs are written into.
# NOTE:
# selecting a 1 mm or 2 mm resolution might substantially increase your RAM needs- these resolutions should be selected with caution.
# for most cases, 3 mm or 4 mm resolutions are suggested.
# NOTE:
# this also includes the single-volume 3D preprocessed functional data,
# such as the mean functional (mean EPI) in template space
func_preproc_outputs: 3mm
# The resolution (in mm) to which the registered derivative outputs are written into.
# NOTE:
# this is for the single-volume functional-space outputs (i.e. derivatives)
# thus, a higher resolution may not result in a large increase in RAM needs as above
func_derivative_outputs: 3mm
target_template:
# choose which template space to transform derivatives towards
# using: ['T1_template', 'EPI_template']
# this is a fork point
# NOTE:
# this will determine which registration transform to use to warp the functional
# outputs and derivatives to template space
using: ['T1_template']
T1_template:
# Standard Skull Stripped Template. Used as a reference image for functional registration.
# This can be different than the template used as the reference/fixed for T1-to-template registration.
T1w_brain_template_funcreg: /usr/share/fsl/5.0/data/standard/MNI152_T1_${func_resolution}_brain.nii.gz
# Standard Anatomical Brain Image with Skull.
# This can be different than the template used as the reference/fixed for T1-to-template registration.
T1w_template_funcreg: /usr/share/fsl/5.0/data/standard/MNI152_T1_${func_resolution}.nii.gz
# Template to be used during registration.
# It is not necessary to change this path unless you intend to use a non-standard template.
T1w_brain_template_mask_funcreg: /usr/share/fsl/5.0/data/standard/MNI152_T1_${func_resolution}_brain_mask.nii.gz
# a standard template for resampling if using float resolution
T1w_template_for_resample: $FSLDIR/data/standard/MNI152_T1_1mm_brain.nii.gz
EPI_template:
# EPI template for direct functional-to-template registration
# (bypassing coregistration and the anatomical-to-template transforms)
EPI_template_funcreg: s3://fcp-indi/resources/cpac/resources/epi_hbn.nii.gz
# EPI template mask.
EPI_template_mask_funcreg: None
# a standard template for resampling if using float resolution
EPI_template_for_resample: $FSLDIR/data/standard/MNI152_T1_1mm_brain.nii.gz
ANTs_pipelines:
# Interpolation method for writing out transformed functional images.
# Possible values: Linear, BSpline, LanczosWindowedSinc
interpolation: LanczosWindowedSinc
FNIRT_pipelines:
# Interpolation method for writing out transformed functional images.
# Possible values: trilinear, sinc, spline
interpolation: sinc