fs_surfaceset.h File Reference

Bi-hemispheric grouping of FreeSurfer surfaces (lh + rh) loaded as a single object. More...

#include "fs_global.h"
#include "fs_surface.h"
#include <QSharedPointer>
#include <QMap>

Include dependency graph for fs_surfaceset.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	FSLIB::FsSurfaceSet
	Container holding the lh and/or rh FsSurface for one subject and one surface kind. More...

Namespaces
namespace	FSLIB
	FreeSurfer surface, annotation and parcellation I/O for mne-cpp.

Detailed Description

Bi-hemispheric grouping of FreeSurfer surfaces (lh + rh) loaded as a single object.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2026 MNE-CPP Authors

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

2.0.0

Date

March 2026

Cortical analyses in FreeSurfer/MNE typically operate on a pair of hemisphere surfaces of the same kind (both pial, both white, both inflated, both sphere …) read from $SUBJECTS_DIR/ <id>/surf/lh.<surf> and the matching rh.<surf>. FsSurfaceSet wraps that pair as a single in-memory object so downstream code (annotations, source spaces, BEM, rendering) can iterate over {lh, rh} without re-parsing or re-resolving paths.

The class accepts the same three locator forms as FsSurface: subject + hemi + surf resolved against $SUBJECTS_DIR, a direct directory + hemi + surf path, or explicit lh / rh file paths. The hemi argument follows the FreeSurfer/MNE convention {0 = lh, 1 = rh, 2 = both}; only the requested hemispheres are loaded.

Definition in file fs_surfaceset.h.