Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions src/appendices/coordinate-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,60 @@ Please note that `space-scanner` SHOULD NOT be used, it is mentioned in this spe
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| scanner | The intrinsic coordinate system of the original image (the first entry of `RawSources`) after reconstruction and conversion to NIfTI or equivalent for the case of surfaces and dual volume/surface files. |

## Microelectrode Electrophysiology Specific Coordinate Systems

Restricted keywords for the `MicroephysCoordinateSystem` field in the
`coordsystem.json` file for microelectrode electrophysiology datasets (both `icephys` and `ecephys`):

- `Pixels`: If electrodes are localized in 2D space (only x and y are
specified and z is n/a), then the positions in this file must correspond to
the locations expressed in pixels on the photo/drawing/rendering of the
electrodes on the brain. In this case, coordinates must be (row,column)
pairs, with (0,0) corresponding to the upper left pixel and (N,0)
corresponding to the lower left pixel.

- `AllenCCFv3`: Allen Common Coordinate Framework version 3 (RRID:SCR_020999), a 3D reference space for
the mouse brain based on average anatomy. The framework provides a systematic way to
map and compare data across different experiments and labs. Origin and orientation
follow the Allen Institute conventions. For more information, see
[http://help.brain-map.org/](http://help.brain-map.org/).
Reference: Wang Q, Ding SL, Li Y, Royall J, Feng D, Lesnar P, Graddis N, Naeemi M, Facer B,
Ho A, Dolbeare T, Blanchard B, Dee N, Wakeman W, Hirokawa KE, Szafer A, Sunkin SM, Oh SW,
Bernard A, Phillips JW, Hawrylycz M, Koch C, Zeng H, Harris JA, Ng L. The Allen Mouse Brain
Common Coordinate Framework: A 3D Reference Atlas. Cell. 2020 May 14;181(4):936-953.e20.
[doi:10.1016/j.cell.2020.04.007](https://doi.org/10.1016/j.cell.2020.04.007).

- `WaxholmSpace`: A standardized 3D coordinate system for the rat brain (RRID:SCR_001592) based on
high-resolution imaging data. Part of the Waxholm Space atlas of the Sprague Dawley
rat brain. For more information, see
[https://www.nitrc.org/projects/whs-sd-atlas](https://www.nitrc.org/projects/whs-sd-atlas).
Reference: Hawrylycz M, Baldock RA, Burger A, Hashikawa T, Johnson GA, Martone M, Ng L,
Lau C, Larson SD, Nissanov J, Puelles L, Ruffins S, Verbeek F, Zaslavsky I, Boline J.
Digital atlasing and standardization in the mouse brain. PLoS Comput Biol. 2011 Feb 3;7(2):e1001065.
[doi:10.1371/journal.pcbi.1001065](https://doi.org/10.1371/journal.pcbi.1001065).

- `WistarRatAtlas`: A multidimensional magnetic resonance histology atlas of the adult Wistar rat brain
(RRID:SCR_006288). This atlas provides high-resolution anatomical reference for rat brain studies.
Reference: Johnson GA, Calabrese E, Badea A, Paxinos G, Watson C. A multidimensional magnetic resonance
histology atlas of the Wistar rat brain. Neuroimage. 2012 Sep;62(3):1848-56.
[doi:10.1016/j.neuroimage.2012.05.041](https://doi.org/10.1016/j.neuroimage.2012.05.041).

- `individual`: Subject-specific anatomical coordinate system derived from the
individual subject's anatomy. The origin and orientation should be specified in
`MicroephysCoordinateSystemDescription`. This coordinate system requires specifying
an additional, subject-specific file to be fully defined.

- `Other`: Use this for other coordinate systems and specify all required details in
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be consistent with the inconsistent individual and study (in other modalities)

Suggested change
- `Other`: Use this for other coordinate systems and specify all required details in
- `other`: Use this for other coordinate systems and specify all required details in

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but in general it seems we might better just kick it out for now since as you @bendichter mentioned -- other modalities do not support that ATM, and aim for 80/20

the `MicroephysCoordinateSystemDescription` field.

If you believe a specific coordinate system should be added to the list
of restricted keywords for microelectrode electrophysiology, please open a new issue on the
[bids-standard/bids-specification GitHub repository](https://github.com/bids-standard/bids-specification/issues/new/choose).

For detailed information about coordinate systems in microelectrode electrophysiology,
including probe angles and anatomical reference points, see the
[Microelectrode Electrophysiology specification](../modality-specific-files/microelectrode-electrophysiology.md#coordinate-systems-for-electrode-positions).

<!-- Link Definitions -->

[common file level metadata fields]: ../derivatives/common-data-types.md#common-file-level-metadata-fields
Expand Down
11 changes: 6 additions & 5 deletions src/modality-specific-files/microelectrode-electrophysiology.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ When electrode positions are known in anatomical or stereotaxic space:

- `*_space-<label>_electrodes.tsv`: Electrode positions in the specified coordinate system
- `*_space-<label>_coordsystem.json`: **REQUIRED** to define the coordinate system
- Examples of `<label>` values include `StereoTaxic`, `AllenCCFv3`, `PaxinosWatson`, `individual`, or other standard spaces listed in the [Coordinate Systems Appendix](../appendices/coordinate-systems.md)
- Examples of `<label>` values include `AllenCCFv3`, `WaxholmSpace`, `WistarRatAtlas`, `individual`, or other standard spaces listed in the [Coordinate Systems Appendix](../appendices/coordinate-systems.md#microelectrode-electrophysiology-specific-coordinate-systems)

Multiple coordinate systems can coexist in the same dataset.

Expand Down Expand Up @@ -596,11 +596,12 @@ between `*_electrodes.tsv` and `*_coordsystem.json` if they refer to the same
data.

For examples:
- `*_space-StereoTaxic` (electrodes are localized in stereotactic coordinate system with bregma origin)
<!-- TODO: Add 'StereoTaxic', 'AllenCCFv3', 'PaxinosWatson', etc coordinate systems to appendix coordinate-systems.md under "Microelectrode Electrophysiology Specific Coordinate Systems" with appropriate definitions for each standard reference frame used in animal electrophysiology -->
- `*_space-individual` (electrodes are localized in subject-specific anatomical coordinate system)
- `*_space-AllenCCFv3` (electrodes are mapped to Allen Common Coordinate Framework v3)
- `*_space-PaxinosWatson` (electrodes are mapped to Paxinos-Watson rat brain atlas coordinates)
- `*_space-WaxholmSpace` (electrodes are mapped to Waxholm Space rat brain atlas)
- `*_space-WistarRatAtlas` (electrodes are mapped to Wistar rat brain atlas)
- `*_space-individual` (electrodes are localized in subject-specific anatomical coordinate system)

For a complete list of available coordinate systems, see the [Microelectrode Electrophysiology Specific Coordinate Systems](../appendices/coordinate-systems.md#microelectrode-electrophysiology-specific-coordinate-systems) section in the appendix.

When referring to the `*_electrodes.tsv` file in a certain *space* as defined
above, the [`space-<label>`](../appendices/entities.md#space) of the accompanying `*_coordsystem.json` MUST
Expand Down
Loading