Skip to content

Pipeline Parameters

Define where the pipeline should find input data and save output data.

ParameterDescriptionTypeDefaultRequiredHidden
inputPath to the BIDS directory location.
HelpEnsure the BIDS data structure is respected. For more information, see the documentation
string
participant_labelList of participant IDs or a single participant ID.
HelpThis will be used to select the specific participants to process. The best way to provide them is in a params.yml file, see the documentation for more information.
['array', 'string']
input_derivPath to the derivatives directory to use as input.string
outdirThe output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
HelpFor a detailed description of the output files, please see the documentation.
stringTrue
templates_urlURL to download templates from.stringhttps://osf.io/Kd8h7/downloadTrue
templates_download_pathPath to the directory where templates will be downloaded and cached.stringTrue
gpu_typeType of GPU models (or MIG) to use when submitting GPU jobs to HPC clusters using -profile slurm,gpu. This should not be needed outside of HPC environments.stringFalse
emailEmail address for completion summary.
HelpSet this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config) then you don’t need to specify this on the command line for every run.
stringTrue
multiqc_title_subjectMultiQC report title for subject report. Printed as page header, used for filename if not otherwise specified.stringTrue
multiqc_title_globalMultiQC report title for global report. Printed as page header, used for filename if not otherwise specified.stringTrue

Options for FreeSurfer or FastSurfer processing. Only relevant if you select the segmentation profile.

ParameterDescriptionTypeDefaultRequiredHidden
methodMethod to use to perform surface reconstruction and cortical/subcortical segmentation. Will only affect subjects > 1 year of age. Recon-all-clinical is highly recommended for subjects between 1 year and 5 years old (and above). Options include recon-all, recon-all-clinical, or FastSurfer. (accepted: recon-all-clinical|recon-all|fastsurfer)stringrecon-all-clinicalFalse
fs_licensePath to FreeSurfer license file.
HelpThis is required to run the segmentation profile. You can obtain a FreeSurfer license from the FreeSurfer website here.
string
cerebnetUse CerebNet for cerebellum segmentation in FastSurfer.booleanFalseTrue
hypvinnUse HypVINN for hypothalamus sub-segmentation in FastSurfer.booleanFalseTrue
acq3TUse 3T acquisition parameters.booleanTrueTrue
fs_output_dirPath to FreeSurfer/FastSurfer output directory.
HelpDefault location will be alongside --outdir. For more information, please see the documentation
stringFalse

Options for atlases used in the pipeline.

ParameterDescriptionTypeDefaultRequiredHidden
atlas_nameName of the atlas to use. This will determine the BIDS atlas to use. Multiple values can be specified.stringBrainnetomeChildFalse
atlas_folderPath to the directory containing the atlases. This should be a directory containing the atlases in BIDS format. If not specified, will search in the default location (‘$projectDir/assets/’).stringFalse
subcortical_roisIndexes of the subcortical ROIs in the atlas to use in the QC report. Will mostly be used to properly separate cortical and subcortical ROIs in the QC report. Should be provided as a string of comma-separated values or ranges (e.g. ‘189:224’).string189:224False

Options for T1w processing. In the case where you do not have a T1w image, you can ignore those options.

ParameterDescriptionTypeDefaultRequiredHidden
run_t1_denoisingRun denoising on the T1w images.booleanTrueFalse
run_t1_n4Run N4 bias correction on the T1w images.booleanTrueFalse
run_t1_resamplingRun resampling on the T1w images.booleanTrueFalse
run_t1_cropRun cropping on the T1w images.booleanTrueFalse
t1_denoise_number_of_coilsNumber of coils used in the T1w denoising step.integer1True
t1_bias_bspline_knot_per_voxelNumber of B-spline knots per voxel used in the T1w bias correction step.number8True
t1_bias_shrink_factorShrink factor used in the T1w bias correction step.integer4True
t1_resample_voxel_sizeVoxel size used in the T1w resampling step.integer1True
t1_resample_interpInterpolation method used in the T1w resampling step.stringlinTrue
t1_synthstrip_borderMask border threshold used in the SynthStrip brain extraction step.integer1True
t1_synthstrip_nocsfExclude CSF from the border in the SynthStrip brain extraction step.booleanFalseTrue

Options for T2w preprocessing. In the case where you do not have a T2w image, you can ignore those options.

