MNELIB::MNESssData Class Reference

Container for Signal Space Separation (SSS/Maxwell filtering) expansion coefficients and metadata. More...

#include <mne_sss_data.h>

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

Public Member Functions
	MNESssData ()
	MNESssData (const MNESssData &p_MneSssData)
	~MNESssData ()
void	print (QTextStream &out) const

Static Public Member Functions
static MNESssData *	read (const QString &name)
static MNESssData *	read_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
Eigen::VectorXi	comp_info
int	in_nuse
int	out_nuse

Detailed Description

Container for Signal Space Separation (SSS/Maxwell filtering) expansion coefficients and metadata.

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

Definition at line 83 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 87 of file mne_sss_data.h.

SPtr

typedef QSharedPointer<MNESssData> MNELIB::MNESssData::SPtr

Shared pointer type for MNESssData.

Definition at line 86 of file mne_sss_data.h.

Constructor & Destructor Documentation

MNESssData() [1/2]

MNESssData::MNESssData

(

)

Constructs the MNE SSS Data

Definition at line 78 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)

Parameters

[in]

p_MneSssData

MNE SSS Data which should be copied.

Definition at line 94 of file mne_sss_data.cpp.

~MNESssData()

MNESssData::~MNESssData ( )

default

Destroys the MNE SSS Data description

Member Function Documentation

print()

void MNESssData::print

(

QTextStream &

out

)

const

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

Parameters

[in]

out

The text stream to write the SSS diagnostics to (e.g. a QTextStream wrapping stderr).

Definition at line 257 of file mne_sss_data.cpp.

read()

MNESssData * MNESssData::read ( const QString & name )

static

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

Parameters

[in]

name

Name of the file to read the SSS data from.

Returns

The read SSS data.

Definition at line 115 of file mne_sss_data.cpp.

read_from_node()

MNESssData * MNESssData::read_from_node ( QSharedPointer< FIFFLIB::FiffStream > & stream, const QSharedPointer< FIFFLIB::FiffDirNode > & start )

static

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

Parameters

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

Returns

The read SSS data.

Definition at line 131 of file mne_sss_data.cpp.

Member Data Documentation

comp_info

Eigen::VectorXi MNELIB::MNESssData::comp_info

Which components are included.

Definition at line 149 of file mne_sss_data.h.

coord_frame

int MNELIB::MNESssData::coord_frame

Coordinate frame.

Definition at line 144 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 148 of file mne_sss_data.h.

job

int MNELIB::MNESssData::job

Value of FIFF_SSS_JOB tag.

Definition at line 143 of file mne_sss_data.h.

nchan

int MNELIB::MNESssData::nchan

How many channels.

Definition at line 146 of file mne_sss_data.h.

origin

float MNELIB::MNESssData::origin[3]

The expansion origin.

Definition at line 145 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 147 of file mne_sss_data.h.

---

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

• src/libraries/mne/mne_sss_data.h
• src/libraries/mne/mne_sss_data.cpp