Projection operator managing a set of linear projection items and the final compiled projector matrix. More...

#include <mne_proj_op.h>

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

Public Member Functions
	MNEProjOp ()
	Default constructor.
	~MNEProjOp ()
	Destructor.
void	free_proj ()
	Release the compiled projector data.
MNEProjOp *	combine (MNEProjOp *from)
	Append all projection items from another operator.
void	add_item_active (const MNENamedMatrix *vecs, int kind, const QString &desc, bool is_active)
	Add a projection item with an explicit active/inactive state.
void	add_item (const MNENamedMatrix *vecs, int kind, const QString &desc)
	Add a projection item that is active by default.
std::unique_ptr< MNEProjOp >	dup () const
	Create a deep copy of this projection operator.
int	affect (const QStringList &list, int nlist)
int	affect_chs (const QList< FIFFLIB::FiffChInfo > &chs, int nch)
int	project_vector (Eigen::Ref< Eigen::VectorXf > vec, bool do_complement)
void	report_data (QTextStream &out, const QString &tag, bool list_data, const QStringList &exclude)
void	report (QTextStream &out, const QString &tag)
int	assign_channels (const QStringList &list, int nlist)
int	make_proj_bad (const QStringList &bad)
int	make_proj ()
int	project_dvector (Eigen::Ref< Eigen::VectorXd > vec, bool do_complement)
int	apply_cov (MNECovMatrix *c)

Static Public Member Functions
static std::unique_ptr< MNEProjOp >	create_average_eeg_ref (const QList< FIFFLIB::FiffChInfo > &chs, int nch)
	Create an average EEG reference projector.
static std::unique_ptr< MNEProjOp >	read_from_node (FIFFLIB::FiffStream::SPtr &stream, const FIFFLIB::FiffDirNode::SPtr &start)
	Read all linear projection items from a FIFF tree node.
static std::unique_ptr< MNEProjOp >	read (const QString &name)
static bool	makeProjection (const QList< QString > &projnames, const QList< FIFFLIB::FiffChInfo > &chs, int nch, std::unique_ptr< MNEProjOp > &result)
	Load and combine SSP projection operators from files for the selected channels.

Public Attributes
QList< MNELIB::MNEProjItem >	items
int	nitems
QStringList	names
int	nch
int	nvec
Eigen::Matrix< float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor >	proj_data

Detailed Description

Projection operator managing a set of linear projection items and the final compiled projector matrix.

MNEProjOp aggregates zero or more MNEProjItem entries, each holding a named matrix of projection vectors. When the operator is compiled (make_projector), the individual items are orthogonalised into a single dense projector stored in proj_data.

Definition at line 86 of file mne_proj_op.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for MNEProjOp.

Definition at line 90 of file mne_proj_op.h.

◆ SPtr

typedef QSharedPointer<MNEProjOp> MNELIB::MNEProjOp::SPtr

Shared pointer type for MNEProjOp.

Definition at line 89 of file mne_proj_op.h.

Constructor & Destructor Documentation

◆ MNEProjOp()

MNEProjOp::MNEProjOp ( )

Default constructor.

Creates an empty operator with no projection items.

Definition at line 76 of file mne_proj_op.cpp.

◆ ~MNEProjOp()

MNEProjOp::~MNEProjOp ( )

Destructor.

Definition at line 85 of file mne_proj_op.cpp.

Member Function Documentation

◆ add_item()

void MNEProjOp::add_item	(	const MNENamedMatrix *	vecs,
		int	kind,
		const QString &	desc )

Add a projection item that is active by default.

Convenience wrapper around add_item_active() with is_active = TRUE.

Parameters

[in]	vecs	Named matrix holding the projection vectors.
[in]	kind	Projection kind constant.
[in]	desc	Human-readable description of the projection.

Definition at line 165 of file mne_proj_op.cpp.

◆ add_item_active()

void MNEProjOp::add_item_active	(	const MNENamedMatrix *	vecs,
		int	kind,
		const QString &	desc,
		bool	is_active )

Add a projection item with an explicit active/inactive state.

The projection kind (MEG/EEG) is auto-detected from channel names.

Parameters

[in]	vecs	Named matrix holding the projection vectors.
[in]	kind	Projection kind constant.
[in]	desc	Human-readable description of the projection.
[in]	is_active	Whether the item is active on load.

Definition at line 121 of file mne_proj_op.cpp.

◆ affect()

int MNEProjOp::affect	(	const QStringList &	list,
		int	nlist )

Count how many active projection vectors affect a given list of channel names.

