general_extract_roi_values#

qx_mri.general.general_extract_roi_values(roif, mfs, sefs, vnames, output, stats, verbose)#

general_extract_roi_values(roif, mfs, sefs, vnames, output, stats, verbose)

Extracts desired statistics from provided files for each ROI.

Parameters

--roif (str):

ROI file, either a names file or a mask file.

--mfs (str):

Comma separated list of files to extract values from.

--sefs (str, default ''):

Optional list of comma separate files that hold SE for value files.

--vnames (str, default ''):

Optional comma separated list of value names to use for each of the files.

--output (str, default ''):

Comma separated list of files to save to. If a file contains the word long, it will save the data in a long format. By default it saves the data in a wide format.

--stats (str, default 'rsize, rmean, mean'):

A comma separated list of the statistics to save:

  • 'rsize' ... size of ROI in voxels

  • 'rmean' ... location of the geometric mean of the ROI

  • 'rpeak' ... location of the peak value of the ROI

  • 'rmin' ... location of the minimum value in the ROI

  • 'rmax' ... location of the maxumal value in the ROI

  • 'mean' ... mean of values across ROI

  • 'median' ... median value across ROI

  • 'min' ... minimum value across ROI

  • 'max' ... mamimum value across ROI

  • 'peak' ... peak value in the ROI (largest absolute value).

--verbose (bool, default false):

To report on progress or not.

Returns

report