fs_label.h File Reference

Reader and in-memory representation of a FreeSurfer/MNE surface label (.label). More...

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

Include dependency graph for fs_label.h:

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

Go to the source code of this file.

Classes
class	FSLIB::FsLabel
	A FreeSurfer/MNE surface label: per-vertex indices, Tk-RAS positions and scalar values for one hemisphere. More...

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

Macros
#define	metatype_label

Functions
	Q_DECLARE_METATYPE (FSLIB::FsLabel)

Detailed Description

Reader and in-memory representation of a FreeSurfer/MNE surface label (.label).

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

A FreeSurfer .label file describes a region of interest on a cortical surface as an explicit list of vertex indices restricted to one hemisphere. The file is plain ASCII: a comment line, a vertex count, then one whitespace-separated row per vertex of the form "index x y z value" where (x, y, z) is the Tk-surface RAS position in millimetres and value is an optional scalar (statistic, cluster weight, time, …). The format is shared with MNE-Python (mne.Label) and with mri_annotation2label, which is how individual regions of a parcellation are persisted as standalone labels.

This class loads such a file, keeps the indices, positions and values together with the hemisphere id and a human-readable label name, and provides helpers to project the label back onto a triangulation (FsLabel::selectTris) so it can be drawn or fed into source-space masking.

Definition in file fs_label.h.

Macro Definition Documentation

metatype_label

#define metatype_label

Definition at line 189 of file fs_label.h.

Function Documentation

Q_DECLARE_METATYPE()

Q_DECLARE_METATYPE

(

FSLIB::FsLabel

)