Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add combine_tfr to API #13054

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

tsbinns
Copy link
Contributor

@tsbinns tsbinns commented Jan 10, 2025

Follows from discussion in #12910 (comment). Also builds on code in that PR so should wait for that to be finalised before merging.

combine_tfr is a public function, but it's not documented in the API. This PR adds it to the documentation and also creates a link to it a changelog entry.

commit 6bd41c0
Merge: caf651d dedb392
Author: Thomas S. Binns <[email protected]>
Date:   Fri Jan 10 11:01:04 2025 +0000

    Merge branch 'main' into add_tfr_weights

commit caf651d
Author: Thomas Samuel Binns <[email protected]>
Date:   Thu Jan 9 21:27:11 2025 +0000

    Update changelog entries

commit 514258d
Merge: e5eedee 47ea360
Author: Daniel McCloy <[email protected]>
Date:   Thu Jan 9 10:40:03 2025 -0600

    Merge branch 'main' into add_tfr_weights

commit e5eedee
Merge: 012bd94 fd8c1ee
Author: Thomas S. Binns <[email protected]>
Date:   Sat Jan 4 12:23:19 2025 +0000

    Merge branch 'main' into add_tfr_weights

commit 012bd94
Author: Thomas Samuel Binns <[email protected]>
Date:   Fri Dec 20 11:36:48 2024 +0000

    Add version tag

commit 0d3d85d
Merge: 5b150aa 05bd738
Author: Thomas S. Binns <[email protected]>
Date:   Thu Dec 19 12:30:55 2024 +0000

    Merge branch 'main' into add_tfr_weights

commit 5b150aa
Merge: 82dfab9 bd4a160
Author: Thomas S. Binns <[email protected]>
Date:   Sat Dec 14 19:18:49 2024 +0000

    Merge branch 'main' into add_tfr_weights

commit 82dfab9
Author: Thomas Samuel Binns <[email protected]>
Date:   Sat Dec 14 19:00:34 2024 +0000

    Fix plotting with tapers

commit 80126a7
Author: Thomas Samuel Binns <[email protected]>
Date:   Wed Dec 11 21:40:34 2024 +0000

    Fix to_data_frame bug with tapers

commit de39d25
Merge: e3a3c4b a107991
Author: Thomas Samuel Binns <[email protected]>
Date:   Wed Dec 11 13:48:50 2024 +0000

    Begin fixing to_data_frame

commit e3a3c4b
Merge: 6af3310 b329515
Author: Thomas Samuel Binns <[email protected]>
Date:   Wed Dec 11 13:34:43 2024 +0000

    Merge remote-tracking branch 'upstream/main' into add_tfr_weights

commit 6af3310
Merge: 728701e dd61955
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 20:54:40 2024 +0000

    Merge branch 'add_tfr_weights' of https://github.com/tsbinns/mne-python into add_tfr_weights

commit 728701e
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 20:54:37 2024 +0000

    Add placeholder versionadded tags

commit dd61955
Merge: e12b09a 730358c
Author: Thomas S. Binns <[email protected]>
Date:   Tue Dec 10 16:23:13 2024 +0000

    Merge branch 'main' into add_tfr_weights

commit e12b09a
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 16:22:56 2024 +0000

    Updated docstrings

commit 999d122
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 16:02:14 2024 +0000

    Disallow aggregating tapers in combine_tfr

commit aaef4b7
Merge: e11fa2b b3eb56c
Author: Thomas S. Binns <[email protected]>
Date:   Tue Dec 10 13:46:48 2024 +0000

    Merge branch 'main' into add_tfr_weights

commit e11fa2b
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 13:46:14 2024 +0000

    Expand test coverage

commit 972aba2
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 13:46:00 2024 +0000

    Add weights to AverageTFR

commit b14a100
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Dec 10 13:45:42 2024 +0000

    Fix faulty state check

commit ca27179
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 18:33:30 2024 +0000

    Fix docstring entries

commit 01c486c
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 18:29:41 2024 +0000

    Begin add support for tapers in array objs

commit a107991
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 18:29:41 2024 +0000

    Begin add support for tapers in array objs

commit 6a23556
Merge: 54f2a32 2f9a4b4
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 12:33:58 2024 +0000

    Merge branch 'fix_tfr_tapers' into fix_tfr_multitapers

commit 54f2a32
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 11:43:38 2024 +0000

    Add changelog entry

commit 1c02b40
Author: Thomas Samuel Binns <[email protected]>
Date:   Mon Dec 9 11:37:18 2024 +0000

    Add missing test coverage

commit 5ad9bd5
Merge: 8d645bb 4967ecd
Author: Thomas S. Binns <[email protected]>
Date:   Mon Dec 9 10:17:06 2024 +0000

    Merge branch 'main' into add_tfr_weights

commit 8d645bb
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 29 20:00:14 2024 +0100

    Enforce return_weights as named param

commit 045d9a2
Merge: 2a03e9b 98d55b4
Author: Thomas S. Binns <[email protected]>
Date:   Tue Oct 29 19:57:02 2024 +0100

    Merge branch 'main' into add_tfr_weights

commit 2a03e9b
Merge: f155238 0755ef0
Author: Thomas S. Binns <[email protected]>
Date:   Mon Oct 28 11:12:29 2024 +0100

    Merge branch 'main' into add_tfr_weights

commit f155238
Merge: b4537b2 c63da99
Author: Thomas S. Binns <[email protected]>
Date:   Thu Oct 24 19:30:36 2024 +0200

    Merge branch 'main' into add_tfr_weights

commit b4537b2
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:45:42 2024 +0200

    Update docstrings

commit 2f9a4b4
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:43:40 2024 +0200

    Reapply "Update docstrings"

    This reverts commit 8c16716.

commit 51b8cd0
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:42:03 2024 +0200

    Remove outdated default setting

commit 8c16716
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:40:56 2024 +0200

    Revert "Update docstrings"

    This reverts commit 82fc2f7.

commit 7c3dcfa
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:39:51 2024 +0200

    Add PR num

commit 48afced
Merge: a49f934 9f30a59
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:38:03 2024 +0200

    Merge branch 'add_tfr_weights' of https://github.com/tsbinns/mne-python into add_tfr_weights

commit a49f934
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:38:02 2024 +0200

    Remove whitespace

commit 9f30a59
Merge: 82fc2f7 18c0d44
Author: Thomas S. Binns <[email protected]>
Date:   Tue Oct 22 11:36:54 2024 +0200

    Merge branch 'main' into add_tfr_weights

commit 82fc2f7
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:24:33 2024 +0200

    Update docstrings

commit 45c6a0b
Merge: 9fe1fb6 56e522b
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:17:45 2024 +0200

    Merge remote-tracking branch 'upstream/main' into add_tfr_weights

commit 9fe1fb6
Author: Thomas Samuel Binns <[email protected]>
Date:   Tue Oct 22 11:17:36 2024 +0200

    Add option to store and return tfr taper weights
@larsoner
Copy link
Member

larsoner commented Jan 10, 2025

If we do this I think it should be mne.time_frequency.combine_tfr probably, not mne.combine_tfr

EDIT: Ignore, you've already put it there!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants