Source-space inverse-solution container with dense grid plus optional focal-dipole, coupling and connectivity layers. More...

#include <inv_source_estimate.h>

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

Public Member Functions
	InvSourceEstimate ()
	InvSourceEstimate (const Eigen::MatrixXd &p_sol, const Eigen::VectorXi &p_vertices, float p_tmin, float p_tstep)
	InvSourceEstimate (const InvSourceEstimate &p_SourceEstimate)
	InvSourceEstimate (QIODevice &p_IODevice)
void	clear ()
InvSourceEstimate	reduce (qint32 start, qint32 n)
bool	write (QIODevice &p_IODevice)
void	write_w (const QString &path) const
bool	isEmpty () const
InvSourceEstimate &	operator= (const InvSourceEstimate &rhs)
int	samples () const
Eigen::VectorXi	getIndicesByLabel (const QList< FSLIB::FsLabel > &lPickedLabels, bool bIsClustered) const
bool	hasGridData () const
bool	hasCouplings () const
bool	hasFocalDipoles () const
bool	hasPositions () const
bool	hasConnectivity () const

Static Public Member Functions
static bool	read (QIODevice &p_IODevice, InvSourceEstimate &p_stc)
static InvSourceEstimate	read_w (const QString &path)

Public Attributes
Eigen::MatrixXd	data
Eigen::VectorXi	vertices
Eigen::RowVectorXf	times
float	tmin
float	tstep
InvEstimateMethod	method
InvSourceSpaceType	sourceSpaceType
InvOrientationType	orientationType
Eigen::MatrixX3f	positions
std::vector< InvSourceCoupling >	couplings
std::vector< InvFocalDipole >	focalDipoles
std::vector< InvConnectivity >	connectivity

Detailed Description

Source-space inverse-solution container with dense grid plus optional focal-dipole, coupling and connectivity layers.

Central source-space container produced by every INVLIB inverse solver. Carries the dense (n_sources × n_times) data matrix plus vertex indices, time origin and step, and optional focal dipoles, coupling groups and connectivity layers so one value can represent the output of any algorithm in INVLIB. Replaces mneStcDataRec of MNE-C and implements round-trip STC / W binary I/O with mne-python and mne-c.

Definition at line 87 of file inv_source_estimate.h.

Inheritance diagram for INVLIB::InvSourceEstimate:

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const InvSourceEstimate> INVLIB::InvSourceEstimate::ConstSPtr

Const shared pointer type for InvSourceEstimate.

Definition at line 91 of file inv_source_estimate.h.

◆ SPtr

typedef QSharedPointer<InvSourceEstimate> INVLIB::InvSourceEstimate::SPtr

Shared pointer type for InvSourceEstimate.

Definition at line 90 of file inv_source_estimate.h.

Constructor & Destructor Documentation

◆ InvSourceEstimate() [1/4]

InvSourceEstimate::InvSourceEstimate ( )

Default constructor

Definition at line 50 of file inv_source_estimate.cpp.

◆ InvSourceEstimate() [2/4]

INVLIB::InvSourceEstimate::InvSourceEstimate	(	const Eigen::MatrixXd &	p_sol,
		const Eigen::VectorXi &	p_vertices,
		float	p_tmin,
		float	p_tstep )

Constructs a source estimation from given data

Parameters

[in]	p_sol.
[in]	p_vertices.
[in]	p_tmin.
[in]	p_tstep.

◆ InvSourceEstimate() [3/4]

InvSourceEstimate::InvSourceEstimate ( const InvSourceEstimate & p_SourceEstimate )

Copy constructor.

Parameters

[in] p_SourceEstimate Source estimate data which should be copied.

Definition at line 75 of file inv_source_estimate.cpp.

◆ InvSourceEstimate() [4/4]

InvSourceEstimate::InvSourceEstimate ( QIODevice & p_IODevice )

Constructs a source estimation, by reading from a IO device.

Parameters

