fs_annotationset.h File Reference

Bi-hemispheric pair of FreeSurfer annotations (lh + rh) for one parcellation atlas. More...

#include "fs_global.h"
#include "fs_annotation.h"
#include <QString>
#include <QSharedPointer>
#include <QMap>
#include <Eigen/Core>

Include dependency graph for fs_annotationset.h:

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

Go to the source code of this file.

Classes
class	FSLIB::FsAnnotationSet
	Container holding the lh and/or rh FsAnnotation for one parcellation atlas. More...

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

Detailed Description

Bi-hemispheric pair of FreeSurfer annotations (lh + rh) for one parcellation atlas.

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

Whole-brain parcellation analyses load one annotation file per hemisphere — typically lh.aparc.annot and rh.aparc.annot — that share an atlas-specific colortable but assign labels independently per hemisphere. FsAnnotationSet bundles both into a single container so downstream code can iterate over hemispheres uniformly and pair the result with a matching FsSurfaceSet of the same subject.

The class accepts the standard FreeSurfer atlas names exposed by recon-all (aparc, aparc.a2009s, aparc.DKTatlas40, BA, BA.thresh, custom atlases produced by mris_ca_label…) and resolves them against $SUBJECTS_DIR/ <id>/label/{lh|rh}.<atlas>.annot, mirroring the path convention used by mne.read_labels_from_annot in MNE-Python.

Definition in file fs_annotationset.h.