Parameters

[in]	list	List of channel names to test.
[in]	nlist	Number of channel names.

Returns: Number of projection vectors that affect at least one channel in the list (0 if none).

Definition at line 223 of file mne_proj_op.cpp.

◆ affect_chs()

int MNEProjOp::affect_chs	(	const QList< FIFFLIB::FiffChInfo > &	chs,
		int	nch )

Count how many active projection vectors affect the given channels. Convenience wrapper that extracts channel names and delegates to affect().

Parameters

[in]	chs	Channel information list.
[in]	nch	Number of channels.

Returns: Number of affecting projection vectors (0 if none or nch == 0).

Definition at line 237 of file mne_proj_op.cpp.

◆ apply_cov()

int MNEProjOp::apply_cov ( MNECovMatrix * c )

Apply this projection operator to a covariance matrix from both sides: C' = (I - P) C (I - P)^T (or P C P^T if do_complement is false).

Parameters

[in,out] c The covariance matrix to project.

Returns: OK on success, FAIL on error.

Definition at line 780 of file mne_proj_op.cpp.

◆ assign_channels()

int MNEProjOp::assign_channels	(	const QStringList &	list,
		int	nlist )

Assign a channel name list to this projection operator, invalidating any previously compiled projector.

Parameters

[in]	list	Channel name list.
[in]	nlist	Number of channels.

Returns: OK on success.

Definition at line 501 of file mne_proj_op.cpp.

◆ combine()

MNEProjOp * MNEProjOp::combine ( MNEProjOp * from )

Append all projection items from another operator.

Each item's active_file flag is preserved.

Parameters

[in] from Source operator whose items are copied.

Returns: Pointer to this operator.

Definition at line 104 of file mne_proj_op.cpp.

◆ create_average_eeg_ref()

std::unique_ptr< MNEProjOp > MNEProjOp::create_average_eeg_ref	(	const QList< FIFFLIB::FiffChInfo > &	chs,
		int	nch )

static

Create an average EEG reference projector.

Builds a uniform-weight vector ( $1/\sqrt{N_{\text{EEG}}}$ ) across all EEG channels.

Parameters

[in]	chs	Channel information list.
[in]	nch	Number of channels.

Returns: A new projection operator, or NULL if no EEG channels are found. Caller takes ownership.

Definition at line 189 of file mne_proj_op.cpp.

◆ dup()

std::unique_ptr< MNEProjOp > MNEProjOp::dup ( ) const

Create a deep copy of this projection operator.

Copies all items, their vectors, descriptions, and active states.

Returns: A newly allocated copy. Caller takes ownership.

Definition at line 172 of file mne_proj_op.cpp.

◆ free_proj()

void MNEProjOp::free_proj ( )

Release the compiled projector data.

Clears proj_data, names, nch, and nvec without touching the underlying projection items.

Definition at line 91 of file mne_proj_op.cpp.

◆ make_proj()

int MNEProjOp::make_proj ( )

Compile the projection operator via SVD (no bad channels). Convenience wrapper around make_proj_bad().

Returns: OK on success, FAIL on error.

Definition at line 681 of file mne_proj_op.cpp.

◆ make_proj_bad()

int MNEProjOp::make_proj_bad ( const QStringList & bad )

Compile the projection operator via SVD, excluding bad channels. Active projection items are picked, expanded to the assigned channel list, bad channels are zeroed, and SVD is performed to produce an orthogonal projector matrix stored in proj_data.

Parameters

[in] bad List of bad channel names.

Returns: OK on success, FAIL on error.

Definition at line 530 of file mne_proj_op.cpp.

◆ makeProjection()

bool MNEProjOp::makeProjection	(	const QList< QString > &	projnames,
		const QList< FIFFLIB::FiffChInfo > &	chs,
		int	nch,
		std::unique_ptr< MNEProjOp > &	result )

static

Load and combine SSP projection operators from files for the selected channels.

Reads projection items from each file in projnames, and if EEG channels are present adds an average EEG reference projector when none is found. Returns nullptr if the resulting projector does not affect any of the given channels.

Refactored: make_projection (dipole_fit_setup.c)

Parameters

[in]	projnames	List of FIFF file paths containing projection data.
[in]	chs	Channel information list.
[in]	nch	Number of channels.
[out]	result	The combined projection operator (nullptr when no projection is needed).

Returns: true on success, false on read error.

Definition at line 715 of file mne_proj_op.cpp.

◆ project_dvector()