ParameterDescriptionTypeDefaultRequiredHidden
run_t2_denoisingRun denoising on the T2w images.booleanTrueFalse
run_t2_n4Run N4 bias correction on the T2w images.booleanTrueFalse
run_t2_resamplingRun resampling on the T2w images.booleanTrueFalse
run_t2_cropRun cropping on the T2w images.booleanTrueFalse
t2_denoise_number_of_coilsNumber of coils used in the T2w denoising step.integer1True
t2_bias_bspline_knot_per_voxelNumber of B-spline knots per voxel used in the T2w bias correction step.number8True
t2_bias_shrink_factorShrink factor used in the T2w bias correction step.integer4True
t2_resample_voxel_sizeVoxel size used in the T2w resampling step.integer1True
t2_resample_interpInterpolation method used in the T2w resampling step.stringlinTrue
t2_synthstrip_borderMask border threshold used in the SynthStrip brain extraction step.integer1True
t2_synthstrip_nocsfExclude CSF from the border in the SynthStrip brain extraction step.booleanFalseTrue

Options for anatomical co-registration. Will only be performed if both T2w and T1w images are available.

ParameterDescriptionTypeDefaultRequiredHidden
coreg_dimensionalityDimensionality of the registered images.integer3True
coreg_transformTransform used in the coregistration step. t: translation (1 stage), r: rigid (1 stage), a: rigid + affine (2 stages), s: rigid + affine + deformable syn (3 stages) (accepted: t|r|a|s)stringaFalse
coreg_quickUse antsRegistrationSyNQuick for the coregistration step.booleanFalseFalse

Options for DWI preprocessing. You can use these options to customise the behaviour of the DWI preprocessing steps.

ParameterDescriptionTypeDefaultRequiredHidden
dwi_b0_thresholdB0 threshold used in the DWI preprocessing steps.integer20False
dwi_shell_toleranceShell tolerance used in the DWI preprocessing steps.integer50False
run_dwi_denoisingRun denoising on the DWI images.booleanTrueFalse
dwi_denoise_patch_sizePatch size used in the DWI denoising step.integer7True
run_dwi_degibbsRun Gibbs ringing correction on the DWI images.booleanFalseFalse
run_dwi_topupRun topup in the susceptibility distortion correction step.booleanTrueFalse
dwi_susceptibility_config_filePath to the susceptibility distortion correction config file.stringb02b0.cnfTrue
dwi_susceptibility_output_prefixPrefix used in the susceptibility distortion correction step.stringtopup_resultsTrue
dwi_susceptibility_readoutReadout time used in the susceptibility distortion correction step.number0.04True
dwi_susceptibility_encoding_dirEncoding direction used in the susceptibility distortion correction step.stringyTrue
run_dwi_eddyRun eddy in the eddy current correction step.booleanTrueFalse
dwi_motion_and_eddy_commandCommand used in the motion and eddy correction step.stringeddy_cpuTrue
dwi_motion_and_eddy_bet_f_thresholdBet f threshold used in the motion and eddy correction step.number0.16True
dwi_motion_and_eddy_restore_slicesRestore slices in the motion and eddy correction step.booleanTrueTrue
dwi_pwdavg_shellsShells used in the PowderAverage step.stringFalse
dwi_synthstrip_borderBrain border used in the SynthStrip brain extraction step.integer1True
dwi_synthstrip_nocsfExclude CSF from the border in the SynthStrip brain extraction step.booleanFalseTrue
dwi_bet_f_thresholdBet f threshold used in the brain extraction step.number0.16True
run_dwi_n4Run N4 bias correction on the DWI images.booleanTrueFalse
dwi_bias_bspline_knot_per_voxelNumber of B-spline knots per voxel used in the DWI bias correction step.number8True
dwi_bias_shrink_factorShrink factor used in the DWI bias correction step.integer4True
run_dwi_normalizeRun normalization on the DWI images.booleanTrueFalse
dwi_normalize_fa_mask_thresholdFA mask threshold used in the normalization step.number0.4False
run_dwi_resamplingRun resampling on the DWI images.booleanTrueFalse
dwi_resample_voxel_sizeVoxel size used in the DWI resampling step.integer1True
dwi_resample_interpInterpolation method used in the DWI resampling step.stringlinTrue
dwi_resample_mask_voxel_sizeVoxel size used in the DWI mask resampling step.integer1True
dwi_resample_mask_interpInterpolation method used in the DWI mask resampling step.stringnnTrue

Options for diffusion tensor fitting.

ParameterDescriptionTypeDefaultRequiredHidden
dti_max_shell_valueMaximum shell value used in the DTI processing step.integer1200False
dti_shellsShells used in the DTI processing step.stringFalse

