Single equivalent current dipole with position, orientation, amplitude, and goodness-of-fit. More...

#include <inv_ecd.h>

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

Public Member Functions
	InvEcd ()
	InvEcd (const InvEcd &p_ECD)
InvEcd &	operator= (const InvEcd &other)=default
	~InvEcd ()
void	print () const

Public Attributes
bool	valid
float	time
Eigen::Vector3f	rd
Eigen::Vector3f	Q
float	good
float	khi2
int	nfree
int	neval

Detailed Description

Single equivalent current dipole with position, orientation, amplitude, and goodness-of-fit.

Implements one Electric Current Dipole (Replaces *ecd,ecdRec struct of MNE-C fit_types.h).

Definition at line 57 of file inv_ecd.h.

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for InvEcd.

Definition at line 61 of file inv_ecd.h.

◆ SPtr

typedef QSharedPointer<InvEcd> INVLIB::InvEcd::SPtr

Shared pointer type for InvEcd.

Definition at line 60 of file inv_ecd.h.

Constructor & Destructor Documentation

◆ InvEcd() [1/2]

InvEcd::InvEcd ( )

Constructs the Electric Current Dipole

Definition at line 34 of file inv_ecd.cpp.

◆ InvEcd() [2/2]

InvEcd::InvEcd ( const InvEcd & p_ECD )

Copy constructor.

Parameters

[in] p_ECD Electric Current Dipole which should be copied.

Definition at line 48 of file inv_ecd.cpp.

◆ ~InvEcd()

InvEcd::~InvEcd ( )

Destroys the Electric Current Dipole description

Definition at line 62 of file inv_ecd.cpp.

Member Function Documentation

◆ operator=()

InvEcd & INVLIB::InvEcd::operator= ( const InvEcd & other )

default

Copy assignment. Every member has value semantics, so the compiler-generated member-wise assignment is correct. It is declared explicitly because declaring a copy constructor and/or a destructor deprecates the implicitly generated one.

Parameters

[in] other Object to assign from.

Returns: reference to this object.

◆ print()

void InvEcd::print ( ) const

Prints the InvEcd dipole information to the debug output.

Definition at line 68 of file inv_ecd.cpp.

Member Data Documentation

◆ good

float INVLIB::InvEcd::good

Goodness of fit.

Definition at line 107 of file inv_ecd.h.

◆ khi2

float INVLIB::InvEcd::khi2

khi^2 value.

Definition at line 108 of file inv_ecd.h.

◆ neval

int INVLIB::InvEcd::neval

Number of function evaluations required for this fit.

Definition at line 110 of file inv_ecd.h.

◆ nfree

int INVLIB::InvEcd::nfree

Degrees of freedom for the above.

Definition at line 109 of file inv_ecd.h.

◆ Q

Eigen::Vector3f INVLIB::InvEcd::Q

Dipole moment.

Definition at line 106 of file inv_ecd.h.

◆ rd

Eigen::Vector3f INVLIB::InvEcd::rd

Dipole location.

Definition at line 105 of file inv_ecd.h.

◆ time

float INVLIB::InvEcd::time

Time point.

Definition at line 104 of file inv_ecd.h.

◆ valid

bool INVLIB::InvEcd::valid

Is this dipole valid.

Definition at line 103 of file inv_ecd.h.

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

src/libraries/inv/dipole_fit/inv_ecd.h
src/libraries/inv/dipole_fit/inv_ecd.cpp

Public Types

Public Member Functions

Public Attributes