This class computes the cross correlation connectivity metric. More...

#include <crosscorrelation.h>

Public Types
typedef QSharedPointer< CrossCorrelation >	SPtr
typedef QSharedPointer< const CrossCorrelation >	ConstSPtr
Public Types inherited from CONNECTIVITYLIB::AbstractMetric
typedef QSharedPointer< AbstractMetric >	SPtr
typedef QSharedPointer< const AbstractMetric >	ConstSPtr

Public Member Functions
	CrossCorrelation ()
Public Member Functions inherited from CONNECTIVITYLIB::AbstractMetric
	AbstractMetric ()

Static Public Member Functions
static Network	calculate (ConnectivitySettings &connectivitySettings)

Static Protected Member Functions
static void	compute (ConnectivitySettings::IntermediateTrialData &inputData, Eigen::MatrixXd &matDist, QMutex &mutex, int iNfft, const QPair< Eigen::MatrixXd, Eigen::VectorXd > &tapers)

Additional Inherited Members
Static Public Attributes inherited from CONNECTIVITYLIB::AbstractMetric
static bool	m_bStorageModeIsActive = false
static int	m_iNumberBinStart = -1
static int	m_iNumberBinAmount = -1

Detailed Description

This class computes the cross correlation connectivity metric.

Definition at line 82 of file crosscorrelation.h.

Inheritance diagram for CONNECTIVITYLIB::CrossCorrelation:

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for CrossCorrelation.

Definition at line 87 of file crosscorrelation.h.

◆ SPtr

typedef QSharedPointer<CrossCorrelation> CONNECTIVITYLIB::CrossCorrelation::SPtr

Shared pointer type for CrossCorrelation.

Definition at line 86 of file crosscorrelation.h.

Constructor & Destructor Documentation

◆ CrossCorrelation()

CrossCorrelation::CrossCorrelation ( )

explicit

Constructs a CrossCorrelation object.

Definition at line 75 of file crosscorrelation.cpp.

Member Function Documentation

◆ calculate()

Network CrossCorrelation::calculate ( ConnectivitySettings & connectivitySettings )

static

Calculates the cross correlation between the rows of the data matrix.

Parameters

[in] connectivitySettings The input data and parameters.

Returns: The connectivity information in form of a network structure.

Definition at line 81 of file crosscorrelation.cpp.

◆ compute()

void CrossCorrelation::compute	(	ConnectivitySettings::IntermediateTrialData &	inputData,
		Eigen::MatrixXd &	matDist,
		QMutex &	mutex,
		int	iNfft,
		const QPair< Eigen::MatrixXd, Eigen::VectorXd > &	tapers )

staticprotected

Calculates the connectivity matrix for a given input data matrix based on the cross correlation coefficient.

Parameters

[in]	inputData	The input data.
[out]	matDist	The sum of all edge weights.
[in]	mutex	The mutex used to safely access matDist.
[in]	iNfft	The FFT length.
[in]	tapers	The taper information.

Definition at line 179 of file crosscorrelation.cpp.

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

src/libraries/connectivity/metrics/crosscorrelation.h
src/libraries/connectivity/metrics/crosscorrelation.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members