Skip to content

Commit a44b9b4

Browse files
committed
re-order parameters in docstrings [skip ds210][skip ds054][skip ds005]
1 parent 949b504 commit a44b9b4

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

fmriprep/workflows/bold/confounds.py

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -427,53 +427,52 @@ def init_ica_aroma_wf(template, metadata, mem_gb, omp_nthreads,
427427
428428
**Parameters**
429429
430-
aroma_melodic_dim: int or None
431-
Set the dimensionality of the Melodic ICA decomposition
432-
If None, MELODIC automatically estimates dimensionality.
433-
ignore_aroma_err : bool
434-
Do not fail on ICA-AROMA errors
435-
mem_gb : float
436-
Size of BOLD file in GB
437-
metadata : dict
438-
BIDS metadata for BOLD file
439-
name : str
440-
Name of workflow (default: ``bold_mni_trans_wf``)
441-
omp_nthreads : int
442-
Maximum number of threads an individual process may use
443430
template : str
444431
Spatial normalization template used as target when that
445432
registration step was previously calculated with
446433
:py:func:`~fmriprep.workflows.bold.registration.init_bold_reg_wf`.
447434
The template must be one of the MNI templates (fMRIPrep uses
448435
``MNI152NLin2009cAsym`` by default).
436+
metadata : dict
437+
BIDS metadata for BOLD file
438+
mem_gb : float
439+
Size of BOLD file in GB
440+
omp_nthreads : int
441+
Maximum number of threads an individual process may use
442+
name : str
443+
Name of workflow (default: ``bold_mni_trans_wf``)
449444
susan_fwhm : float
450445
Kernel width (FWHM in mm) for the smoothing step with
451446
FSL ``susan`` (default: 6.0mm)
452447
use_fieldwarp : bool
453448
Include SDC warp in single-shot transform from BOLD to MNI
454-
449+
ignore_aroma_err : bool
450+
Do not fail on ICA-AROMA errors
451+
aroma_melodic_dim: int or None
452+
Set the dimensionality of the Melodic ICA decomposition
453+
If None, MELODIC automatically estimates dimensionality.
455454
456455
**Inputs**
457-
bold_mask
458-
BOLD series mask in template space
456+
457+
itk_bold_to_t1
458+
Affine transform from ``ref_bold_brain`` to T1 space (ITK format)
459+
t1_2_mni_forward_transform
460+
ANTs-compatible affine-and-warp transform file
461+
name_source
462+
BOLD series NIfTI file
463+
Used to recover original information lost during processing
464+
skip_vols
465+
number of non steady state volumes
459466
bold_split
460467
Individual 3D BOLD volumes, not motion corrected
461-
fieldwarp
462-
a :abbr:`DFM (displacements field map)` in ITK format
468+
bold_mask
469+
BOLD series mask in template space
463470
hmc_xforms
464471
List of affine transforms aligning each volume to ``ref_image`` in ITK format
465-
itk_bold_to_t1
466-
Affine transform from ``ref_bold_brain`` to T1 space (ITK format)
472+
fieldwarp
473+
a :abbr:`DFM (displacements field map)` in ITK format
467474
movpar_file
468475
SPM-formatted motion parameters file
469-
skip_vols
470-
number of non steady state volumes
471-
name_source
472-
BOLD series NIfTI file
473-
Used to recover original information lost during processing
474-
t1_2_mni_forward_transform
475-
ANTs-compatible affine-and-warp transform file
476-
477476
478477
**Outputs**
479478

0 commit comments

Comments
 (0)