[in] p_IODevice IO device to read from the source estimation.

Definition at line 93 of file inv_source_estimate.cpp.

Member Function Documentation

◆ clear()

void InvSourceEstimate::clear ( )

Initializes source estimate.

Definition at line 108 of file inv_source_estimate.cpp.

◆ getIndicesByLabel()

VectorXi InvSourceEstimate::getIndicesByLabel	(	const QList< FSLIB::FsLabel > &	lPickedLabels,
		bool	bIsClustered ) const

Returns the indices of sources in the data matrix based on their beloning label.

Parameters

[in]	lPickedLabels	The labels base the selection on.
[in]	bIsClustered	Whether the source space was clustered.

Returns: the indices.

Definition at line 389 of file inv_source_estimate.cpp.

◆ hasConnectivity()

bool INVLIB::InvSourceEstimate::hasConnectivity ( ) const

inline

Returns true if the estimate contains connectivity results.

Returns: true if connectivity data is present.

Definition at line 338 of file inv_source_estimate.h.

◆ hasCouplings()

bool INVLIB::InvSourceEstimate::hasCouplings ( ) const

inline

Returns true if the estimate contains source coupling annotations (e.g. RAP-MUSIC pairs/N-tuples).

Returns: true if couplings are present.

Definition at line 317 of file inv_source_estimate.h.

◆ hasFocalDipoles()

bool INVLIB::InvSourceEstimate::hasFocalDipoles ( ) const

inline

Returns true if the estimate contains focal (off-grid) dipole results.

Returns: true if focal dipoles are present.

Definition at line 324 of file inv_source_estimate.h.

◆ hasGridData()

bool INVLIB::InvSourceEstimate::hasGridData ( ) const

inline

Returns true if the estimate contains grid-based data (distributed methods or RAP-MUSIC amplitudes).

Returns: true if grid data is present.

Definition at line 310 of file inv_source_estimate.h.

◆ hasPositions()

bool INVLIB::InvSourceEstimate::hasPositions ( ) const

inline

Returns true if the estimate carries explicit source positions (discrete source space).

Returns: true if positions are present.

Definition at line 331 of file inv_source_estimate.h.

◆ isEmpty()

bool INVLIB::InvSourceEstimate::isEmpty ( ) const

inline

Returns whether SourceEstimate is empty.

Returns: true if is empty, false otherwise.

Definition at line 303 of file inv_source_estimate.h.

◆ operator=()

InvSourceEstimate & InvSourceEstimate::operator= ( const InvSourceEstimate & rhs )

Assignment Operator

Parameters

[in] rhs SourceEstimate which should be assigned.

Returns: the copied source estimate.

Definition at line 359 of file inv_source_estimate.cpp.

◆ read()

bool InvSourceEstimate::read	(	QIODevice &	p_IODevice,
		InvSourceEstimate &	p_stc )

static

mne_read_stc_file

Reads a source estimate from a given file

Parameters

[in]	p_IODevice	IO device to red the stc from.
[in,out]	p_stc	the read stc.

Returns: true if successful, false otherwise.

Definition at line 152 of file inv_source_estimate.cpp.

◆ read_w()

InvSourceEstimate InvSourceEstimate::read_w ( const QString & path )

static

Read a .w file (single time-point source estimate).

The .w format stores vertex indices (3-byte big-endian) and float values (4-byte big-endian) for a single time point.

Parameters

[in] path Path to the .w file.

Returns: The source estimate with single-column data.

Since: 2.2.0

Definition at line 256 of file inv_source_estimate.cpp.

◆ reduce()

InvSourceEstimate InvSourceEstimate::reduce	(	qint32	start,
		qint32	n )

Reduces the source estimate to selected samples.

Parameters

[in]	start	The start index to cut the estimate from.
[in]	n	Number of samples to cut from start index.

Definition at line 126 of file inv_source_estimate.cpp.

◆ samples()

int InvSourceEstimate::samples ( ) const

Returns the number of samples.

