Emit an error if you try to use cHPI functions on data with cHPI disabled

Open
#12,094 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
data

Research direction

Start by locating the cHPI functions and the Info metadata used to represent whether cHPI was enabled during recording. Reproduce their current empty-array or NaN behavior with cHPI-disabled data, then identify the expected metadata check and add coverage showing that an informative error is raised.

Written by the indexing model from the issue text.

Description

ENH
Describe the new feature or enhancement

Hello, we notice today that you can run without any error cHPI functions on data which did not have cHPI enabled.
It does return empty arrays, or arrays filled with nans, but an error message would be less confusing.

Do we have a definitive way to find out if cHPI was on or off during a recording in an Info?

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

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.

More from mne-tools/mne-python

All issues in mne-tools/mne-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.