fc_compute_ab_corr

qx_mri.fc.fc_compute_ab_corr(flist, smask, tmask, mask, root, options, verbose)

fc_compute_ab_corr(flist, smask, tmask, mask, root, options, verbose)

Computes the correlation of each source mask voxel with each target mask voxel.

Parameters

--flist (str):

File list with information on sessions bold runs and segmentation files, or a well strucutured string (see general_read_file_list).

--smask (str):

Path to .names file for source mask definition.

--tmask (str):

Path to .names file for target mask roi definition.

--mask (int | logical | vector, default ''):

Either number of frames to omit or a mask of frames to use.

--root (str, default ''):

The root of the filename where results are to be saved.

--options (str, default 'g'):

A string specifying what correlations to save:

• 'g'

  compute mean correlation across sessions (only makes sense with the same sROI for each session)

• 'i'

  save individual sessions' results.

--verbose (str, default 'none'):

How to report the progress: 'full', 'script' or 'none'.

Output files

If group correlations are selected, the resulting files are:

• <root>_group_ABCor_Fz

  Mean Fisher Z value across participants.

• <root>_group_ABCor_r

  Mean Pearson r (converted from Fz) value across participants.

If individual correlations are selected, the resulting files are:

• <root>_<session id>_ABCor

  Pearson r correlations for the individual.

If root is not specified, it is taken to be the root of the flist.

Notes

Use the function to compute individual and/or group correlations of each smask voxel with each tmask voxel. tmask voxels are spread across the volume and smask voxels are spread across the volumes. For more details see img_compute_ab_correlation - nimage method.

Examples

qunex fc_compute_ab_corr \
    --flist='scz.list' \
    --smask='PFC.names' \
    --tmask='ACC.names' \
    --mask=5 \
    --root='SCZ_PFC-ACC' \
    --options='g' \
    --verbose='full'