FIFFLIB::FiffProj Class Reference

SSP projector data. More...

#include <fiff_proj.h>

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

Public Member Functions
	FiffProj ()
	FiffProj (const FiffProj &p_FiffProj)
	FiffProj (fiff_int_t p_kind, bool p_active, QString p_desc, FiffNamedMatrix &p_data)
	~FiffProj ()

Static Public Member Functions
static void	activate_projs (QList< FiffProj > &p_qListFiffProj)
static fiff_int_t	make_projector (const QList< FiffProj > &projs, const QStringList &ch_names, Eigen::MatrixXd &proj, const QStringList &bads=defaultQStringList, Eigen::MatrixXd &U=defaultMatrixXd)

Public Attributes
fiff_int_t	kind
bool	active
QString	desc
FiffNamedMatrix::SDPtr	data

Friends
std::ostream &	operator<< (std::ostream &out, const FIFFLIB::FiffProj &p_FiffProj)

Detailed Description

SSP projector data.

Provides SSP projector data.

Definition at line 75 of file fiff_proj.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const FiffProj> FIFFLIB::FiffProj::ConstSPtr

Const shared pointer type for FiffProj.

Definition at line 79 of file fiff_proj.h.

SPtr

typedef QSharedPointer<FiffProj> FIFFLIB::FiffProj::SPtr

Shared pointer type for FiffProj.

Definition at line 78 of file fiff_proj.h.

Constructor & Destructor Documentation

FiffProj() [1/3]

FiffProj::FiffProj

(

)

Default constructor.

Definition at line 63 of file fiff_proj.cpp.

FiffProj() [2/3]

FiffProj::FiffProj

(

const FiffProj &

p_FiffProj

)

Copy constructor.

Parameters

[in]

p_FiffProj

SSP projector data which should be copied.

Definition at line 74 of file fiff_proj.cpp.

FiffProj() [3/3]

FiffProj::FiffProj ( fiff_int_t  p_kind, bool  p_active, QString  p_desc, FiffNamedMatrix &  p_data  )

explicit

Constructor

Definition at line 85 of file fiff_proj.cpp.

~FiffProj()

FiffProj::~FiffProj

(

)

Destroys the FiffProj.

Definition at line 96 of file fiff_proj.cpp.

Member Function Documentation

activate_projs()

void FiffProj::activate_projs ( QList< FiffProj > &  p_qListFiffProj )

static

Set all projections to active

Parameters

[in,out]

p_qListFiffProj

activates projectors in place.

Definition at line 103 of file fiff_proj.cpp.

make_projector()

fiff_int_t FiffProj::make_projector ( const QList< FiffProj > &  projs, const QStringList &  ch_names, Eigen::MatrixXd &  proj, const QStringList &  bads = defaultQStringList, Eigen::MatrixXd &  U = defaultMatrixXd  )

static

mne_make_projector

ToDo move this to fiff_proj; Before: check if info is needed and if make_projector_info should be also moved.

MNE toolbox root function ### Definition of the mne_make_projector function

Make an SSP operator

Parameters

[in]	projs	A set of projection vectors.
[in]	ch_names	A cell array of channel names.
[out]	proj	The projection operator to apply to the data.
[in]	bads	Bad channels to exclude.
[out]	U	The orthogonal basis of the projection vectors (optional).

Returns

nproj - How many items in the projector.

Definition at line 115 of file fiff_proj.cpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const FIFFLIB::FiffProj &  p_FiffProj  )

friend

overloading the stream out operator<<

Parameters

[in]	out	The stream to which the fiff projector should be assigned to.
[in]	p_FiffProj	Fiff projector which should be assigned to the stream.

Returns

the stream with the attached fiff projector.

Definition at line 165 of file fiff_proj.h.

Member Data Documentation

active

bool FIFFLIB::FiffProj::active

If fiff projector active.

Definition at line 155 of file fiff_proj.h.

data

FiffNamedMatrix::SDPtr FIFFLIB::FiffProj::data

Projector data, rows are equal to the length of channels.

Definition at line 158 of file fiff_proj.h.

desc

QString FIFFLIB::FiffProj::desc

Projector description.

Definition at line 156 of file fiff_proj.h.

kind

fiff_int_t FIFFLIB::FiffProj::kind

Fiff kind.

Definition at line 154 of file fiff_proj.h.

---

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

• src/libraries/fiff/fiff_proj.h
• src/libraries/fiff/fiff_proj.cpp