Skip to content

Commit 91e4cb8

Browse files
committed
Fix up units and clarify that we need TODO work on the units/space more
1 parent e970799 commit 91e4cb8

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/schema/objects/columns.yaml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,9 @@ dimension_unit:
248248
name: dimension_unit
249249
display_name: Dimension unit
250250
description: |
251-
Units of the physical dimensions 'width', 'height' and 'depth' of the probe.
252-
For example, `mm`.
251+
Spatial units for a position or a physical dimension of electrodes, such as
252+
'width', 'height' or 'depth' of the probe.
253+
For example, `um`.
253254
type: string
254255
duration:
255256
name: duration
@@ -602,14 +603,14 @@ internal_pipette_diameter:
602603
description: |
603604
The internal diameter of the pipette in micrometers.
604605
type: number
605-
unit: mm
606+
unit: um
606607
external_pipette_diameter:
607608
name: external_pipette_diameter
608609
display_name: External pipette diameter
609610
description: |
610611
The external diameter of the pipette in micrometers.
611612
type: number
612-
unit: mm
613+
unit: um
613614
placement__motion:
614615
name: placement
615616
display_name: Placement
@@ -792,6 +793,7 @@ short_channel:
792793
The total number of channels listed as short channels
793794
SHOULD be stored in `ShortChannelCount` in `*_nirs.json`.
794795
type: boolean
796+
# TODO: might need to dup for microephys__size and have it um^2
795797
size:
796798
name: size
797799
display_name: Electrode size
@@ -1194,12 +1196,16 @@ z__optodes:
11941196
`"n/a"` if not available.
11951197
type: number
11961198
# TODO: Remove the overspecified entries for electrode positions if not used in microephys
1199+
# TODO: finish up setup below
11971200
x__electrodes:
11981201
name: x
11991202
display_name: Electrode X position
12001203
description: |
1201-
Recorded position along the local width-axis relative
1202-
to the probe origin (see `_probes.tsv`)
1204+
If no `_space` entity used, it is the position along the local width-axis relative
1205+
to the probe origin (see `_probes.tsv`, also `dimension_unit` column there in).
1206+
Otherwise, the position relative to the origin of the coordinate system along
1207+
the first axis relative to the in the `MicroephysCoordinateUnits` of the corresponding
1208+
`_coordsystem.json` file.
12031209
type: number
12041210
y__electrodes:
12051211
name: y

0 commit comments

Comments
 (0)