FIFFLIB::FiffProj Class Reference

SSP projector data. More...

#include <fiff_proj.h>

Public Types
using	SPtr = QSharedPointer<FiffProj>
using	ConstSPtr = QSharedPointer<const FiffProj>
using	UPtr = std::unique_ptr<FiffProj>
using	ConstUPtr = std::unique_ptr<const FiffProj>

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)
static QList< FiffProj >	compute_from_raw (const FiffRawData &raw, const Eigen::MatrixXi &events, int eventCode, float tmin, float tmax, int nGrad, int nMag, int nEeg, const QMap< QString, double > &mapReject=QMap< QString, double >())

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 83 of file fiff_proj.h.

Member Typedef Documentation

ConstSPtr

using FIFFLIB::FiffProj::ConstSPtr = QSharedPointer<const FiffProj>

Const shared pointer type for FiffProj.

Definition at line 87 of file fiff_proj.h.

ConstUPtr

using FIFFLIB::FiffProj::ConstUPtr = std::unique_ptr<const FiffProj>

Const unique pointer type for FiffProj.

Definition at line 89 of file fiff_proj.h.

SPtr

using FIFFLIB::FiffProj::SPtr = QSharedPointer<FiffProj>

Shared pointer type for FiffProj.

Definition at line 86 of file fiff_proj.h.

UPtr

using FIFFLIB::FiffProj::UPtr = std::unique_ptr<FiffProj>

Unique pointer type for FiffProj.

Definition at line 88 of file fiff_proj.h.

Constructor & Destructor Documentation

FiffProj() [1/3]

FiffProj::FiffProj

(

)

Default constructor.

Definition at line 68 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 79 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 90 of file fiff_proj.cpp.

~FiffProj()

FiffProj::~FiffProj

(

)

Destroys the FiffProj.

Definition at line 101 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 108 of file fiff_proj.cpp.

compute_from_raw()

QList< FiffProj > FiffProj::compute_from_raw ( const FiffRawData & raw, const Eigen::MatrixXi & events, int eventCode, float tmin, float tmax, int nGrad, int nMag, int nEeg, const QMap< QString, double > & mapReject = QMap<QString,double>() )

static

compute_from_raw

Create SSP (Signal-Space Projection) operators from raw data via SVD. Ported from make_ssp.c (MNE-C).

Parameters

[in]	raw	The raw data.
[in]	events	Event matrix (nEvents x 3).
[in]	eventCode	Which event code to select epochs for.
[in]	tmin	Start of epoch relative to event (seconds).
[in]	tmax	End of epoch relative to event (seconds).
[in]	nGrad	Number of gradiometer projection vectors.
[in]	nMag	Number of magnetometer projection vectors.
[in]	nEeg	Number of EEG projection vectors.
[in]	mapReject	Rejection thresholds (key = channel type string, value = threshold).

Returns

List of FiffProj items, or empty list on failure.

Definition at line 285 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.

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 120 of file fiff_proj.cpp.

Friends And Related Symbol 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 202 of file fiff_proj.h.

Member Data Documentation

active

bool FIFFLIB::FiffProj::active

If fiff projector active.

Definition at line 192 of file fiff_proj.h.

data

FiffNamedMatrix::SDPtr FIFFLIB::FiffProj::data

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

Definition at line 195 of file fiff_proj.h.

desc

QString FIFFLIB::FiffProj::desc

Projector description.

Definition at line 193 of file fiff_proj.h.

kind

fiff_int_t FIFFLIB::FiffProj::kind

Fiff kind.

Definition at line 191 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