v2.0.0
Loading...
Searching...
No Matches
UTILSLIB::MultitaperTfr Class Reference

Sliding-window multitaper time-frequency representation. More...

#include <multitaper_tfr.h>

Static Public Member Functions

static MultitaperTfrResult compute (const Eigen::MatrixXd &matData, double sfreq, int windowSize=256, int stepSize=-1, double halfBandwidth=4.0, int nTapers=-1)
static MultitaperTfrResult computeArray (const Eigen::MatrixXd &matData, double sfreq, const Eigen::RowVectorXd &vecFreqs, double nCycles=7.0, double timeBandwidth=4.0, bool zeroMean=true)

Detailed Description

Sliding-window multitaper time-frequency representation.

Slides a fixed-length analysis window across the data and computes a multitaper PSD at each position, yielding a time-frequency power map per channel.

Definition at line 78 of file multitaper_tfr.h.

Member Function Documentation

◆ compute()

MultitaperTfrResult MultitaperTfr::compute ( const Eigen::MatrixXd & matData,
double sfreq,
int windowSize = 256,
int stepSize = -1,
double halfBandwidth = 4.0,
int nTapers = -1 )
static

Compute sliding-window multitaper TFR for every channel of a data matrix.

Parameters
[in]matDataData matrix (n_channels × n_times).
[in]sfreqSampling frequency in Hz.
[in]windowSizeAnalysis window length in samples (default 256).
[in]stepSizeStep size in samples; -1 → windowSize / 2.
[in]halfBandwidthHalf-bandwidth parameter (NW); default 4.0.
[in]nTapersNumber of DPSS tapers; -1 → floor(2*halfBandwidth - 1).
Returns
MultitaperTfrResult with tfrData, vecFreqs, vecTimes.

Definition at line 49 of file multitaper_tfr.cpp.

◆ computeArray()

MultitaperTfrResult MultitaperTfr::computeArray ( const Eigen::MatrixXd & matData,
double sfreq,
const Eigen::RowVectorXd & vecFreqs,
double nCycles = 7.0,
double timeBandwidth = 4.0,
bool zeroMean = true )
static

Compute multitaper power at every sample with frequency-specific DPSS wavelets, as mne.time_frequency.tfr_array_multitaper(..., output="power") does for one epoch.

Parameters
[in]matDataData matrix (n_channels × n_times).
[in]sfreqSampling frequency in Hz.
[in]vecFreqsFrequencies of interest in Hz.
[in]nCyclesNumber of cycles in each wavelet (default 7).
[in]timeBandwidthTime-bandwidth product; floor(timeBandwidth - 1) tapers (default 4).
[in]zeroMeanMake each wavelet zero mean (default true).
Returns
MultitaperTfrResult: per channel n_freqs × n_times, vecTimes = sample times.

Definition at line 139 of file multitaper_tfr.cpp.


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