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.freesurfer.surfreg

brainprep.interfaces.freesurfer.surfreg(output_dir, entities)[source]

Surface-based registration to fsaverage_sym symmetric template.

  1. Registers the left hemisphere to the fsaverage_sym symmetric template.

  2. Registers the right hemisphere (already aligned to the left via xhemireg) to fsaverage_sym - use the interhemispheric registration surface (rh.sphere.reg.xhemi) instead of the standard one (rh.sphere.reg).

Parameters:
output_dirDirectory

FreeSurfer working directory containing all the subjects.

entitiesdict

A dictionary of parsed BIDS entities including modality.

Returns:
commandlist[str]

Registration command-line.

outputstuple[File]

  • left_reg_file : File - Left hemisphere registered to fsaverage_sym symmetric template.

  • right_reg_file : File - Right hemisphere registered to fsaverage_sym symmetric template via xhemi.