Allow EventDetection` to store channel index (#620)

Co-authored-by: Steph Prince <[email protected]>

Author: rly

core/nwb.ecephys.yaml

@@ -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
@@ -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

docs/format/source/format_release_notes.rst

@@ -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)
 -------------------------