MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FSLIB::SurfaceSet Class Reference

A hemisphere set of surfaces. More...

#include <surfaceset.h>

Public Types

typedef QSharedPointer< SurfaceSetSPtr
 
typedef QSharedPointer< const SurfaceSetConstSPtr
 

Public Member Functions

 SurfaceSet ()
 
 SurfaceSet (const QString &subject_id, qint32 hemi, const QString &surf, const QString &subjects_dir)
 
 SurfaceSet (const QString &path, qint32 hemi, const QString &surf)
 
 SurfaceSet (const Surface &p_LHSurface, const Surface &p_RHSurface)
 
 SurfaceSet (const QString &p_sLHFileName, const QString &p_sRHFileName)
 
 ~SurfaceSet ()
 
void clear ()
 
QMap< qint32, Surface > & data ()
 
bool isEmpty () const
 
void insert (const Surface &p_Surface)
 
QString surf () const
 
const Surfaceoperator[] (qint32 idx) const
 
Surfaceoperator[] (qint32 idx)
 
const Surfaceoperator[] (QString idt) const
 
Surfaceoperator[] (QString idt)
 
qint32 size () const
 

Static Public Member Functions

static bool read (const QString &p_sLHFileName, const QString &p_sRHFileName, SurfaceSet &p_SurfaceSet)
 

Detailed Description

A hemisphere set of surfaces.

The set of surfaces holds right and left hemipshere surfaces

Definition at line 71 of file surfaceset.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for SurfaceSet class.

Definition at line 75 of file surfaceset.h.

◆ SPtr

typedef QSharedPointer<SurfaceSet> FSLIB::SurfaceSet::SPtr

Shared pointer type for SurfaceSet class.

Definition at line 74 of file surfaceset.h.

Constructor & Destructor Documentation

◆ SurfaceSet() [1/5]

SurfaceSet::SurfaceSet ( )

Default constructor

Definition at line 60 of file surfaceset.cpp.

◆ SurfaceSet() [2/5]

SurfaceSet::SurfaceSet ( 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_idName of subject.
[in]hemiWhich hemisphere to load {0 -> lh, 1 -> rh, 2 -> both}.
[in]surfName of the surface to load (eg. inflated, orig ...).
[in]subjects_dirSubjects directory.

Definition at line 66 of file surfaceset.cpp.

◆ SurfaceSet() [3/5]

SurfaceSet::SurfaceSet ( const QString &  path,
qint32  hemi,
const QString &  surf 
)
explicit

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

Parameters
[in]pathpath to surface directory.
[in]hemiWhich hemisphere to load {0 -> lh, 1 -> rh, 2 -> both}.
[in]surfName of the surface to load (eg. inflated, orig ...).

Definition at line 87 of file surfaceset.cpp.

◆ SurfaceSet() [4/5]

SurfaceSet::SurfaceSet ( const Surface p_LHSurface,
const Surface p_RHSurface 
)
explicit

Constructs a surface set by assembling given surfaces

Parameters
[in]p_LHSurfaceLeft hemisphere surface.
[in]p_RHSurfaceRight hemisphere surface.

Definition at line 108 of file surfaceset.cpp.

◆ SurfaceSet() [5/5]

SurfaceSet::SurfaceSet ( const QString &  p_sLHFileName,
const QString &  p_sRHFileName 
)
explicit

Constructs an annotation set by reading from annotation files

Parameters
[in]p_sLHFileNameLeft hemisphere annotation file.
[in]p_sRHFileNameRight hemisphere annotation file.

Definition at line 125 of file surfaceset.cpp.

◆ ~SurfaceSet()

SurfaceSet::~SurfaceSet ( )

Destroys the SurfaceSet class.

Definition at line 134 of file surfaceset.cpp.

Member Function Documentation

◆ clear()

void SurfaceSet::clear ( )

Initializes the AnnotationSet.

Definition at line 140 of file surfaceset.cpp.

◆ data()

QMap< qint32, Surface > & FSLIB::SurfaceSet::data ( )
inline

Returns The surface set map

Returns
the surface set map.

Definition at line 240 of file surfaceset.h.

◆ insert()

void SurfaceSet::insert ( const Surface p_Surface)

Insert a surface

Parameters
[in]p_SurfaceSurface to insert.

Definition at line 147 of file surfaceset.cpp.

◆ isEmpty()

bool FSLIB::SurfaceSet::isEmpty ( ) const
inline

True if SurfaceSet is empty.

Returns
true if SurfaceSet is empty.

Definition at line 247 of file surfaceset.h.

◆ operator[]() [1/4]

const Surface & SurfaceSet::operator[] ( qint32  idx) const

Subscript operator [] to access surface by index

Parameters
[in]idxthe hemisphere index (0 or 1).
Returns
Surface related to the parameter index.

Definition at line 188 of file surfaceset.cpp.

◆ operator[]() [2/4]

Surface & SurfaceSet::operator[] ( qint32  idx)

Subscript operator [] to access surface by index

Parameters
[in]idxthe hemisphere index (0 or 1).
Returns
Surface related to the parameter index.

Definition at line 203 of file surfaceset.cpp.

◆ operator[]() [3/4]

const Surface & SurfaceSet::operator[] ( QString  idt) const

Subscript operator [] to access surface by identifier

Parameters
[in]idtthe hemisphere identifier ("lh" or "rh").
Returns
Surface related to the parameter identifier.

Definition at line 218 of file surfaceset.cpp.

◆ operator[]() [4/4]

Surface & SurfaceSet::operator[] ( QString  idt)

Subscript operator [] to access surface by identifier

Parameters
[in]idtthe hemisphere identifier ("lh" or "rh").
Returns
Surface related to the parameter identifier.

Definition at line 233 of file surfaceset.cpp.

◆ read()

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

Reads different surface files and assembles them to a SurfaceSet

Parameters
[in]p_sLHFileNameLeft hemisphere surface file.
[in]p_sRHFileNameRight hemisphere surface file.
[out]p_SurfaceSetThe read surface set.
Returns
true if succesfull, false otherwise.

Definition at line 160 of file surfaceset.cpp.

◆ size()

qint32 FSLIB::SurfaceSet::size ( ) const
inline

Returns number of loaded hemispheres

Returns
number of loaded hemispheres.

Definition at line 264 of file surfaceset.h.

◆ surf()

QString FSLIB::SurfaceSet::surf ( ) const
inline

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

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

Definition at line 254 of file surfaceset.h.


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