Returns: the number of samples.

Definition at line 382 of file inv_source_estimate.cpp.

◆ write()

bool InvSourceEstimate::write ( QIODevice & p_IODevice )

mne_write_stc_file

Writes a stc file

Parameters

[in] p_IODevice IO device to write the stc to.

Definition at line 209 of file inv_source_estimate.cpp.

◆ write_w()

void InvSourceEstimate::write_w ( const QString & path ) const

Write the first time point of this source estimate to a .w file.

Parameters

[in] path Path to the .w file to write.

Since: 2.2.0

Definition at line 303 of file inv_source_estimate.cpp.

Member Data Documentation

◆ connectivity

std::vector<InvConnectivity> INVLIB::InvSourceEstimate::connectivity

Pairwise connectivity matrices between sources (one per metric / freq band).

Definition at line 249 of file inv_source_estimate.h.

◆ couplings

std::vector<InvSourceCoupling> INVLIB::InvSourceEstimate::couplings

Correlated source groups overlaid on the grid.

Definition at line 243 of file inv_source_estimate.h.

◆ data

Eigen::MatrixXd INVLIB::InvSourceEstimate::data

Matrix of shape [n_dipoles x n_times] which contains the data in source space.

Definition at line 228 of file inv_source_estimate.h.

◆ focalDipoles

std::vector<InvFocalDipole> INVLIB::InvSourceEstimate::focalDipoles

Off-grid focal dipoles (ECD results).

Definition at line 246 of file inv_source_estimate.h.

◆ method

InvEstimateMethod INVLIB::InvSourceEstimate::method

The inverse method that produced this estimate.

Definition at line 235 of file inv_source_estimate.h.

◆ orientationType

InvOrientationType INVLIB::InvSourceEstimate::orientationType

Orientation constraint used (fixed, free, loose).

Definition at line 237 of file inv_source_estimate.h.

◆ positions

Eigen::MatrixX3f INVLIB::InvSourceEstimate::positions

3D positions (m) in head coordinates, one row per source. Empty when positions live in an external source space.

Definition at line 240 of file inv_source_estimate.h.

◆ sourceSpaceType

InvSourceSpaceType INVLIB::InvSourceEstimate::sourceSpaceType

Source space type (surface, volume, mixed, discrete).

Definition at line 236 of file inv_source_estimate.h.

◆ times

Eigen::RowVectorXf INVLIB::InvSourceEstimate::times

The time vector with n_times steps.

Definition at line 230 of file inv_source_estimate.h.

◆ tmin

float INVLIB::InvSourceEstimate::tmin

Time starting point.

Definition at line 231 of file inv_source_estimate.h.

◆ tstep

float INVLIB::InvSourceEstimate::tstep

Time steps within the times vector.

Definition at line 232 of file inv_source_estimate.h.

◆ vertices

Eigen::VectorXi INVLIB::InvSourceEstimate::vertices

The indices of the dipoles in the different source spaces. In the clustered case, holds the ROI indices.

Definition at line 229 of file inv_source_estimate.h.

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

src/libraries/inv/inv_source_estimate.h
src/libraries/inv/inv_source_estimate.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ InvSourceEstimate() [1/4]

◆ InvSourceEstimate() [2/4]

◆ InvSourceEstimate() [3/4]

◆ InvSourceEstimate() [4/4]

Member Function Documentation

◆ clear()

◆ getIndicesByLabel()

◆ hasConnectivity()

◆ hasCouplings()

◆ hasFocalDipoles()

◆ hasGridData()

◆ hasPositions()

◆ isEmpty()

◆ operator=()

◆ read()

◆ read_w()

◆ reduce()

◆ samples()

◆ write()

◆ write_w()

Member Data Documentation

◆ connectivity

◆ couplings

◆ data

◆ focalDipoles

◆ method

◆ orientationType

◆ positions

◆ sourceSpaceType

◆ times

◆ tmin

◆ tstep

◆ vertices