FSLIB::FsSurfaceSet Class Reference

Container holding the lh and/or rh FsSurface for one subject and one surface kind. More...

#include <fs_surfaceset.h>

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

Public Member Functions
	FsSurfaceSet ()
	FsSurfaceSet (const QString &subject_id, qint32 hemi, const QString &surf, const QString &subjects_dir)
	FsSurfaceSet (const QString &path, qint32 hemi, const QString &surf)
	FsSurfaceSet (const FsSurface &p_LHSurface, const FsSurface &p_RHSurface)
	FsSurfaceSet (const QString &p_sLHFileName, const QString &p_sRHFileName)
	~FsSurfaceSet ()
void	clear ()
QMap< qint32, FsSurface > &	data ()
bool	isEmpty () const
void	insert (const FsSurface &p_Surface)
QString	surf () const
const FsSurface &	operator[] (qint32 idx) const
FsSurface &	operator[] (qint32 idx)
const FsSurface &	operator[] (QString idt) const
FsSurface &	operator[] (QString idt)
qint32	size () const

Static Public Member Functions
static bool	read (const QString &p_sLHFileName, const QString &p_sRHFileName, FsSurfaceSet &p_SurfaceSet)

Detailed Description

Container holding the lh and/or rh FsSurface for one subject and one surface kind.

The set is keyed on the hemisphere id (0 = lh, 1 = rh) so callers can do set[0] / set[1] or iterate over set.data(). All member surfaces are loaded with the same surf name (e.g. pial), so the set is homogeneous across hemispheres and stays aligned with a paired FsAnnotationSet sharing the same vertex indexing.

Definition at line 65 of file fs_surfaceset.h.

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for FsSurfaceSet class.

Definition at line 69 of file fs_surfaceset.h.

SPtr

typedef QSharedPointer<FsSurfaceSet> FSLIB::FsSurfaceSet::SPtr

Shared pointer type for FsSurfaceSet class.

Definition at line 68 of file fs_surfaceset.h.

Constructor & Destructor Documentation

FsSurfaceSet() [1/5]

FsSurfaceSet::FsSurfaceSet

(

)

Default constructor

Definition at line 36 of file fs_surfaceset.cpp.

FsSurfaceSet() [2/5]

FsSurfaceSet::FsSurfaceSet ( const QString & subject_id, qint32 hemi, const QString & surf, 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]	surf	Name of the surface to load (eg. inflated, orig ...).
[in]	subjects_dir	Subjects directory.

Definition at line 42 of file fs_surfaceset.cpp.

FsSurfaceSet() [3/5]

FsSurfaceSet::FsSurfaceSet ( const QString & path, qint32 hemi, const QString & surf )

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]	surf	Name of the surface to load (eg. inflated, orig ...).

Definition at line 63 of file fs_surfaceset.cpp.

FsSurfaceSet() [4/5]

FsSurfaceSet::FsSurfaceSet ( const FsSurface & p_LHSurface, const FsSurface & p_RHSurface )

explicit

Constructs a surface set by assembling given surfaces

Parameters

[in]	p_LHSurface	Left hemisphere surface.
[in]	p_RHSurface	Right hemisphere surface.

Definition at line 84 of file fs_surfaceset.cpp.

FsSurfaceSet() [5/5]

FsSurfaceSet::FsSurfaceSet ( 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 101 of file fs_surfaceset.cpp.

~FsSurfaceSet()

FsSurfaceSet::~FsSurfaceSet

(

)

Destroys the FsSurfaceSet class.

Definition at line 110 of file fs_surfaceset.cpp.

Member Function Documentation

clear()

void FsSurfaceSet::clear

(

)

Initializes the FsAnnotationSet.

Definition at line 116 of file fs_surfaceset.cpp.

data()

QMap< qint32, FsSurface > & FSLIB::FsSurfaceSet::data ( )

inline

Returns The surface set map

Returns

the surface set map.

Definition at line 234 of file fs_surfaceset.h.

insert()

void FsSurfaceSet::insert

(

const FsSurface &

p_Surface

)

Insert a surface

Parameters

[in]

p_Surface

FsSurface to insert.

Definition at line 123 of file fs_surfaceset.cpp.

isEmpty()

bool FSLIB::FsSurfaceSet::isEmpty ( ) const

inline

True if FsSurfaceSet is empty.

Returns

true if FsSurfaceSet is empty.

Definition at line 241 of file fs_surfaceset.h.

operator[]() [1/4]

FsSurface & FsSurfaceSet::operator[]

(

qint32

idx

)

Subscript operator [] to access surface by index

Parameters

[in]

idx

the hemisphere index (0 or 1).

Returns

FsSurface related to the parameter index.

Definition at line 182 of file fs_surfaceset.cpp.

operator[]() [2/4]

const FsSurface & FsSurfaceSet::operator[]

(

qint32

idx

)

const

Subscript operator [] to access surface by index

Parameters

[in]

idx

the hemisphere index (0 or 1).

Returns

FsSurface related to the parameter index.

Definition at line 167 of file fs_surfaceset.cpp.

operator[]() [3/4]

FsSurface & FsSurfaceSet::operator[]

(

QString

idt

)

Subscript operator [] to access surface by identifier

Parameters

[in]

idt

the hemisphere identifier ("lh" or "rh").

Returns

FsSurface related to the parameter identifier.

Definition at line 212 of file fs_surfaceset.cpp.

operator[]() [4/4]

const FsSurface & FsSurfaceSet::operator[]

(

QString

idt

)

const

Subscript operator [] to access surface by identifier

Parameters

[in]

idt

the hemisphere identifier ("lh" or "rh").

Returns

FsSurface related to the parameter identifier.

Definition at line 197 of file fs_surfaceset.cpp.

read()

bool FsSurfaceSet::read ( const QString & p_sLHFileName, const QString & p_sRHFileName, FsSurfaceSet & p_SurfaceSet )

static

Reads different surface files and assembles them to a FsSurfaceSet

Parameters

[in]	p_sLHFileName	Left hemisphere surface file.
[in]	p_sRHFileName	Right hemisphere surface file.
[out]	p_SurfaceSet	The read surface set.

Returns

true if succesfull, false otherwise.

Definition at line 136 of file fs_surfaceset.cpp.

size()

qint32 FSLIB::FsSurfaceSet::size ( ) const

inline

Returns number of loaded hemispheres

Returns

number of loaded hemispheres.

Definition at line 258 of file fs_surfaceset.h.

surf()

QString FSLIB::FsSurfaceSet::surf ( ) const

inline

The kind of Surfaces which are held by the FsSurfaceSet (eg. inflated, orig ...)

Returns

the loaded surfaces (eg. inflated, orig ...).

Definition at line 248 of file fs_surfaceset.h.

---

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

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