CONNECTIVITYLIB::AbstractMetric Class Reference

Static control knobs (storage mode, frequency band) shared by all CONNECTIVITYLIB metrics. More...

#include <abstractmetric.h>

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

Public Member Functions
	AbstractMetric ()

Static Public Attributes
static bool	m_bStorageModeIsActive = false
static int	m_iNumberBinStart = -1
static int	m_iNumberBinAmount = -1

Detailed Description

Static control knobs (storage mode, frequency band) shared by all CONNECTIVITYLIB metrics.

Static base for every estimator in CONNECTIVITYLIB. Holds the two pieces of global state that the dispatcher (Connectivity::calculate) must set before any metric runs:

• CONNECTIVITYLIB::AbstractMetric::m_bStorageModeIsActive "m_bStorageModeIsActive" enables caching of per-trial tapered spectra and CSDs in ConnectivitySettings::IntermediateTrialData, which lets a second metric reuse the FFT work done by the first.
• CONNECTIVITYLIB::AbstractMetric::m_iNumberBinStart "m_iNumberBinStart" and CONNECTIVITYLIB::AbstractMetric::m_iNumberBinAmount "m_iNumberBinAmount" define the frequency-bin window over which each metric averages its spectral output into the single scalar weight stored on each network edge.

Definition at line 83 of file abstractmetric.h.

Inheritance diagram for CONNECTIVITYLIB::AbstractMetric:

Member Typedef Documentation

ConstSPtr

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

Const shared pointer type for AbstractMetric.

Definition at line 87 of file abstractmetric.h.

SPtr

typedef QSharedPointer<AbstractMetric> CONNECTIVITYLIB::AbstractMetric::SPtr

Shared pointer type for AbstractMetric.

Definition at line 86 of file abstractmetric.h.

Constructor & Destructor Documentation

AbstractMetric()

AbstractMetric::AbstractMetric ( )

explicit

Constructs a AbstractMetric object.

Definition at line 47 of file abstractmetric.cpp.

Member Data Documentation

m_bStorageModeIsActive

bool AbstractMetric::m_bStorageModeIsActive = false

static

Definition at line 95 of file abstractmetric.h.

m_iNumberBinAmount

int AbstractMetric::m_iNumberBinAmount = -1

static

Definition at line 97 of file abstractmetric.h.

m_iNumberBinStart

int AbstractMetric::m_iNumberBinStart = -1

static

Definition at line 96 of file abstractmetric.h.

---

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

• src/libraries/connectivity/metrics/abstractmetric.h
• src/libraries/connectivity/metrics/abstractmetric.cpp