Options for fiber response function (FRF) processing. The FRF is derived from normative curves in function of each participant’s age. The current options are mostly if you want to override this default behavior.

ParameterDescriptionTypeDefaultRequiredHidden
frf_faInitial minimum FA threshold to use to compute the FRF.number0.7True
frf_min_faIf frf_fa does not extract enough voxels, this is the minimum FA threshold that will be tried.number0.5True
frf_nvox_minMinimum number of voxels to include in the computation of the FRF.integer300True
frf_roi_radiusRadius of the ROI used to compute the FRF.integer20True
frf_set_methodMethod used to compute the FRF. (accepted: ssst)stringssstFalse
frf_manual_frfManual FRF values.(e.g. ‘15,4,4’). This is set from the normative curves. Use this option only to apply a single FRF to every participants. For more information, please see the documentation.stringFalse

Options for FODF processing.

ParameterDescriptionTypeDefaultRequiredHidden
fodf_min_shell_valueMinimum FODF shell value used.integer700False
fodf_shellsShells used in the FODF processing step.stringFalse
fodf_sh_orderSpherical harmonics order used in the FODF processing step.integer8False
fodf_sh_basisSpherical harmonics basis used in the FODF processing step. Choices: descoteaux07 or tournier07. (accepted: descoteaux07|tournier07)stringdescoteaux07False
fodf_set_methodMethod used to compute the FODF. (accepted: ssst)stringssstFalse
fodf_relative_thresholdRelative threshold used in the FODF processing step.number0.1True
fodf_a_factorFODF a factor used in the FODF processing step.number2.0True
fodf_max_fa_thresholdMaximum FA threshold used in the FODF processing step.number0.1True
fodf_min_md_thresholdMinimum MD threshold used in the FODF processing step.number0.002True

Options for Particle Filter Tracking (PFT).

ParameterDescriptionTypeDefaultRequiredHidden
run_pft_trackingRun PFT tracking.booleanTrueFalse
pft_seeding_mask_typeSeeding mask type used in the PFT tracking step. Choices: wm, fa, or interface. (accepted: wm|fa|interface)stringwmFalse
pft_fa_thresholdFA threshold to use on FA map to generate seeding mask.number0.2True
pft_random_seedRandom seed used in the PFT tracking step.integer1234True
pft_compressIf true, compress the streamlines.booleanTrueTrue
pft_compress_valueCompression value for the streamlines’ compression.number0.2True
pft_algoAlgorithm used in the PFT tracking step. Choices: prob or det (accepted: prob|det)stringprobFalse
pft_nbr_seedsNumber of seeds used in the PFT tracking step.integer10False
pft_seeding_typeSeeding type used in the PFT tracking step. Choices: npv or nt. (accepted: npv|nt)stringnpvFalse
pft_stepStep value used in the PFT tracking step.number0.5True
pft_thetaTheta value used in the PFT tracking step.number20True
pft_sfthresSF threshold used in the PFT tracking step.number0.1True
pft_sfthres_initInitial SF threshold used in the PFT tracking step.number0.5True
pft_min_lenMinimum length used in the PFT tracking step.number20False
pft_max_lenMaximum length used in the PFT tracking step.number200False
pft_particlesNumber of particles used in the PFT tracking step.integer15True
pft_backLength of PFT back tracking (mm)integer2True
pft_frontLength of PFT forward tracking (mm).integer1True

Options for local tracking.

ParameterDescriptionTypeDefaultRequiredHidden
run_local_trackingRun local tracking.booleanTrueFalse
local_seeding_mask_typeSeeding mask type used in the local tracking step. (accepted: wm|fa)stringwmFalse
local_fa_tracking_mask_thresholdFA threshold used for the tracking mask.number0.4True
local_fa_seeding_mask_thresholdFA threshold used for the seeding mask.number0.4True
local_tracking_mask_typeTracking mask type used in the local tracking step. Choices: wm, fa, or interface. (accepted: wm|fa)stringwmFalse
local_random_seedRandom seed used in the local tracking step.integer1234True
local_compressIf true, compress the streamlines.booleanTrueTrue
local_compress_valueCompression value for the streamlines’ compression.number0.2True
local_algoAlgorithm used in the local tracking step. Choices: prob or det (accepted: prob|det)stringprobFalse
local_nbr_seedsNumber of seeds used in the local tracking step.integer10False
local_seeding_typeSeeding type used in the local tracking step. Choices: npv or nt. (accepted: npv|nt)stringnpvFalse
local_stepStep value used in the local tracking step.number0.5True
local_thetaTheta value used in the local tracking step.number20True
local_sfthresSF threshold used in the local tracking step.number0.1True
local_min_lenMinimum length used in the local tracking step.number20False
local_max_lenMaximum length used in the local tracking step.number200False

