mne-tools / mne-tools/mne-python

TFR analysis with more flexibility

Open
#8,380 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ENH
Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

Addition of the tapering windows for TFR analysis

The library only contains Morelet wavelet and it does not include other wavelets. There is no way to use other tapering windows but the DPSS and Gaussian windows. Nevertheless, users can define their own wavelet series and apply them to their signals using the cwt function; this however, may degrade the integrity of the library.

Implementation

The library does include the Morelet function which returns the wavelet series for the Morelet wavelet at different scales. Other wavelets can also be defined with the same signature of this function. Then, users can compute their TFR using these wavelet series with the use of cwt function of the time frequency module.

Possible alternatives

The code can also adds an ultimate freedom to the end users by letting them define their own tapering window and the oscillatory signal. This way the function can replace the Morelet function.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the time frequency module, including the existing Morlet function and the cwt entry point. The issue does not name files, tests, or a settled API, so first clarify whether support should cover additional wavelets, user-defined tapering windows, or both. Done requires an agreed scope and tests demonstrating the selected flexibility.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.