Container holding the lh and/or rh FsAnnotation for one parcellation atlas. More...

#include <fs_annotationset.h>

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

Public Member Functions
	FsAnnotationSet ()
	FsAnnotationSet (const QString &subject_id, qint32 hemi, const QString &atlas, const QString &subjects_dir)
	FsAnnotationSet (const QString &path, qint32 hemi, const QString &atlas)
	FsAnnotationSet (const FsAnnotation &p_LHAnnotation, const FsAnnotation &p_RHAnnotation)
	FsAnnotationSet (const QString &p_sLHFileName, const QString &p_sRHFileName)
	~FsAnnotationSet ()
void	clear ()
QMap< qint32, FsAnnotation > &	data ()
bool	isEmpty () const
void	insert (const FsAnnotation &p_Annotation)
bool	toLabels (const FsSurfaceSet &p_surfSet, QList< FsLabel > &p_qListLabels, QList< Eigen::RowVector4i > &p_qListLabelRGBAs, const QStringList &lLabelPicks=QStringList()) const
FsAnnotation &	operator[] (qint32 idx)
const FsAnnotation	operator[] (qint32 idx) const
FsAnnotation &	operator[] (QString idt)
const FsAnnotation	operator[] (QString idt) const
qint32	size () const

Static Public Member Functions
static bool	read (const QString &p_sLHFileName, const QString &p_sRHFileName, FsAnnotationSet &p_AnnotationSet)

Detailed Description

Container holding the lh and/or rh FsAnnotation for one parcellation atlas.

Keyed on hemisphere id (0 = lh, 1 = rh). When loaded from a single atlas name both hemispheres share the same colortable layout, so cross-hemisphere region lookup is consistent. The set is intended to be aligned one-to-one with an FsSurfaceSet sharing the same subject and vertex count per hemisphere.

Definition at line 74 of file fs_annotationset.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FsAnnotationSet.

Definition at line 78 of file fs_annotationset.h.

◆ SPtr

typedef QSharedPointer<FsAnnotationSet> FSLIB::FsAnnotationSet::SPtr

Shared pointer type for FsAnnotationSet.

Definition at line 77 of file fs_annotationset.h.

Constructor & Destructor Documentation

◆ FsAnnotationSet() [1/5]

FsAnnotationSet::FsAnnotationSet ( )

Default constructor

Definition at line 34 of file fs_annotationset.cpp.

◆ FsAnnotationSet() [2/5]

FsAnnotationSet::FsAnnotationSet	(	const QString &	subject_id,
		qint32	hemi,
		const QString &	atlas,
		const QString &	subjects_dir )

explicit

Construts the surface set by reading it of the given files.

Parameters

[in]	subject_id	Name of subject.
[in]	hemi	Which hemisphere to load {0 -> lh, 1 -> rh, 2 -> both}.
[in]	atlas	Name of the atlas to load (eg. aparc.a2009s, aparc, aparc.DKTatlas40, BA, BA.thresh, ...).
[in]	subjects_dir	Subjects directory.

Definition at line 40 of file fs_annotationset.cpp.

◆ FsAnnotationSet() [3/5]

FsAnnotationSet::FsAnnotationSet	(	const QString &	path,
		qint32	hemi,
		const QString &	atlas )

explicit

Construts the surface set by reading it of the given files.

Parameters

[in]	path	path to surface directory.
[in]	hemi	Which hemisphere to load {0 -> lh, 1 -> rh, 2 -> both}.
[in]	atlas	Name of the atlas to load (eg. aparc.a2009s, aparc, aparc.DKTatlas40, BA, BA.thresh, ...).

Definition at line 59 of file fs_annotationset.cpp.

◆ FsAnnotationSet() [4/5]

FsAnnotationSet::FsAnnotationSet	(	const FsAnnotation &	p_LHAnnotation,
		const FsAnnotation &	p_RHAnnotation )

explicit

Constructs an annotation set by assembling given annotations

Parameters

[in]	p_LHAnnotation	Left hemisphere annotation.
[in]	p_RHAnnotation	Right hemisphere annotation.

Definition at line 78 of file fs_annotationset.cpp.

◆ FsAnnotationSet() [5/5]

FsAnnotationSet::FsAnnotationSet	(	const QString &	p_sLHFileName,
		const QString &	p_sRHFileName )

explicit

Constructs an annotation set by reading from annotation files

Parameters

[in]	p_sLHFileName	Left hemisphere annotation file.
[in]	p_sRHFileName	Right hemisphere annotation file.

Definition at line 93 of file fs_annotationset.cpp.

