Skip to content

Allow EventDetection` to store channel index #620

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 9, 2025
Merged

Allow EventDetection` to store channel index #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cf13077
Allow EventDetection` to store channel index
rly May 2, 2025
b6279af
Update release notes
rly May 2, 2025
f59a73a
Update format_release_notes.rst
rly May 2, 2025
2036b6f
Merge branch 'dev' into event_detection_channel
stephprince Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions core/nwb.ecephys.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,16 @@ groups:
- name: source_idx
dtype: int32
dims:
- num_events
- - num_events
- - num_events
- time_index, channel_index
shape:
- null
doc: Indices (zero-based) into source ElectricalSeries::data array corresponding
to time of event. ''description'' should define what is meant by time of
event (e.g., .25 ms before action potential peak, zero-crossing time, etc).
- - null
- - null
- 2
doc: Indices (zero-based) into the linked source ElectricalSeries::data array corresponding
to time of event or time and channel of event. ''description'' should define what is meant
by time of event (e.g., .25 ms before action potential peak, zero-crossing time, etc).
The index points to each event from the raw data.
- name: times
dtype: float64
Expand All @@ -180,6 +184,7 @@ groups:
dtype: text
value: seconds
doc: Unit of measurement for event times, which is fixed to 'seconds'.
quantity: '?'
links:
- name: source_electricalseries
target_type: ElectricalSeries
Expand Down
2 changes: 2 additions & 0 deletions docs/format/source/format_release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ Major changes
- Changed ``NWBFile.electrodes`` from a generic ``DynamicTable`` with added columns to a new ``ElectrodesTable``
neurodata type that extends ``DynamicTable`` with added columns. (#539, #624)
- Changed ``DecompositionSeries.bands`` from a generic ``DynamicTable`` with added columns to a new ``FrequencyBandsTable`` neurodata type that extends ``DynamicTable`` with added columns. (#610)
- Allowed `EventDetection` to have shape (num_events, 2) to store the channel index of the detected event. (#620)

Minor changes
^^^^^^^^^^^^^
- Made group quantities consistent ("1 or more") across data interfaces / wrapper types (#613)
- Fixed typo and removed HTML tag from doc of behavioral neurodata types. (#600)
- Made `EventDetection.times` optional. (#620)

2.8.0 (November 24, 2024)
-------------------------
Expand Down