From 651683c089cb07f957c5e1f94040296d3ec0c530 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Wed, 1 Jul 2020 13:11:00 +0200 Subject: [PATCH 1/3] clarify XXXCoord* --- src/99-appendices/08-coordinate-systems.md | 48 +++++++++++++--------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/src/99-appendices/08-coordinate-systems.md b/src/99-appendices/08-coordinate-systems.md index c9c8669dba..c2b59c69c6 100644 --- a/src/99-appendices/08-coordinate-systems.md +++ b/src/99-appendices/08-coordinate-systems.md @@ -2,10 +2,10 @@ ## Introduction -To interpret a coordinate (x, y, z), it is required that you know relative to -which origin the coordinates are expressed, you have to know the interpretation -of the three axes, and you have to know the units in which the numbers are -expressed. This information is sometimes called the coordinate system. +To interpret a coordinate (x, y, z), it is required that you know (1) relative +to which origin the coordinate is expressed, (2) the interpretation of the +three axes, and (3) the units in which the numbers are expressed. +This information is sometimes called the coordinate system. These letters help describe the coordinate system definition: @@ -17,11 +17,13 @@ For example: `RAS` means that the first dimension (X) points towards the right hand side of the head, the second dimension (Y) points towards the Anterior aspect of the head, and the third dimension (Z) points towards the top of the head. +The directions are following the *neurological convention*, so the subject's +left side of the head is also on the left side of the image. Besides coordinate systems, defined by their origin and direction of the axes, BIDS defines "spaces" as an artificial frame of reference, created to describe different anatomies in a unifying manner (see e.g., -[https://doi.org/10.1016/j.neuroimage.2012.01.024](https://www.sciencedirect.com/science/article/pii/S1053811912000419?via%3Dihub)). +[https://doi.org/10.1016/j.neuroimage.2012.01.024](https://doi.org/10.1016/j.neuroimage.2012.01.024)). The "space" and all coordinates expressed in this space are by design a transformation of the real world geometry, and nearly always different from the individual subject space that it stems from. An example is the @@ -42,20 +44,28 @@ different conventions used in specific software packages developed by different ## Coordinate Systems applicable to MEG, EEG, and iEEG Generally, across the MEG, EEG, and iEEG modalities, the first two pieces of -information (origin, orientation) are specified in `XXXCoordinateSystem`, and -the units are specified in `XXXCoordinateSystemUnits`. +information for a coordinate system (origin and orientation) are specified in +`CoordinateSystem`. The third piece of information for a coordinate +system (units) are specified in `CoordinateSystemUnits`. +Here, `` can be one of `MEG`, `EEG`, or `iEEG`, depending on the +modality that is being used. -Allowed values for the `XXXCoordinateSystem` field come from a list of -restricted keywords, as listed in the sections below. If no value from the list -of restricted keywords fits, there is always the option to specify the value as -follows: +Allowed values for the `CoordinateSystem` field come from a list of +restricted keywords, as listed in the sections below. +If no value from the list of restricted keywords fits, there is always the +option to specify the value as follows: -- `Other`: Use this for other coordinate systems and specify further details - in the `XXXCoordinateSystemDescription` field +- `Other`: Use this for other coordinate systems and specify further details + in the `CoordinateSystemDescription` field + +**If you feel like a specific coordinate system should be added to the list +of restricted keywords for either MEG, EEG, or iEEG, please open a new issue +on the +[bids-standard/bids-specification GitHub repository](https://github.com/bids-standard/bids-specification/issues/new/choose).** ## MEG Specific Coordinate Systems -Restricted keywords for the `XXXCoordinateSystem` field in the +Restricted keywords for the `CoordinateSystem` field in the `coordinatesystem.json` file for MEG datasets: - `CTF`: ALS orientation and the origin between the ears @@ -70,7 +80,7 @@ detailed extensive descriptions of these EEG coordinate systems on the ## EEG Specific Coordinate Systems -Restricted keywords for the `XXXCoordinateSystem` field in the +Restricted keywords for the `CoordinateSystem` field in the `coordsystem.json` file for EEG datasets: - `Captrak`: RAS orientation and the origin between the ears @@ -81,7 +91,7 @@ detailed extensive descriptions of these EEG coordinate systems on the ## iEEG Specific Coordinate Systems -Restricted keywords for the `XXXCoordinateSystem` field in the +Restricted keywords for the `CoordinateSystem` field in the `coordsystem.json` file for iEEG datasets: - `Pixels`: If electrodes are localized in 2D space (only x and y are @@ -103,11 +113,11 @@ Restricted keywords for the `XXXCoordinateSystem` field in the ## Image-based Coordinate Systems The transformation of the real world geometry to an artificial frame of -reference is described in `XXXCoordinateSystem`. +reference is described in `CoordinateSystem`. Unless otherwise specified below, the origin is at the AC and the orientation of the axes is RAS. -Unless specified explicitly in the sidecar file in the `XXXCoordinateSystemUnits` field, -the units are assumed to be mm. +Unless specified explicitly in the sidecar file in the +`CoordinateSystemUnits` field, the units are assumed to be mm. ### Standard template identifiers From bb71c41d48a758aba0e3df46ef4669a411ae71ad Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Wed, 1 Jul 2020 17:53:55 +0200 Subject: [PATCH 2/3] fix capitalization of Captrak -> CapTrak --- src/99-appendices/08-coordinate-systems.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/99-appendices/08-coordinate-systems.md b/src/99-appendices/08-coordinate-systems.md index c2b59c69c6..580d44bb7f 100644 --- a/src/99-appendices/08-coordinate-systems.md +++ b/src/99-appendices/08-coordinate-systems.md @@ -83,7 +83,7 @@ detailed extensive descriptions of these EEG coordinate systems on the Restricted keywords for the `CoordinateSystem` field in the `coordsystem.json` file for EEG datasets: -- `Captrak`: RAS orientation and the origin between the ears +- `CapTrak`: RAS orientation and the origin between the ears Note that the short descriptions above do not capture all details, There are detailed extensive descriptions of these EEG coordinate systems on the From 98b49bbd4ad56c522c304908e4677d23a9fd3b17 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 10 Aug 2020 21:01:48 +0200 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Chris Markiewicz --- src/99-appendices/08-coordinate-systems.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/99-appendices/08-coordinate-systems.md b/src/99-appendices/08-coordinate-systems.md index 580d44bb7f..2697ba1be4 100644 --- a/src/99-appendices/08-coordinate-systems.md +++ b/src/99-appendices/08-coordinate-systems.md @@ -17,8 +17,9 @@ For example: `RAS` means that the first dimension (X) points towards the right hand side of the head, the second dimension (Y) points towards the Anterior aspect of the head, and the third dimension (Z) points towards the top of the head. -The directions are following the *neurological convention*, so the subject's -left side of the head is also on the left side of the image. +The directions are considered to be from the subject's perspective. +For example, in the `RAS` coordinate system, a point to the subject's left +will have a negative `x` value. Besides coordinate systems, defined by their origin and direction of the axes, BIDS defines "spaces" as an artificial frame of reference, created to describe @@ -45,8 +46,9 @@ different conventions used in specific software packages developed by different Generally, across the MEG, EEG, and iEEG modalities, the first two pieces of information for a coordinate system (origin and orientation) are specified in -`CoordinateSystem`. The third piece of information for a coordinate -system (units) are specified in `CoordinateSystemUnits`. +`CoordinateSystem`. +The third piece of information for a coordinate system (units) are specified in +`CoordinateSystemUnits`. Here, `` can be one of `MEG`, `EEG`, or `iEEG`, depending on the modality that is being used. @@ -58,9 +60,8 @@ option to specify the value as follows: - `Other`: Use this for other coordinate systems and specify further details in the `CoordinateSystemDescription` field -**If you feel like a specific coordinate system should be added to the list -of restricted keywords for either MEG, EEG, or iEEG, please open a new issue -on the +**If you believe a specific coordinate system should be added to the list +of restricted keywords for MEG, EEG, or iEEG, please open a new issue on the [bids-standard/bids-specification GitHub repository](https://github.com/bids-standard/bids-specification/issues/new/choose).** ## MEG Specific Coordinate Systems