Skip to content

Commit 03754fb

Browse files
committed
improve electrode group documentation
1 parent ade50ef commit 03754fb

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

core/nwb.ecephys.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,10 @@ groups:
235235

236236
- neurodata_type_def: ElectrodeGroup
237237
neurodata_type_inc: NWBContainer
238-
doc: A physical grouping of electrodes, e.g. a shank of an array.
238+
doc: A physical grouping of electrodes, e.g., a shank of an array. An electrode group is typically used to describe
239+
electrodes that are physically connected on a single device and are often (but not always) used together for
240+
analysis, such as for spike sorting. Note that this is descriptive metadata; electrodes from different groups
241+
can still be spike-sorted together if needed.
239242
attributes:
240243
- name: description
241244
dtype: text

docs/format/source/format_release_notes.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Minor changes
3232
- Made ``EventDetection.times`` optional and deprecated. Use `source_idx` instead. (#620)
3333
- Clarified documentation of ``PlaneSegmentation`` that at least one of ``image_mask``, ``pixel_mask``,
3434
and ``voxel_mask`` is required. (#636)
35+
- Improved documentation of ``ElectrodeGroup`` to clarify its purpose as a physical grouping of electrodes
36+
that are typically used together for analysis, such as spike sorting. (#631)
37+
- Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``)
38+
should be in microns. (#659)
3539

3640
2.8.0 (November 24, 2024)
3741
-------------------------

0 commit comments

Comments
 (0)