int MNEProjOp::project_dvector	(	Eigen::Ref< Eigen::VectorXd >	vec,
		bool	do_complement )

Apply the compiled projection operator to a double-precision data vector.

Parameters

[in,out]	vec	Data vector.
[in]	do_complement	If true, compute (I - P) * vec.

Returns: OK on success, FAIL on dimension mismatch.

Definition at line 688 of file mne_proj_op.cpp.

◆ project_vector()

int MNEProjOp::project_vector	(	Eigen::Ref< Eigen::VectorXf >	vec,
		bool	do_complement )

Apply the compiled projection operator to a data vector in-place.

If do_complement is true, the projected components are subtracted from vec (signal cleaning). Otherwise, vec is replaced by the projection itself.

Parameters

[in,out]	vec	Data vector of length nch.
[in]	do_complement	If true, compute the complement (I - P) * vec.

Returns: OK on success, FAIL on dimension mismatch.

Definition at line 250 of file mne_proj_op.cpp.

◆ read()

std::unique_ptr< MNEProjOp > MNEProjOp::read ( const QString & name )

static

Read a projection operator from a FIFF file by path. Convenience wrapper that opens the file and delegates to read_from_node().

Parameters

[in] name Path to the FIFF file.

Returns: The loaded projection operator, or NULL on error. Caller takes ownership.

Definition at line 428 of file mne_proj_op.cpp.

◆ read_from_node()

std::unique_ptr< MNEProjOp > MNEProjOp::read_from_node	(	FIFFLIB::FiffStream::SPtr &	stream,
		const FIFFLIB::FiffDirNode::SPtr &	start )

static

Read all linear projection items from a FIFF tree node.

Parameters

[in]	stream	An open FIFF stream.
[in]	start	The tree node to search for projection blocks.

Returns: A populated projection operator (possibly with zero items), or NULL on error. Caller takes ownership.

Definition at line 282 of file mne_proj_op.cpp.

◆ report()

void MNEProjOp::report	(	QTextStream &	out,
		const QString &	tag )

Write a one-line-per-item summary of all projection items to a text stream (no vector data). Convenience wrapper around report_data().

Parameters

[in,out]	out	The text stream to write to.
[in]	tag	Prefix string printed before each line.

Definition at line 494 of file mne_proj_op.cpp.

◆ report_data()

void MNEProjOp::report_data	(	QTextStream &	out,
		const QString &	tag,
		bool	list_data,
		const QStringList &	exclude )

Write a formatted summary of all projection items to a text stream, optionally including the full projection vector data while zeroing out excluded channels.

Parameters

[in,out]	out	The text stream to write to.
[in]	tag	Prefix string printed before each line.
[in]	list_data	If true, print full vector data.
[in]	exclude	Channel names to exclude from the display.

Definition at line 446 of file mne_proj_op.cpp.

Member Data Documentation

◆ items

QList<MNELIB::MNEProjItem> MNELIB::MNEProjOp::items

The projection items.

Definition at line 334 of file mne_proj_op.h.

◆ names

QStringList MNELIB::MNEProjOp::names

Names of the channels in the final compiled projector.

Definition at line 336 of file mne_proj_op.h.

◆ nch

int MNELIB::MNEProjOp::nch

Number of channels in the final projector.

Definition at line 337 of file mne_proj_op.h.

◆ nitems

int MNELIB::MNEProjOp::nitems

Number of items.

Definition at line 335 of file mne_proj_op.h.

◆ nvec

int MNELIB::MNEProjOp::nvec

Number of orthogonalized vectors in the final projector.

Definition at line 338 of file mne_proj_op.h.

◆ proj_data

Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor> MNELIB::MNEProjOp::proj_data

The compiled projector: orthogonalized projection vectors (nvec x nch).

Definition at line 339 of file mne_proj_op.h.

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

src/libraries/mne/mne_proj_op.h
src/libraries/mne/mne_proj_op.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ MNEProjOp()

◆ ~MNEProjOp()

Member Function Documentation

◆ add_item()

◆ add_item_active()

◆ affect()

◆ affect_chs()

◆ apply_cov()

◆ assign_channels()

◆ combine()

◆ create_average_eeg_ref()

◆ dup()

◆ free_proj()

◆ make_proj()

◆ make_proj_bad()

◆ makeProjection()

◆ project_dvector()

◆ project_vector()

◆ read()

◆ read_from_node()

◆ report()

◆ report_data()

Member Data Documentation

◆ items

◆ names

◆ nch

◆ nitems

◆ nvec

◆ proj_data