Parameters for tuning diffusivities used in models fitting

ParameterDescriptionTypeDefaultRequiredHidden
average_diff_priorsIf set to true, will compute the average diffusivities for the NODDI/Freewater models and average them across all subjects to use as fixed diffusivities for all subjects.booleanFalseFalse
para_diffParallel diffusivity value to use in models fitting (in mm^2/s). If not set, it will be derived from normative growth curves based on participant’s age.numberFalse
iso_diffIsotropic diffusivity value to use in models fitting (in mm^2/s). If not set, it will be derived from normative growth curves based on participant’s age.numberFalse
perp_diffPerpendicular diffusivity value to use in models fitting (in mm^2/s). If not set, it will be derived from normative growth curves based on participant’s age.numberFalse
perp_diff_minMinimum perpendicular diffusivity value (in mm^2/s) to use in models fitting. If not set, it will be derived from normative growth curves based on participant’s agenumberFalse
perp_diff_maxMaximum perpendicular diffusivity value (in mm^2/s) to use in models fitting. If not set, it will be derived from normative growth curves based on participant’s agenumberFalse

Options for NODDI model fitting.

ParameterDescriptionTypeDefaultRequiredHidden
run_noddiWhether to run the NODDI processing step. If selected, the resulting metric maps will be added to the list used in the bundling and connectomics profile. NODDI is only available for multi-shell acquisitions, for single-shell acquisitions, please consider using Freewater model instead.booleanFalseFalse
noddi_lambda1Value to use as the first regularization parameter (lambda1) in the NODDI fitting process.number0.5True
noddi_lambda2Value to use as the second regularization parameter (lambda2) in the NODDI fitting process.number0.001True

Options for Freewater model fitting.

ParameterDescriptionTypeDefaultRequiredHidden
run_freewaterWhether to run the Freewater processing step. If selected, the resulting metric maps will be added to the list used in the bundling and connectomics profile.booleanFalseFalse
freewater_lambda1Value to use as the first regularization parameter (lambda1) in the Freewater fitting process.number0True
freewater_lambda2Value to use as the second regularization parameter (lambda2) in the Freewater fitting process.number0.25True

Options for BundleSeg

ParameterDescriptionTypeDefaultRequiredHidden
atlas_directoryPath to the WM bundles atlas directory.
HelpThis allows you to specify a custom atlas for bundle segmentation. If not provided, the default atlas included with the pipeline will be used. NOTE: The provided atlas will be used with all participants without accounting for age.
stringNoneFalse
minimal_vote_ratioRatio of vote across models to consider a streamline for saving. If you have 5 input models and a ratio of 0.5, you will need at least 3 votes.number0.5True
outlier_alphaPercentage of the length of the tree that clusters of individual streamlines will be pruned. Higher values will remove more streamlines.number0.6True
nb_pointsNumber of points to segment the bundles.integer5False
colormapColormap to use for coloring the bundles. Color only affects visualization.stringjetFalse
use_hyperplaneIf set, will use hyperplane to segment bundles (still experimental), otherwise, will use the euclidean distance.booleanFalseFalse
use_manhattanIf set, will use manhattan distance to segment bundles, otherwise, will use the euclidean distance.booleanFalseFalse
density_weightingIf set, weight statistics based on the number of voxel going through the voxel.booleanTrueTrue
normalize_weightsIf set, the weights will be normalized to the [0,1] range.booleanTrueTrue
length_statsIf set, will output bundles’ length.booleanTrueFalse
endpoints_statsIf set, will output statistics in endpoints.booleanTrueFalse
means_stdIf set, will output mean and std values per bundle per metrics.booleanTrueFalse
volumeIf set, will output volume values per bundle.booleanTrueFalse
streamline_countIf set, will output the streamline count per bundle.booleanTrueFalse
volume_per_labelsIf set, will output volume values per labels per bundle.booleanTrueFalse
mean_std_per_pointIf set, will output mean and std per points per metrics per bundle.booleanTrueFalse

Options for transforming labels from anatomical to diffusion space.

ParameterDescriptionTypeDefaultRequiredHidden
labels_transform_dimensionalityDimensionality of the label file.integer3True
labels_output_suffixName to use as suffix in the output filename.string_labelsTrue
labels_interpolationInterpolation method used in the label transformation step. Choices: NearestNeighbor, Linear, or BSpline. (accepted: NearestNeighbor|Linear|BSpline)stringNearestNeighborTrue
labels_output_dtypeOutput data type used in the label transformation step. Choices: float or int. (accepted: float|int)stringintTrue

