UTILSLIB::MorletTfr Class Reference

Complex Morlet wavelet time-frequency representation. More...

#include <morlet_tfr.h>

Static Public Member Functions
static MorletTfrResult	compute (const Eigen::RowVectorXd &vecData, double dSFreq, const Eigen::RowVectorXd &vecFreqs, double dNCycles=7.0)
static QVector< MorletTfrResult >	computeMultiChannel (const Eigen::MatrixXd &matData, double dSFreq, const Eigen::RowVectorXd &vecFreqs, double dNCycles=7.0, const Eigen::RowVectorXi &vecPicks=Eigen::RowVectorXi())
static Eigen::VectorXcd	buildWavelet (double dFreq, double dSFreq, double dNCycles, int &halfLen, bool bZeroMean=false)

Detailed Description

Complex Morlet wavelet time-frequency representation.

For each requested centre frequency f the signal is convolved (via FFT) with a complex Morlet wavelet whose time-domain standard deviation is σ_t = nCycles / (2π·f) The instantaneous power at every time sample is |convolution|².

Definition at line 80 of file morlet_tfr.h.

Member Function Documentation

buildWavelet()

VectorXcd MorletTfr::buildWavelet ( double dFreq, double dSFreq, double dNCycles, int & halfLen, bool bZeroMean = false )

static

Build a complex Morlet wavelet for a given frequency, as mne.time_frequency.morlet does: sampled out to 5 σ_t on either side of a sample at t = 0 and scaled to norm √2.

Parameters

[in]	dFreq	Centre frequency in Hz.
[in]	dSFreq	Sampling frequency in Hz.
[in]	dNCycles	Number of cycles.
[out]	halfLen	Half-length of the returned wavelet in samples.
[in]	bZeroMean	Subtract the admissibility offset (zero_mean in MNE-Python).

Returns

Complex wavelet column vector of length 2·halfLen+1.

Definition at line 63 of file morlet_tfr.cpp.

compute()

MorletTfrResult MorletTfr::compute ( const Eigen::RowVectorXd & vecData, double dSFreq, const Eigen::RowVectorXd & vecFreqs, double dNCycles = 7.0 )

static

Compute Morlet TFR for a single channel time series.

Parameters

[in]	vecData	Single-channel data row vector (1 × n_samples).
[in]	dSFreq	Sampling frequency in Hz.
[in]	vecFreqs	Centre frequencies in Hz (row vector).
[in]	dNCycles	Number of wavelet cycles (controls time–frequency trade-off; default 7).

Returns

MorletTfrResult with matPower (n_freqs × n_samples).

Definition at line 88 of file morlet_tfr.cpp.

computeMultiChannel()

QVector< MorletTfrResult > MorletTfr::computeMultiChannel ( const Eigen::MatrixXd & matData, double dSFreq, const Eigen::RowVectorXd & vecFreqs, double dNCycles = 7.0, const Eigen::RowVectorXi & vecPicks = Eigen::RowVectorXi() )

static

Compute Morlet TFR for every (selected) channel of a data matrix.

Parameters

[in]	matData	Data matrix (n_channels × n_samples).
[in]	dSFreq	Sampling frequency in Hz.
[in]	vecFreqs	Centre frequencies in Hz.
[in]	dNCycles	Number of wavelet cycles (default 7).
[in]	vecPicks	Channel row indices; empty = all channels.

Returns

One MorletTfrResult per selected channel.

Definition at line 145 of file morlet_tfr.cpp.

---

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

• src/libraries/dsp/morlet_tfr.h
• src/libraries/dsp/morlet_tfr.cpp