xcp_d.workflows.restingstate.init_alff_wf

xcp_d.workflows.restingstate.init_alff_wf(name_source, output_dir, TR, low_pass, high_pass, smoothing, cifti, mem_gb, omp_nthreads, name='alff_wf')[source]

Compute alff for both nifti and cifti.

Workflow Graph

(Source code)

Parameters:

  • name_source

  • output_dir (str) – Path to the output directory for xcp_d derivatives. This should not include the xcp_d folder. For example, “/path/to/dset/derivatives/”.

  • TR (float) – Repetition time of the BOLD run, in seconds.

  • low_pass (float) – Upper cut-off frequency for the Butterworth bandpass filter, in Hertz. The bandpass filter is applied to the fMRI data after post-processing and denoising. Bandpass filtering will only be performed if bandpass_filter is True. This internal parameter corresponds to the command-line parameter --upper-bpf. If set to <= 0, low-pass filtering will be disabled.

    Default value is 0.08.

  • high_pass (float) – Lower cut-off frequency for the Butterworth bandpass filter, in Hertz. The bandpass filter is applied to the fMRI data after post-processing and denoising. Bandpass filtering will only be performed if bandpass_filter is True. This internal parameter corresponds to the command-line parameter --lower-bpf. If set to <= 0, high-pass filtering will be disabled.

    Default value is 0.01.

  • smoothing (float) – The full width at half maximum (FWHM), in millimeters, of the Gaussian smoothing kernel that will be applied to the post-processed and denoised data. ALFF and ReHo outputs will also be smoothing with this kernel.

  • cifti (bool) – Post-process surface data (CIFTIs) instead of volumetric data (NIFTIs). This parameter is overridden when DCAN- or HCP-format data are provided. Default is False.

  • mem_gb (float) – Memory limit, in gigabytes.

  • omp_nthreads (int) – Maximum number of threads an individual process may use.

  • name (str, optional) – Name of the workflow. This is used for working directories and workflow graphs. Default is “compute_alff_wf”.

Inputs:

  • denoised_bold – residual and filtered

  • bold_mask – bold mask if bold is nifti

  • name_source

Outputs:

  • alff – alff output

  • smoothed_alff – smoothed alff output