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::MneSssData Class Reference

MNE SSS Data description. More...

#include <mne_sss_data.h>

Public Types

typedef QSharedPointer< MneSssDataSPtr
typedef QSharedPointer< const MneSssDataConstSPtr

Public Member Functions

 MneSssData ()
 MneSssData (const MneSssData &p_MneSssData)
 ~MneSssData ()
void print (FILE *f) const

Static Public Member Functions

static MneSssDataread_sss_data (const QString &name)
static MneSssDataread_sss_data_from_node (QSharedPointer< FIFFLIB::FiffStream > &stream, const QSharedPointer< FIFFLIB::FiffDirNode > &start)

Public Attributes

int job
int coord_frame
float origin [3]
int nchan
int out_order
int in_order
int * comp_info
int ncomp
int in_nuse
int out_nuse

Detailed Description

MNE SSS Data description.

Implements MNE SSS Data (Replaces *mneSssData,mneSssDataRec struct of MNE-C mne_types.h).

Definition at line 82 of file mne_sss_data.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MneSssData.

Definition at line 86 of file mne_sss_data.h.

◆ SPtr

typedef QSharedPointer<MneSssData> MNELIB::MneSssData::SPtr

Shared pointer type for MneSssData.

Definition at line 85 of file mne_sss_data.h.

Constructor & Destructor Documentation

◆ MneSssData() [1/2]

MneSssData::MneSssData ( )

Constructs the MNE SSS Data

Definition at line 77 of file mne_sss_data.cpp.

◆ MneSssData() [2/2]

MneSssData::MneSssData ( const MneSssData p_MneSssData)

Copy constructor. Refactored: mne_dup_sss_data (mne_sss_data.c)

[in]p_MneSssDataMNE SSS Data which should be copied.

Definition at line 92 of file mne_sss_data.cpp.

◆ ~MneSssData()

MneSssData::~MneSssData ( )

Destroys the MNE SSS Data description

Definition at line 114 of file mne_sss_data.cpp.

Member Function Documentation

◆ print()

void MneSssData::print ( FILE *  f) const

Output the SSS information for debugging purposes Refactored: mne_print_sss_data (mne_sss_data.c)

[in]fthe file stream to print to;.

Definition at line 261 of file mne_sss_data.cpp.

◆ read_sss_data()

MneSssData * MneSssData::read_sss_data ( const QString &  name)

Read SSS data from anywhere in a file Refactored: mne_read_sss_data (mne_sss_data.c)

[in]nameName of the file to read the SSS data from.
The read SSS data.

Definition at line 122 of file mne_sss_data.cpp.

◆ read_sss_data_from_node()

MneSssData * MneSssData::read_sss_data_from_node ( QSharedPointer< FIFFLIB::FiffStream > &  stream,
const QSharedPointer< FIFFLIB::FiffDirNode > &  start 

Read the SSS data from the given node of an open fiff stream Refactored: mne_read_sss_data_from_node (mne_sss_data.c)

[in]streamThe open fiff stream.
[in]startThe node/tree to read the SSS data from.
The read SSS data.

Definition at line 138 of file mne_sss_data.cpp.

Member Data Documentation

◆ comp_info

int* MNELIB::MneSssData::comp_info

Which components are included.

Definition at line 148 of file mne_sss_data.h.

◆ coord_frame

int MNELIB::MneSssData::coord_frame

Coordinate frame.

Definition at line 143 of file mne_sss_data.h.

◆ in_nuse

int MNELIB::MneSssData::in_nuse

How many components included in the inside expansion.

Definition at line 150 of file mne_sss_data.h.

◆ in_order

int MNELIB::MneSssData::in_order

Order of the inside expansion.

Definition at line 147 of file mne_sss_data.h.

◆ job

int MNELIB::MneSssData::job

Value of FIFF_SSS_JOB tag.

Definition at line 142 of file mne_sss_data.h.

◆ nchan

int MNELIB::MneSssData::nchan

How many channels.

Definition at line 145 of file mne_sss_data.h.

◆ ncomp

int MNELIB::MneSssData::ncomp

How many entries in the above.

Definition at line 149 of file mne_sss_data.h.

◆ origin

float MNELIB::MneSssData::origin[3]

The expansion origin.

Definition at line 144 of file mne_sss_data.h.

◆ out_nuse

int MNELIB::MneSssData::out_nuse

How many components included in the outside expansion.

Definition at line 151 of file mne_sss_data.h.

◆ out_order

int MNELIB::MneSssData::out_order

Order of the outside expansion.

Definition at line 146 of file mne_sss_data.h.

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