v2.0.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
CONNECTIVITYLIB::ConnectivitySettings Class Reference

Aggregates trial data, spectral cache and node geometry shared by all CONNECTIVITYLIB metrics. More...

#include <connectivitysettings.h>

Classes

struct  IntermediateTrialData
 Per-trial intermediate frequency-domain data used during connectivity computation. More...
struct  IntermediateSumData
 Accumulated cross-spectral and auto-spectral sums across trials for final metric normalization. More...

Public Types

typedef QSharedPointer< ConnectivitySettings > SPtr
typedef QSharedPointer< const ConnectivitySettings > ConstSPtr

Public Member Functions

 ConnectivitySettings ()
void clearAllData ()
void clearIntermediateData ()
void append (const QList< Eigen::MatrixXd > &matInputData)
void append (const Eigen::MatrixXd &matInputData)
void append (const ConnectivitySettings::IntermediateTrialData &inputData)
const IntermediateTrialData & at (int i) const
int size () const
bool isEmpty () const
void removeFirst (int iAmount=1)
void removeLast (int iAmount=1)
void setConnectivityMethods (const QStringList &sConnectivityMethods)
const QStringList & getConnectivityMethods () const
void setSamplingFrequency (int iSFreq)
int getSamplingFrequency () const
void setFFTSize (int iNfft)
int getFFTSize () const
void setWindowType (const QString &sWindowType)
const QString & getWindowType () const
void setNodePositions (const FIFFLIB::FiffInfo &fiffInfo, const Eigen::RowVectorXi &picks)
void setNodePositions (const MNELIB::MNEForwardSolution &forwardSolution, const FSLIB::FsSurfaceSet &surfSet)
void setNodePositions (const Eigen::MatrixX3f &matNodePositions)
const Eigen::MatrixX3f & getNodePositions () const
QList< IntermediateTrialData > & getTrialData ()
IntermediateSumData & getIntermediateSumData ()

Protected Attributes

QStringList m_sConnectivityMethods
QString m_sWindowType
float m_fSFreq
int m_iNfft
float m_fFreqResolution
Eigen::MatrixX3f m_matNodePositions
IntermediateSumData m_intermediateSumData
QList< IntermediateTrialData > m_trialData

Detailed Description

Aggregates trial data, spectral cache and node geometry shared by all CONNECTIVITYLIB metrics.

Mutable container that aggregates the inputs and intermediate spectral results required by every metric implementation in CONNECTIVITYLIB.

Each call to append adds one trial; the trial matrices live in m_trialData, while DPSS tapered spectra, cross-spectral densities and their imaginary-part derivatives are filled in lazily by whichever metric runs first. Cross-trial sums accumulate in m_intermediateSumData so that a second metric run on the same data set reuses those sums and skips the FFT pass entirely. Node positions can be derived from a FiffInfo (sensor space) or from a forward solution + FsSurfaceSet (source space) and are propagated into the resulting Network nodes.

Definition at line 96 of file connectivitysettings.h.

Member Typedef Documentation

◆ ConstSPtr

typedef QSharedPointer<const ConnectivitySettings> CONNECTIVITYLIB::ConnectivitySettings::ConstSPtr

Const shared pointer type for ConnectivitySettings.

Definition at line 101 of file connectivitysettings.h.

◆ SPtr

typedef QSharedPointer<ConnectivitySettings> CONNECTIVITYLIB::ConnectivitySettings::SPtr

Shared pointer type for ConnectivitySettings.

Definition at line 100 of file connectivitysettings.h.

Constructor & Destructor Documentation

◆ ConnectivitySettings()

ConnectivitySettings::ConnectivitySettings ( )
explicit

Constructs a ConnectivitySettings object.

Definition at line 61 of file connectivitysettings.cpp.

Member Function Documentation

◆ append() [1/3]

void ConnectivitySettings::append ( const ConnectivitySettings::IntermediateTrialData & inputData)

Definition at line 122 of file connectivitysettings.cpp.

◆ append() [2/3]

void CONNECTIVITYLIB::ConnectivitySettings::append ( const Eigen::MatrixXd & matInputData)

◆ append() [3/3]

void CONNECTIVITYLIB::ConnectivitySettings::append ( const QList< Eigen::MatrixXd > & matInputData)

◆ at()

const ConnectivitySettings::IntermediateTrialData & ConnectivitySettings::at ( int i) const

Definition at line 129 of file connectivitysettings.cpp.

◆ clearAllData()

void ConnectivitySettings::clearAllData ( )

Definition at line 72 of file connectivitysettings.cpp.

◆ clearIntermediateData()

void ConnectivitySettings::clearIntermediateData ( )

Definition at line 81 of file connectivitysettings.cpp.

◆ getConnectivityMethods()

const QStringList & ConnectivitySettings::getConnectivityMethods ( ) const

Definition at line 259 of file connectivitysettings.cpp.

