mne_rt.resolve_rois

mne_rt.resolve_rois(names: str | Sequence, *, atlas: str, subject: str = 'fsaverage', subjects_dir=None) → list[ROI]

Resolve ROI names (or aliases, or explicit label groups) into ROI objects.

Parameters:

namesstr | sequence

Each entry may be:

• an alias from ROI_ALIASES (e.g. "Broca"),

• a bare atlas label name (e.g. "Left-Hippocampus"),

• a {name: [label, ...]} mapping, or a (name, [label, ...]) pair, to define an ROI explicitly.

atlasstr

Volumetric atlas stem or surface annotation name.

subjectstr

FreeSurfer subject identifier.

subjects_dirpath-like | None

FreeSurfer subjects directory.

Returns:

roislist of ROI

Raises:

ValueError

If a label name is not present in the atlas. The message lists close matches to make typos easy to spot.