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

BEM Surface. More...

#include <mne_surface.h>

Public Types

typedef QSharedPointer< MNESurfaceSPtr
 
typedef QSharedPointer< const MNESurfaceConstSPtr
 
typedef Eigen::Matrix3Xf PointsT
 
typedef Eigen::Matrix3Xf NormalsT
 
typedef Eigen::Matrix3Xi TrianglesT
 

Public Member Functions

 MNESurface ()
 
 ~MNESurface ()
 

Static Public Member Functions

static bool read (QIODevice &p_IODevice, QList< MNESurface::SPtr > &surfaces)
 
static bool read (FIFFLIB::FiffStream::SPtr &p_pStream, bool add_geom, const FIFFLIB::FiffDirNode::SPtr &p_Tree, QList< MNESurface::SPtr > &surfaces)
 

Public Attributes

FIFFLIB::fiff_int_t id
 
FIFFLIB::fiff_float_t sigma
 
FIFFLIB::fiff_int_t np
 
FIFFLIB::fiff_int_t ntri
 
FIFFLIB::fiff_int_t coord_frame
 
PointsT rr
 
NormalsT nn
 
TrianglesT tris
 

Detailed Description

BEM Surface.

BEM Surface TODO: Get rid of this? Not used anymore. Maybe by the Leipzig proct code?

Definition at line 82 of file mne_surface.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const MNESurface> MNELIB::MNESurface::ConstSPtr

Const shared pointer type for MNESurface.

Definition at line 86 of file mne_surface.h.

◆ NormalsT

typedef Eigen::Matrix3Xf MNELIB::MNESurface::NormalsT

Type abbreviation for normals.

Definition at line 89 of file mne_surface.h.

◆ PointsT

typedef Eigen::Matrix3Xf MNELIB::MNESurface::PointsT

Type abbreviation for points.

Definition at line 88 of file mne_surface.h.

◆ SPtr

typedef QSharedPointer<MNESurface> MNELIB::MNESurface::SPtr

Shared pointer type for MNESurface.

Definition at line 85 of file mne_surface.h.

◆ TrianglesT

typedef Eigen::Matrix3Xi MNELIB::MNESurface::TrianglesT

Type abbreviation for triangles.

Definition at line 90 of file mne_surface.h.

Constructor & Destructor Documentation

◆ MNESurface()

MNESurface::MNESurface ( )

Default constructor

Definition at line 59 of file mne_surface.cpp.

◆ ~MNESurface()

MNELIB::MNESurface::~MNESurface ( )
inline

Default destructor

Definition at line 101 of file mne_surface.h.

Member Function Documentation

◆ read() [1/2]

bool MNESurface::read ( FIFFLIB::FiffStream::SPtr p_pStream,
bool  add_geom,
const FIFFLIB::FiffDirNode::SPtr p_Tree,
QList< MNESurface::SPtr > &  surfaces 
)
static

MNE toolbox root function ###: Definition of the mne_read_bem_surfaces function

Reads a BEM surface from a fif stream

Parameters
[in]p_pStreamThe open fiff file.
[in]add_geomAdd geometry information to the source spaces.
[in]p_TreeSearch for the surfaces here.
[in,out]p_SurfacesThe read bem surfaces.
Returns
true if succeeded, false otherwise.

Definition at line 85 of file mne_surface.cpp.

◆ read() [2/2]

bool MNESurface::read ( QIODevice &  p_IODevice,
QList< MNESurface::SPtr > &  surfaces 
)
static

Reads a bem surface from a fif IO device

Parameters
[in]p_IODeviceA fiff IO device like a fiff QFile or QTCPSocket.
[out]surfacesList to fill with found surfaces.
Returns
true if succeeded, false otherwise.

Definition at line 70 of file mne_surface.cpp.

Member Data Documentation

◆ coord_frame

FIFFLIB::fiff_int_t MNELIB::MNESurface::coord_frame

The coordinate frame of the mode.

Definition at line 138 of file mne_surface.h.

◆ id

FIFFLIB::fiff_int_t MNELIB::MNESurface::id

Surface number.

Definition at line 134 of file mne_surface.h.

◆ nn

NormalsT MNELIB::MNESurface::nn

Normals for each node.

Definition at line 140 of file mne_surface.h.

◆ np

FIFFLIB::fiff_int_t MNELIB::MNESurface::np

Number of nodes.

Definition at line 136 of file mne_surface.h.

◆ ntri

FIFFLIB::fiff_int_t MNELIB::MNESurface::ntri

Number of triangles.

Definition at line 137 of file mne_surface.h.

◆ rr

PointsT MNELIB::MNESurface::rr

Points for each node.

Definition at line 139 of file mne_surface.h.

◆ sigma

FIFFLIB::fiff_float_t MNELIB::MNESurface::sigma

Conductivity of a compartment.

Definition at line 135 of file mne_surface.h.

◆ tris

TrianglesT MNELIB::MNESurface::tris

Triangulation information.

Definition at line 141 of file mne_surface.h.


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