◆ ~FsAnnotationSet()

FSLIB::FsAnnotationSet::~FsAnnotationSet ( )

inline

Destroys the annotation set.

Definition at line 129 of file fs_annotationset.h.

Member Function Documentation

◆ clear()

void FsAnnotationSet::clear ( )

Initializes the FsAnnotationSet.

Definition at line 102 of file fs_annotationset.cpp.

◆ data()

QMap< qint32, FsAnnotation > & FSLIB::FsAnnotationSet::data ( )

inline

Returns The FsAnnotation set map

Returns: the annotation set map.

Definition at line 247 of file fs_annotationset.h.

◆ insert()

void FsAnnotationSet::insert ( const FsAnnotation & p_Annotation )

Insert an annotation

Parameters

[in] p_Annotation FsAnnotation to insert.

Definition at line 109 of file fs_annotationset.cpp.

◆ isEmpty()

bool FSLIB::FsAnnotationSet::isEmpty ( ) const

inline

True if FsAnnotationSet is empty.

Returns: true if FsAnnotationSet is empty.

Definition at line 254 of file fs_annotationset.h.

◆ operator[]() [1/4]

FsAnnotation & FsAnnotationSet::operator[] ( qint32 idx )

Subscript operator [] to access annotation by index

Parameters

[in] idx the hemisphere index (0 or 1).

Returns: FsAnnotation related to the parameter index.

Definition at line 166 of file fs_annotationset.cpp.

◆ operator[]() [2/4]

const FsAnnotation FsAnnotationSet::operator[] ( qint32 idx ) const

Subscript operator [] to access annotation by index

Parameters

[in] idx the hemisphere index (0 or 1).

Returns: FsAnnotation related to the parameter index.

Definition at line 181 of file fs_annotationset.cpp.

◆ operator[]() [3/4]

FsAnnotation & FsAnnotationSet::operator[] ( QString idt )

Subscript operator [] to access annotation by identifier

Parameters

[in] idt the hemisphere identifier ("lh" or "rh").

Returns: FsAnnotation related to the parameter identifier.

Definition at line 196 of file fs_annotationset.cpp.

◆ operator[]() [4/4]

const FsAnnotation FsAnnotationSet::operator[] ( QString idt ) const

Subscript operator [] to access annotation by identifier

Parameters

[in] idt the hemisphere identifier ("lh" or "rh").

Returns: FsAnnotation related to the parameter identifier.

Definition at line 211 of file fs_annotationset.cpp.

◆ read()

bool FsAnnotationSet::read	(	const QString &	p_sLHFileName,
		const QString &	p_sRHFileName,
		FsAnnotationSet &	p_AnnotationSet )

static

Reads different annotation files and assembles them to a FsAnnotationSet

Parameters

[in]	p_sLHFileName	Left hemisphere annotation file.
[in]	p_sRHFileName	Right hemisphere annotation file.
[out]	p_AnnotationSet	The read annotation set.

Returns: true if succesfull, false otherwise.

Definition at line 122 of file fs_annotationset.cpp.

◆ size()

qint32 FSLIB::FsAnnotationSet::size ( ) const

inline

Returns number of loaded hemispheres

Returns: number of loaded hemispheres.

Definition at line 261 of file fs_annotationset.h.

◆ toLabels()

bool FsAnnotationSet::toLabels	(	const FsSurfaceSet &	p_surfSet,
		QList< FsLabel > &	p_qListLabels,
		QList< Eigen::RowVector4i > &	p_qListLabelRGBAs,
		const QStringList &	lLabelPicks = QStringList() ) const

python labels_from_parc

Converts annotation to a label list and colortable

Parameters

[in]	p_surfSet	the FsSurfaceSet to read the vertex positions from.
[out]	p_qListLabels	the converted labels are appended to a given list. Stored data are not affected.
[out]	p_qListLabelRGBAs	the converted label RGBAs are appended to a given list. Stored data are not affected.
[out]	lLabelPicks	the label names which should be picked.

Returns: true if successful, false otherwise.

Definition at line 151 of file fs_annotationset.cpp.

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

src/libraries/fs/fs_annotationset.h
src/libraries/fs/fs_annotationset.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ FsAnnotationSet() [1/5]

◆ FsAnnotationSet() [2/5]

◆ FsAnnotationSet() [3/5]

◆ FsAnnotationSet() [4/5]

◆ FsAnnotationSet() [5/5]

◆ ~FsAnnotationSet()

Member Function Documentation

◆ clear()

◆ data()

◆ insert()

◆ isEmpty()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ read()

◆ size()

◆ toLabels()