◆ getFFTSize()

int ConnectivitySettings::getFFTSize ( ) const

Definition at line 304 of file connectivitysettings.cpp.

◆ getIntermediateSumData()

ConnectivitySettings::IntermediateSumData & ConnectivitySettings::getIntermediateSumData ( )

Definition at line 403 of file connectivitysettings.cpp.

◆ getNodePositions()

const MatrixX3f & ConnectivitySettings::getNodePositions ( ) const

Definition at line 389 of file connectivitysettings.cpp.

◆ getSamplingFrequency()

int ConnectivitySettings::getSamplingFrequency ( ) const

Definition at line 283 of file connectivitysettings.cpp.

◆ getTrialData()

QList< ConnectivitySettings::IntermediateTrialData > & ConnectivitySettings::getTrialData ( )

Definition at line 396 of file connectivitysettings.cpp.

◆ getWindowType()

const QString & ConnectivitySettings::getWindowType ( ) const

Definition at line 321 of file connectivitysettings.cpp.

◆ isEmpty()

bool ConnectivitySettings::isEmpty ( ) const

Definition at line 143 of file connectivitysettings.cpp.

◆ removeFirst()

void ConnectivitySettings::removeFirst ( int iAmount = 1)

Definition at line 150 of file connectivitysettings.cpp.

◆ removeLast()

void ConnectivitySettings::removeLast ( int iAmount = 1)

Definition at line 201 of file connectivitysettings.cpp.

◆ setConnectivityMethods()

void ConnectivitySettings::setConnectivityMethods ( const QStringList & sConnectivityMethods)

Definition at line 252 of file connectivitysettings.cpp.

◆ setFFTSize()

void ConnectivitySettings::setFFTSize ( int iNfft)

Definition at line 290 of file connectivitysettings.cpp.

◆ setNodePositions() [1/3]

void CONNECTIVITYLIB::ConnectivitySettings::setNodePositions ( const Eigen::MatrixX3f & matNodePositions)

◆ setNodePositions() [2/3]

void CONNECTIVITYLIB::ConnectivitySettings::setNodePositions ( const FIFFLIB::FiffInfo & fiffInfo,
const Eigen::RowVectorXi & picks )

◆ setNodePositions() [3/3]

void ConnectivitySettings::setNodePositions ( const MNELIB::MNEForwardSolution & forwardSolution,
const FSLIB::FsSurfaceSet & surfSet )

Definition at line 347 of file connectivitysettings.cpp.

◆ setSamplingFrequency()

void ConnectivitySettings::setSamplingFrequency ( int iSFreq)

Definition at line 266 of file connectivitysettings.cpp.

◆ setWindowType()

void ConnectivitySettings::setWindowType ( const QString & sWindowType)

Definition at line 311 of file connectivitysettings.cpp.

◆ size()

int ConnectivitySettings::size ( ) const

Definition at line 136 of file connectivitysettings.cpp.

Member Data Documentation

◆ m_fFreqResolution

float CONNECTIVITYLIB::ConnectivitySettings::m_fFreqResolution
protected

The spectrum's resolution.

Definition at line 191 of file connectivitysettings.h.

◆ m_fSFreq

float CONNECTIVITYLIB::ConnectivitySettings::m_fSFreq
protected

The sampling frequency.

Definition at line 189 of file connectivitysettings.h.

◆ m_iNfft

int CONNECTIVITYLIB::ConnectivitySettings::m_iNfft
protected

The FFT length. Also includes the negativ frequencies. Gets recalculated if the sFreq or spectrum resolution change.

Definition at line 190 of file connectivitysettings.h.

◆ m_intermediateSumData

IntermediateSumData CONNECTIVITYLIB::ConnectivitySettings::m_intermediateSumData
protected

The intermediate sum data holds data calculated over all trials as a whole.

Definition at line 195 of file connectivitysettings.h.

◆ m_matNodePositions

Eigen::MatrixX3f CONNECTIVITYLIB::ConnectivitySettings::m_matNodePositions
protected

The node position in 3D space.

Definition at line 193 of file connectivitysettings.h.

◆ m_sConnectivityMethods

QStringList CONNECTIVITYLIB::ConnectivitySettings::m_sConnectivityMethods
protected

The connectivity methods.

Definition at line 186 of file connectivitysettings.h.

◆ m_sWindowType

QString CONNECTIVITYLIB::ConnectivitySettings::m_sWindowType
protected

The window type used to compute tapered spectra.

Definition at line 187 of file connectivitysettings.h.

◆ m_trialData

QList<IntermediateTrialData> CONNECTIVITYLIB::ConnectivitySettings::m_trialData
protected

The trial data holds the actual and intermediate data calcualted for each trial.

Definition at line 196 of file connectivitysettings.h.

The documentation for this class was generated from the following files:
Generated on for MNE-CPP by doxygen 1.16.1