Add micrometer units clarification to electrode table's localization coordinates (#658)

Co-authored-by: Ryan Ly <[email protected]>

Author: h-mayorquin

core/nwb.ecephys.yaml

@@ -291,17 +291,17 @@ groups:
   - name: x
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: x coordinate of the channel location in the brain (+x is posterior).
+    doc: x coordinate of the channel location in the brain (+x is posterior). Units should be specified in microns.
     quantity: '?'
   - name: y
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: y coordinate of the channel location in the brain (+y is inferior).
+    doc: y coordinate of the channel location in the brain (+y is inferior). Units should be specified in microns.
     quantity: '?'
   - name: z
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: z coordinate of the channel location in the brain (+z is right).
+    doc: z coordinate of the channel location in the brain (+z is right). Units should be specified in microns.
     quantity: '?'
   - name: imp
     neurodata_type_inc: VectorData
@@ -316,17 +316,17 @@ groups:
   - name: rel_x
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: x coordinate in electrode group
+    doc: x coordinate in electrode group. Units should be specified in microns.
     quantity: '?'
   - name: rel_y
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: y coordinate in electrode group
+    doc: y coordinate in electrode group. Units should be specified in microns.
     quantity: '?'
   - name: rel_z
     neurodata_type_inc: VectorData
     dtype: float32
-    doc: z coordinate in electrode group
+    doc: z coordinate in electrode group. Units should be specified in microns.
     quantity: '?'
   - name: reference
     neurodata_type_inc: VectorData

docs/format/source/format_release_notes.rst

@@ -10,6 +10,8 @@ Minor changes
 ^^^^^^^^^^^^^
 - Improved documentation of ``ElectrodeGroup`` to clarify its purpose as a physical grouping of electrodes
   that are typically used together for analysis, such as spike sorting. (#659)
+- Specified that units for ``ElectrodesTable`` coordinate fields (``x``, ``y``, ``z``, ``rel_x``, ``rel_y``, ``rel_z``)
+  should be in microns. (#658)
 
 
 2.9.0 (June 26, 2025)