[electrophysiology_browser] EventPanel 2.0 | HED Endorsement | Channels Support (EEG-BIDS) | Miscellaneous Features

[jeffersoncasimir]

This PR adds the latest EEG features from EEGNet.

Notably, this includes a major overhaul to the Event Panel and adds the ability to "Endorse" HED tags - as well as caveat and/or comment. Filter/search also added.

Additional features to support event channels: i.e. Events can be created/tagged for subsets of channels.

• Toggle selection from montage view
• Toggle selection from signals
• time segment highlighting is now channel-based (all unless defined)

Downloadable dynamic events.json file (Dataset Tag Manager) updates itself after new tags are added/used.

Screenshots:

[christinerogers]

@jeffersoncasimir how about adding to the PR description something like : generates updated and downloadable BIDS-compliant events.json based on current tags, via the Dataset Tag Manager submodule

[christinerogers]

Note also: I edited the PR description for a bit more clarity esp for the release notes.

• HED link is down https://www.hed-resources.org/en/latest/index.html
  maybe just link to HEDtags.org?

@jeffersoncasimir want to let me know for Monday if you need more info to reproduce these?

where I tested it on https://jcasimir-test-27.loris.ca/electrophysiology_browser/sessions/2161?outputType=raw:

• Dataset Tag manager button not visible - not testable.
• Tagged by / Endorsed by / Caveat By -> these lists are empty, feature is not usable. Is a patch / something else missing?
• Adding a second HED Artifact tag doesn't work: Message: fill all the other tags first -- also if it's a warning /error it shouldn't be green.

Did more testing on : https://jcasimir-test-27.loris.ca/electrophysiology_browser/sessions/167?outputType=raw

• Adding any HED Artifact tag doesn't work
• Endorsement problem w keystrokes: If I use the key strokes (^ C or M) after clicking in the 3rd HED tag, it changes the 1st HED tag visible. Please disable and remove the hover text regarding keystrokes if it can't be fixed for this release
• can't undo my own Caveat.
• tried to remove 2 tags added by Data authors. It showed me the X next to each orange tag (suggesting I could) so I clicked. then clicked Submit. got an error message but no details. The orange tags disappear and the submit button greyed out, but when i navigate elsewhere I am asked to confirm that i will lose changes. If i refresh the orange tags are back (delete failed)
• from the HEd endorsement panel -- the edit pencil likewise suggests I can edit tags but I don't have that permission as admin. either the messaging or the behaviour needs clarification.
• unclear how to add a tag only to specific channels, without changing the channel scope of all tags. When I go to add a tag for only a few channels it changes the channels on all the existing tags added by Data Authors which are otherwise uneditable (or so it seems)

[jeffersoncasimir]

@christinerogers please retest and amend the list to remove items that were due to the timing in which you were testing (like a crucial button not being visible). You apparently caught my testing VM in a window where I was rebuilding to test another PR. Make sure to use the OTT recordings and not the random other one.

Please note, an instance-level HED tag must be manually added (or present in the recording, which is not the case here) in order to appear on the list of HED endorsements. To test the (non-DTM) HED endorsement feature, you need to manually add a HED tag first.

Also, some of these points are not realistically fixable for the release or are known by the EEGNet team and have a corresponding open issue. If any changes are requested, please formulate them as such.

[christinerogers]

Followup PR can include:

• configurable HED Endorsement (useHEDendorsement Yes/No) since some LORISes may not use endorsement
• maybe also configurable HED support/visibility ; since some LORISes may not want users to add tags (useHEDtags config; and/or permission to add, which would also need to be project-specific)
• documentation on these features (e.g. module markdown, changelog)
• note if above configs are added, help text displayed should also be governed by this config

[charliehenrib]

• Is it normal there are no all types?

• I think the link column can be removed from the csv download:
  data-2025-11-11T14_11_04.564Z.csv

• Broken link:

• When is this button available? It's always greyed out for me.

• I am getting a 500 error when downloading events file at URL: https://jcasimir-test-27.loris.ca/electrophysiology_browser/events?physioFileID=4&filePath=bids_imports/Face13_BIDSVersion_1.1.0/sub-OTT176/ses-V1/eeg/sub-OTT176_ses-V1_task-faceO_events.tgz
• Same for all files download

[charliehenrib]

@jeffersoncasimir Could you add some testing instructions please. It is the first time I am looking at this module and I don't really know where to go and what to test. Thank you

[jeffersoncasimir]

• Is it normal there are no all types?

Yes. Thanks for pointing out that the help text should be revised. An "all" type appears if there is a "derivative" type. You would see raw | derivative | all, where either link only displays one and "all" would display both.

• I think the link column can be removed from the csv download:

This is a valid issue, however I don't think it was introduced by this PR.

• Broken link:

Noted. They recently moved the URL and set up redirection for seamlessness, but it was not done correctly (you can remove the www. and everything after .org to see redirection). I will modify to the new URL.

• When is this button available? It's always greyed out for me.

It becomes available when you highlight a segment on the plot. This buttons changes the page bounds to this range.

• I am getting a 500 error when downloading events file at URL: https://jcasimir-test-27.loris.ca/electrophysiology_browser/events?physioFileID=4&filePath=bids_imports/Face13_BIDSVersion_1.1.0/sub-OTT176/ses-V1/eeg/sub-OTT176_ses-V1_task-faceO_events.tgz
• Same for all files download

Good catch. This is because the data is a symbolic link to raisinbread. I forgot that was the case on this VM. I will copy over the event files so that they are modifiable (required to download).

@jeffersoncasimir Could you add some testing instructions please. It is the first time I am looking at this module and I don't really know where to go and what to test. Thank you

The testing plan is a great starting point, and the help text has been expanded with a list of most features, but I will write something up that is tailored to this PR.

[jeffersoncasimir]

@charliehenrib fyi: data has been copied over from raisinbread and should now be downloadable

[kongtiaowang]

@jeffersoncasimir I found two small issues:

1,When a session has multiple EEGs, the brain map visualization is incorrect.

2,The HED link does not lead to a webpage.

[jeffersoncasimir]

1,When a session has multiple EEGs, the brain map visualization is incorrect.

Please use the raisinbread participants. This particular subject is experimental and just happens to be on my personal VM currently.

2,The HED link does not lead to a webpage.

This has been pointed out by the other two testers and is known.

[jeffersoncasimir]

@christinerogers @charliehenrib @kongtiaowang The HED resources URL has been modfiied.

[charliehenrib]

Still getting an error in the background

[charliehenrib]

THe error reported by Christine: tried to remove 2 tags added by Data authors. It showed me the X next to each orange tag (suggesting I could) so I clicked. then clicked Submit. got an error message but no details. The orange tags disappear and the submit button greyed out, but when i navigate elsewhere I am asked to confirm that i will lose changes. If i refresh the orange tags are back (delete failed) is still happening for me