Skip to content

Commit 9e3423c

Browse files
committed
fix(schema): update electrode position descriptions for clarity and consistency with space entities
1 parent b258c64 commit 9e3423c

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

src/schema/objects/columns.yaml

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,25 +1292,40 @@ x__electrodes:
12921292
name: x
12931293
display_name: Electrode X position
12941294
description: |
1295-
If no `_space` entity used, it is the position along the local width-axis relative
1296-
to the probe origin (see `_probes.tsv`, also `dimension_unit` column therein).
1297-
Otherwise, the position relative to the origin of the coordinate system along
1298-
the first axis, in the units specified by `MicroephysCoordinateUnits` in the corresponding
1299-
`_coordsystem.json` file.
1295+
When no [`space-<label>`](SPEC_ROOT/appendices/entities.md#space) entity is used in the filename,
1296+
the position along the local width-axis relative to the probe origin
1297+
(see `coordinate_reference_point` in `*_probes.tsv`).
1298+
Units are specified by the `dimension_unit` column in `*_probes.tsv`.
1299+
1300+
When a `space-<label>` entity is used in the filename,
1301+
the position relative to the origin of the coordinate system along the first axis.
1302+
Units are specified by `MicroephysCoordinateUnits` in the corresponding `*_coordsystem.json` file.
13001303
type: number
13011304
y__electrodes:
13021305
name: y
13031306
display_name: Electrode Y position
13041307
description: |
1305-
Recorded position along the local height-axis relative
1306-
to the probe origin (see `_probes.tsv`)
1308+
When no [`space-<label>`](SPEC_ROOT/appendices/entities.md#space) entity is used in the filename,
1309+
the position along the local height-axis relative to the probe origin
1310+
(see `coordinate_reference_point` in `*_probes.tsv`).
1311+
Units are specified by the `dimension_unit` column in `*_probes.tsv`.
1312+
1313+
When a `space-<label>` entity is used in the filename,
1314+
the position relative to the origin of the coordinate system along the second axis.
1315+
Units are specified by `MicroephysCoordinateUnits` in the corresponding `*_coordsystem.json` file.
13071316
type: number
13081317
z__electrodes:
13091318
name: z
13101319
display_name: Electrode Z position
13111320
description: |
1312-
Recorded position along the local depth-axis relative
1313-
to the probe origin (see `_probes.tsv`).
1321+
When no [`space-<label>`](SPEC_ROOT/appendices/entities.md#space) entity is used in the filename,
1322+
the position along the local depth-axis relative to the probe origin
1323+
(see `coordinate_reference_point` in `*_probes.tsv`).
1324+
Units are specified by the `dimension_unit` column in `*_probes.tsv`.
1325+
1326+
When a `space-<label>` entity is used in the filename,
1327+
the position relative to the origin of the coordinate system along the third axis.
1328+
Units are specified by `MicroephysCoordinateUnits` in the corresponding `*_coordsystem.json` file.
13141329
13151330
For 2D electrode localizations (for example, when the coordinate system is
13161331
`Pixels`), this SHOULD be a column of `n/a` values.

0 commit comments

Comments
 (0)