Options for COMMIT filtering.

ParameterDescriptionTypeDefaultRequiredHidden
run_commit2Run COMMIT2 filtering.booleanTrueFalse
commit2_lambdaLambda value used in the COMMIT filtering step.number0.001True
commit_ball_stickUse the ball and stick model in the COMMIT filtering step.booleanFalseTrue
commit_nbr_dirNumber of directions used in the COMMIT filtering step.integer500True

Options for decomposing the tractogram according to a label file.

ParameterDescriptionTypeDefaultRequiredHidden
decompose_no_pruningDo not prune the tractogram.booleanFalseTrue
decompose_no_remove_loopsDo not remove loops from the tractogram.booleanFalseTrue
decompose_no_remove_outliersDo not remove outliers from the tractogram.booleanFalseTrue
decompose_no_remove_curvDo not remove curvilinear structures from the tractogram.booleanFalseTrue
decompose_min_lenMinimum length used in the tractogram decomposition step.number20False
decompose_max_lenMaximum length used in the tractogram decomposition step.number200False
decompose_outlier_thresholdOutlier threshold used in the tractogram decomposition step.number0.6False
decompose_max_angleMaximum angle used in the tractogram decomposition step.number330.0False
decompose_max_curvMaximum curvature used in the tractogram decomposition step.number10.0False

Options for AFD fixel processing.

ParameterDescriptionTypeDefaultRequiredHidden
afd_fixel_length_weightingUse length weighting in the AFD fixel processing step.booleanFalseTrue

Options for outputting to specific template space.

ParameterDescriptionTypeDefaultRequiredHidden
templateTemplate space to output to. The available template are the ones supported by TemplateFlow, please see their documentation for an exhaustive list (https://www.templateflow.org/browse/).stringNoneFalse
templateflow_resResolution of the template space.integer1False
templateflow_cohortCohort to use for the template space (not required for most template, but if it is, simply provide the cohort’s number).integerFalse
templateflow_homePath to the TemplateFlow home directory where templates will be downloaded. If you are running the pipeline without internet access, this needs to point to a folder containing predownloaded templates.string./templateflowFalse

Parameters used to describe centralised config profiles. These should not be edited.

ParameterDescriptionTypeDefaultRequiredHidden
custom_config_versionGit commit id for Institutional configs.stringmasterTrue
custom_config_baseBase directory for Institutional configs.
HelpIf you’re running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don’t need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterTrue
config_profile_nameInstitutional config name.stringTrue
config_profile_descriptionInstitutional config description.stringTrue
config_profile_contactInstitutional config contact information.stringTrue
config_profile_urlInstitutional config URL link.stringTrue

Less common options for the pipeline, typically set in a config file.

ParameterDescriptionTypeDefaultRequiredHidden
versionDisplay version and exit.booleanTrue
publish_dir_modeMethod used to save pipeline results to output directory. (accepted: symlink|rellink|link|copy|copyNoFollow|move)
HelpThe Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.
stringcopyTrue
lean_outputDo not copy intermediate files to output directory.booleanTrue
email_on_failEmail address for completion summary, only when pipeline fails.
HelpAn email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.
stringTrue
plaintext_emailSend plain-text email instead of HTML.booleanTrue
max_multiqc_email_sizeFile size limit when attaching MultiQC reports to summary emails.string25.MBTrue
monochrome_logsDo not use coloured log outputs.booleanTrue
multiqc_configCustom config file to supply to MultiQC.stringTrue
multiqc_logoCustom logo file to supply to MultiQC. File name must also be set in the MultiQC config filestringTrue
multiqc_methods_descriptionCustom MultiQC yaml file containing HTML including a methods description.stringTrue
validate_paramsBoolean whether to validate parameters against the schema at runtimebooleanTrueTrue
trace_report_suffixSuffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.stringTrue
helpDisplay the help message.['boolean', 'string']
help_fullDisplay the full detailed help message.boolean
show_hiddenDisplay hidden parameters in the help message (only works when —help or —help_full are provided).boolean

Pipeline profile options. This is a short list of options. For full description, please see the documentation

ParameterDescriptionTypeDefaultRequiredHidden
trackingPerform tracking profile.booleanFalseTrue
bundlingPerform bundle extraction profile.booleanFalseTrue
connectomicsPerform connectomics profile.booleanFalseTrue
segmentationPerform segmentation profile.booleanFalseTrue