Skip to content

Commit 6c9677b

Browse files
committed
[ENH] Clarify definition of space entity
1 parent 0fdcbd8 commit 6c9677b

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

src/schema/objects/entities.yaml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -324,17 +324,20 @@ space:
324324
name: space
325325
display_name: Space
326326
description: |
327-
The `space-<label>` entity can be used to indicate the way in which electrode positions are interpreted
328-
(for EEG/MEG/iEEG data)
329-
or the spatial reference to which a file has been aligned (for MRI data).
330-
The `<label>` MUST be taken from one of the modality specific lists in the
331-
[Coordinate Systems Appendix](SPEC_ROOT/appendices/coordinate-systems.md).
332-
For example, for iEEG data, the restricted keywords listed under
333-
[iEEG Specific Coordinate Systems](SPEC_ROOT/appendices/coordinate-systems.md#ieeg-specific-coordinate-systems)
334-
are acceptable for `<label>`.
335-
336-
For EEG/MEG/iEEG data, this entity can be applied to raw data,
337-
but for other data types, it is restricted to derivative data.
327+
The `space-<label>` entity indicates the coordinate system for interpreting
328+
spatial coordinates.
329+
For sensor-based modalities, such as EEG/MEG/iEEG,
330+
the space indicates how sensor positions are reported;
331+
for imaging modalities,
332+
the space indicates a reference image to which a file has been aligned.
333+
A list of common spaces is defined in the
334+
[Coordinate Systems Appendix](SPEC_ROOT/appendices/coordinate-systems.md),
335+
and these SHOULD be used as `<label>` values for data reported in those
336+
spaces.
337+
338+
Note that the space entity is broadly applicable to derivative data,
339+
but is only defined for a subset of raw data types.
340+
For particular use cases, `<label>` may be restricted to a set of enumerated values.
338341
type: string
339342
format: label
340343
split:

0 commit comments

Comments
 (0)