FSLIB::Label Class Reference

Freesurfer/MNE label. More...

#include <label.h>

Public Types
typedef QSharedPointer< Label >	SPtr
typedef QSharedPointer< const Label >	ConstSPtr

Public Member Functions
	Label ()
	Label (const Eigen::VectorXi &p_vertices, const Eigen::MatrixX3f &p_pos, const Eigen::VectorXd &p_values, qint32 p_hemi, const QString &p_name, qint32 p_id=-1)
	~Label ()
void	clear ()
bool	isEmpty () const
Eigen::MatrixX3i	selectTris (const Surface &p_Surface)
Eigen::MatrixX3i	selectTris (const Eigen::MatrixX3i &p_matTris)

Static Public Member Functions
static bool	read (const QString &p_sFileName, Label &p_Label)

Public Attributes
QString	comment
Eigen::VectorXi	vertices
Eigen::MatrixX3f	pos
Eigen::VectorXd	values
qint32	hemi
QString	name
qint32	label_id

Detailed Description

Freesurfer/MNE label.

A Freesurfer/MNE label with vertices restricted to one hemisphere

Definition at line 80 of file label.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const Label> FSLIB::Label::ConstSPtr

Const shared pointer type for Label class.

Definition at line 84 of file label.h.

SPtr

typedef QSharedPointer<Label> FSLIB::Label::SPtr

Shared pointer type for Label class.

Definition at line 83 of file label.h.

Constructor & Destructor Documentation

Label() [1/2]

Label::Label

(

)

Default constructor

Definition at line 69 of file label.cpp.

Label() [2/2]

FSLIB::Label::Label	(	const Eigen::VectorXi &	p_vertices,
		const Eigen::MatrixX3f &	p_pos,
		const Eigen::VectorXd &	p_values,
		qint32	p_hemi,
		const QString &	p_name,
		qint32	p_id = -1
	)

Constructs a label

Parameters

[in]	p_vertices	Vertices.
[in]	p_pos	Positions.
[in]	p_values	Values.
[in]	p_hemi	Hemisphere (lh = 0; rh = 1).
[in]	p_name	label names.
[in]	p_id	label id (optional, default = -1).

~Label()

Label::~Label

(

)

Destroys the Label class.

Definition at line 94 of file label.cpp.

Member Function Documentation

clear()

void Label::clear

(

)

Initializes the Label.

Definition at line 100 of file label.cpp.

isEmpty()

bool FSLIB::Label::isEmpty ( ) const

inline

True if Label is empty.

Returns

true if Label is empty, false otherwise.

Definition at line 184 of file label.h.

read()

bool Label::read ( const QString &  p_sFileName, Label &  p_Label  )

static

mne_read_label_file

Reads a Label from a FreeSurfer label file. This is based on the FreeSurfer read_label routine SUBJECTS_DIR environment variable is not consulted for the standard location

Parameters

[in]	p_sFileName	label file name.
[in]	p_Label	read label.

Returns

true if successful, false otherwise.

Definition at line 180 of file label.cpp.

selectTris() [1/2]

Eigen::MatrixX3i FSLIB::Label::selectTris

(

const Eigen::MatrixX3i &

p_matTris

)

Select tris for this label from a given tri matrix.

Parameters

[in]

p_matTris

tris from which the selection should be made.

Returns

the generated tris.

selectTris() [2/2]

MatrixX3i Label::selectTris

(

const Surface &

p_Surface

)

Select tris for this label from a given surface file.

Parameters

[in]

p_Surface

to generate the label tris from.

Returns

the generated tris.

Definition at line 114 of file label.cpp.

Member Data Documentation

comment

QString FSLIB::Label::comment

Comment from the first line of the label file.

Definition at line 165 of file label.h.

hemi

qint32 FSLIB::Label::hemi

Hemisphere (lh = 0; rh = 1).

Definition at line 169 of file label.h.

label_id

qint32 FSLIB::Label::label_id

Label id (optional).

Definition at line 172 of file label.h.

name

QString FSLIB::Label::name

Name of the label.

Definition at line 171 of file label.h.

pos

Eigen::MatrixX3f FSLIB::Label::pos

Locations in meters.

Definition at line 167 of file label.h.

values

Eigen::VectorXd FSLIB::Label::values

Values at the vertices.

Definition at line 168 of file label.h.

vertices

Eigen::VectorXi FSLIB::Label::vertices

Vertex indices (0 based).

Definition at line 166 of file label.h.

---

The documentation for this class was generated from the following files:

• src/libraries/fs/label.h
• src/libraries/fs/label.cpp