mrsiprep.interfaces.freesurfer

FreeSurfer helpers.

Functions

check_license()

freesurfer_subject_id(t1_path)

require_command(command)

run_recon_all(t1_path, fs_subjects_dir, subject)

subject_dir_valid(fs_subjects_dir, subject)

Exceptions

FreeSurferError

Raised for FreeSurfer-related failures.

exception mrsiprep.interfaces.freesurfer.FreeSurferError[source]

Bases: RuntimeError

Raised for FreeSurfer-related failures.

mrsiprep.interfaces.freesurfer.check_license()[source]
Return type:

None

mrsiprep.interfaces.freesurfer.freesurfer_subject_id(t1_path)[source]
Parameters:

t1_path (str | Path)

Return type:

str

mrsiprep.interfaces.freesurfer.require_command(command)[source]
Parameters:

command (str)

Return type:

str

mrsiprep.interfaces.freesurfer.run_recon_all(t1_path, fs_subjects_dir, subject, force=False, nthreads=4, verbose=False, debug=None)[source]
Parameters:
  • t1_path (str | Path)

  • fs_subjects_dir (str | Path)

  • subject (str)

  • force (bool)

  • nthreads (int)

  • verbose (bool)

Return type:

Path

mrsiprep.interfaces.freesurfer.subject_dir_valid(fs_subjects_dir, subject)[source]
Parameters:
  • fs_subjects_dir (str | Path)

  • subject (str)

Return type:

bool