FSLIB::FsLabel Class Reference

Freesurfer/MNE label. More...

#include <fs_label.h>

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

Public Member Functions
	FsLabel ()
	FsLabel (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)
	~FsLabel ()
void	clear ()
bool	isEmpty () const
Eigen::MatrixX3i	selectTris (const FsSurface &p_Surface)
Eigen::MatrixX3i	selectTris (const Eigen::MatrixX3i &p_matTris)

Static Public Member Functions
static bool	read (const QString &p_sFileName, FsLabel &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 fs_label.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FsLabel class.

Definition at line 84 of file fs_label.h.

SPtr

typedef QSharedPointer<FsLabel> FSLIB::FsLabel::SPtr

Shared pointer type for FsLabel class.

Definition at line 83 of file fs_label.h.

Constructor & Destructor Documentation

FsLabel() [1/2]

FsLabel::FsLabel

(

)

Default constructor

Definition at line 69 of file fs_label.cpp.

FsLabel() [2/2]

FSLIB::FsLabel::FsLabel	(	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).

~FsLabel()

FsLabel::~FsLabel

(

)

Destroys the FsLabel class.

Definition at line 94 of file fs_label.cpp.

Member Function Documentation

clear()

void FsLabel::clear

(

)

Initializes the FsLabel.

Definition at line 100 of file fs_label.cpp.

isEmpty()

bool FSLIB::FsLabel::isEmpty ( ) const

inline

True if FsLabel is empty.

Returns

true if FsLabel is empty, false otherwise.

Definition at line 184 of file fs_label.h.

read()

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

static

mne_read_label_file

Reads a FsLabel 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 fs_label.cpp.

selectTris() [1/2]

Eigen::MatrixX3i FSLIB::FsLabel::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 FsLabel::selectTris

(

const FsSurface &

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 fs_label.cpp.

Member Data Documentation

comment

QString FSLIB::FsLabel::comment

Comment from the first line of the label file.

Definition at line 165 of file fs_label.h.

hemi

qint32 FSLIB::FsLabel::hemi

Hemisphere (lh = 0; rh = 1).

Definition at line 169 of file fs_label.h.

label_id

qint32 FSLIB::FsLabel::label_id

FsLabel id (optional).

Definition at line 172 of file fs_label.h.

name

QString FSLIB::FsLabel::name

Name of the label.

Definition at line 171 of file fs_label.h.

pos

Eigen::MatrixX3f FSLIB::FsLabel::pos

Locations in meters.

Definition at line 167 of file fs_label.h.

values

Eigen::VectorXd FSLIB::FsLabel::values

Values at the vertices.

Definition at line 168 of file fs_label.h.

vertices

Eigen::VectorXi FSLIB::FsLabel::vertices

Vertex indices (0 based).

Definition at line 166 of file fs_label.h.

---

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

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