Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

brainprep.interfaces.fsaveragesym_projection

brainprep.interfaces.fsaveragesym_projection(left_reg_file, right_reg_file, output_dir, entities, dryrun=False)

Project the different cortical features to the ‘fsaverage_sym’ template space using FreeSurfer’s mris_apply_reg.

Map the left and right hemisphere cortical features to ‘fsaverage_sym’ left hemisphere. This includes the following features: - thickness - curvature - area - localGI - sulc

Parameters:

left_reg_fileFile

Left hemisphere registered to fsaverage_sym symmetric template.

right_reg_fileFile

Right hemisphere registered to fsaverage_sym symmetric template via xhemi.

output_dirDirectory

FreeSurfer working directory containing all the subjects.

entitiesdict

A dictionary of parsed BIDS entities including modality.

dryrunbool

If True, skip actual computation and file writing. Default False.

Returns:

features: tuple[File]

A tuple containing features in the fsaverage_sym symmetric template. Each feature file is a MGH file with the suffix “fsaverage_sym”. The features are returned in the following order: - lh_thickness_file - rh_thickness_file - lh_curv_file - rh_curv_file - lh_area_file - rh_area_file - lh_pial_lgi_file - rh_pial_lgi_file - lh_sulc_file - rh_sulc_file

Notes

• This function is resilient if a feature is missing. In this case a None is returned.