Skip to content
Closed
Show file tree
Hide file tree
Changes from 209 commits
Commits
Show all changes
237 commits
Select commit Hold shift + click to select a range
7ec5d5e
Add first BEP032 objects
JuliaSprenger Nov 9, 2022
2f393ca
Add ephys modality, start adding _channels but ran into a question on…
yarikoptic Feb 14, 2024
648781a
Add _acq- to ephys, add _channels and _coords
yarikoptic Mar 6, 2024
d3c9996
Draft for probes TSV file
TheChymera Mar 6, 2024
08c92cd
Fix preferably typo
yarikoptic Mar 15, 2024
e2030ac
Comment out not yet defined iephys and add ephys to datatypes where i…
TheChymera Apr 17, 2024
53f1087
Added probes file
TheChymera Apr 17, 2024
fa648fe
Describe modality/datatype as "Microelectrode Electrophysiology"
yarikoptic Apr 18, 2024
eef67df
Remove iephys entirely since I think it was just inspired by DANDI la…
yarikoptic Apr 18, 2024
27547f9
Initial content for ephys document and initial filename template tree
yarikoptic Apr 18, 2024
a6ae5e2
Merge remote-tracking branch 'upstream/master' into bep032
Remi-Gau Apr 19, 2024
9a20e4b
pacify pre-commit
Remi-Gau Apr 19, 2024
7609276
add to TOC
Remi-Gau Apr 19, 2024
9be41f9
semantic line break and fix
Remi-Gau Apr 19, 2024
983975a
Addressed minor left over lint complains
yarikoptic Apr 19, 2024
1afdc40
Add "Microelectrode" specialization for Electrophysiology in the cont…
yarikoptic Apr 19, 2024
6b39d64
Fix up for bad latin and adjust wording a bit
yarikoptic Apr 19, 2024
f08b163
Replace fancy unicode “ with simple " .
yarikoptic Apr 19, 2024
73012b3
Use redirected to www.datalad.org and www.nwb.org website URLs and fe…
yarikoptic Apr 19, 2024
a46e439
BEP032: ephys -> microephys with {icephys, ecephys} modalities/suffix…
yarikoptic Jun 5, 2024
05e9611
Clarify wording and do mention `microephys` as shorthand for Microele…
yarikoptic Oct 16, 2024
7ddeb75
Adding markdown portion of the Bep032 (#1960)
Peyman-N Nov 20, 2024
2b9e757
[ENH] Schema changes related to BEP032 (#1826)
ree-gupta Nov 20, 2024
6b11f54
Merge remote-tracking branch 'origin/master' into bep032
yarikoptic Nov 20, 2024
1abebea
Some fixes of formatting and URLs
yarikoptic Dec 17, 2024
2a3757d
Merge remote-tracking branch 'origin/master' into bep032
yarikoptic Dec 18, 2024
3f4e941
Adjusted some formatting and some wording at the beginning of the sec…
yarikoptic Dec 18, 2024
0853f8a
Few fixes to the schema from review
yarikoptic Dec 18, 2024
800ba58
Adopting the markdown line lengths for BEP032 (#2012)
Peyman-N Dec 18, 2024
46c91b0
Fix tabulation in a .tsv + convert to use yaw, pitch, roll
yarikoptic Dec 18, 2024
a884604
Add types and min/max for roll,pitch,yaw + fix typo for microephysCha…
yarikoptic Dec 19, 2024
262d5b1
Replace Pharmaceuticals with already existing fields and fix few more…
yarikoptic Dec 19, 2024
756c07c
Merge remote-tracking branch 'origin/master' into bep032
yarikoptic Dec 19, 2024
7bc17cc
Make use of merged fancing for tsvs and add a note about spotted Phar…
yarikoptic Dec 19, 2024
d5fef1f
Remove some "bad latin"
yarikoptic Dec 19, 2024
039fbb3
Fix a link to be final, before redirects
yarikoptic Dec 19, 2024
8e65a63
using MACROS___make_sidecar_table
Peyman-N Jan 17, 2025
2e3be31
numbering
Peyman-N Jan 17, 2025
1762f6f
Adding icephys and ecephys to filename template
Peyman-N Jan 22, 2025
1229a4a
Merge pull request #2034 from Peyman-N/bep032-peyman
yarikoptic Jan 22, 2025
04c1b93
[ENH] Added microephys tag to electrode related enums
ree-gupta Jan 28, 2025
1fd8139
[ENH] Added additional channel enums for microphys
ree-gupta Jan 28, 2025
94de4e5
[ENH] Enlisted microphys channel types in type__channels
ree-gupta Jan 28, 2025
5bc95b0
Merge pull request #2038 from ree-gupta/bep032
yarikoptic Feb 5, 2025
b171eee
Various small fixes from code-review
yarikoptic Feb 6, 2025
73083d8
[BEP032] Moved coord system related entities to correct yaml
ree-gupta Feb 19, 2025
50a38db
Minor tuneups from code review (mostly on wording)
yarikoptic Feb 19, 2025
73976f1
A pass to harmonize to use "microephys" in favor over "ephys"
yarikoptic Feb 19, 2025
387b924
Encode in schema that ATM we do require _electodes and _probes
yarikoptic Feb 19, 2025
d791dc5
One more ephys -> microephys
yarikoptic Feb 19, 2025
41dfec7
Add .json to data (nwb and nix) and _probes files
yarikoptic Feb 19, 2025
cf7e0c6
Merge remote-tracking branch 'origin/master' into bep032
yarikoptic Mar 19, 2025
1242dcd
[DATALAD RUNCMD] replace fancy unicode double quote with a simpler one
yarikoptic Mar 19, 2025
6360b9e
Address many remark lint issues using
yarikoptic Mar 19, 2025
187e6a0
One more tune up
yarikoptic Mar 19, 2025
7b00a28
items
yarikoptic Mar 19, 2025
7954586
[DATALAD RUNCMD] Fix up itemized things indentation
yarikoptic Mar 19, 2025
8ad8a97
Address leftover of remark lint warnings
yarikoptic Mar 19, 2025
4a2a4b4
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Apr 16, 2025
3467824
Remove custom paragraph on participants, replaced angles with yaw, pi…
yarikoptic Apr 16, 2025
fae456f
Merge branch 'master' into bep032
bendichter May 21, 2025
54f8180
Merge branch 'master' into bep032
CodyCBakerPhD Jun 5, 2025
05fcf7d
Merge branch 'master' into bep032
CodyCBakerPhD Jun 12, 2025
fafe10d
[FIX] BEP032 - Correcting validations against real data example (#2132)
CodyCBakerPhD Jun 17, 2025
19845a7
Merge branch 'master' into bep032
CodyCBakerPhD Jun 18, 2025
660317c
Merge branch 'master' into bep032
CodyCBakerPhD Jul 2, 2025
6201738
fix: validation rules for events
CodyCBakerPhD Jul 2, 2025
75787ed
doc: Reorder required metadata files for microephys sessions and clar…
bendichter Jul 2, 2025
d71247c
remove unneeded fields
CodyCBakerPhD Jul 2, 2025
49138dc
move to task.yaml with __
CodyCBakerPhD Jul 2, 2025
2cea859
remove from microephys
CodyCBakerPhD Jul 2, 2025
53ad87b
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jul 3, 2025
9ca3066
Merge pull request #2153 from bids-standard/bens-reorg
bendichter Jul 3, 2025
937f9f5
Merge branch 'bep032' into fix_rules_bep032
CodyCBakerPhD Jul 11, 2025
62994c7
Merge pull request #2152 from bids-standard/fix_rules_bep032
CodyCBakerPhD Jul 11, 2025
3307e6c
chore: linting
CodyCBakerPhD Jul 30, 2025
28a6199
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Jul 30, 2025
afbdaed
Merge branch 'master' into bep032
bendichter Aug 3, 2025
477719c
Add comprehensive stereotaxic coordinate documentation with visual gu…
bendichter Aug 3, 2025
d3c3d24
Merge branch 'bep032' into bep32_rotation
bendichter Aug 3, 2025
530b22f
Add probe position columns for AP and ML axes and standardize units
bendichter Aug 3, 2025
65ff204
Merge branch 'bep32_rotation' of https://github.com/bids-standard/bid…
bendichter Aug 3, 2025
6f533a6
Update microelectrode electrophysiology documentation
bendichter Aug 3, 2025
b59f0b2
Merge branch 'bep032' into bep32_rotation
bendichter Aug 3, 2025
18ad16b
Merge pull request #2160 from bids-standard/bep32_rotation
bendichter Aug 4, 2025
526c6c6
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Aug 6, 2025
18ce69f
Updated probe tabular rule to match AP, ML, DV
ree-gupta Aug 6, 2025
d4190e6
Removed coordystem completely
ree-gupta Aug 6, 2025
4e44e0a
Removes coordsys macro to fix failing mkdocs build
ree-gupta Aug 6, 2025
c5e2183
change the electrode positions back from AP/ML/DV to x,y,z
bendichter Aug 6, 2025
c921f9b
Update _probes.tsv example with standardized coordinate system and Pr…
bendichter Aug 6, 2025
1dff1da
Merge pull request #2058 from ree-gupta/bep032
ree-gupta Aug 7, 2025
c342954
Merge branch 'master' into bep032
CodyCBakerPhD Aug 13, 2025
ef188c8
Update microephys entity rules and remove task/run requirements
ree-gupta Sep 3, 2025
7f7bac3
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Sep 3, 2025
8485367
Fix linter issues
ree-gupta Sep 3, 2025
068fdc0
Reorganized to match other modalities
ree-gupta Sep 3, 2025
24223af
Merge pull request #2194 from ree-gupta/bep032
ree-gupta Sep 3, 2025
d05b4a6
Clarify DV axis description in microelectrode electrophysiology docum…
bendichter Sep 3, 2025
80e9119
Update src/modality-specific-files/microelectrode-electrophysiology.md
effigies Sep 3, 2025
649a2ce
Adds space entity for microephys electrodes
ree-gupta Sep 4, 2025
b84bd49
Add coordinate system metadata fields for microephys
ree-gupta Sep 4, 2025
cfd64cc
Added rules to 1) override rule for coorsystem to be present for elec…
ree-gupta Sep 4, 2025
198e365
Added entities for the photo specific to microephys
ree-gupta Sep 4, 2025
cf3e7a9
Rewrote the coordsystem JSON and photo section to align with ieeg but…
ree-gupta Sep 4, 2025
2f3069f
Minor change to the default probe relative coordinate system
ree-gupta Sep 4, 2025
4395dcf
Probe interface exaple file tree
ree-gupta Sep 4, 2025
e295e74
Resolve merge conflict due to reorganization of events from task.yaml…
ree-gupta Sep 4, 2025
f3640c0
Merge branch 'master' into bep032
CodyCBakerPhD Sep 17, 2025
dada00c
Merge pull request #2198 from ree-gupta/bep032
ree-gupta Sep 17, 2025
c272e01
Merge branch 'master' into bep032
CodyCBakerPhD Sep 19, 2025
c31f579
Add omission of microephys datatypes for overall channel file rule
ree-gupta Oct 1, 2025
d7437f5
Merge branch 'master' into bep032
bendichter Oct 1, 2025
101c01a
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Oct 1, 2025
55401ec
Merge branch 'bep032' into bep032
ree-gupta Oct 1, 2025
84f44f1
Merge pull request #2224 from ree-gupta/bep032
ree-gupta Oct 1, 2025
54a44d4
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Oct 1, 2025
6a9cf98
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Oct 1, 2025
47cca5f
Fix indentation for note and example alerts
yarikoptic Oct 1, 2025
e049ef9
Merge branch 'master' into bep032
bendichter Oct 7, 2025
59e1267
[MISC] Use Levels and custom json for probe interface files
bendichter Oct 7, 2025
94b09d8
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Oct 7, 2025
45a06b7
Update src/schema/objects/columns.yaml
bendichter Oct 7, 2025
89fa748
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Oct 7, 2025
551f5de
[MISC] Replace image syntax with HTML for anatomical reference diagrams
bendichter Oct 7, 2025
40e7a5d
Merge branch 'bep032' of https://github.com/bids-standard/bids-specif…
bendichter Oct 7, 2025
cc7fe98
Fix formatting in example *_electrodes.tsv for improved readability
bendichter Oct 7, 2025
ad41192
Apply suggestion from @bendichter
bendichter Oct 7, 2025
da05a28
Remove channel_id def and use name__channels same as ieeg
ree-gupta Oct 14, 2025
d9266b7
Update microephys electrode.tsv to match ieeg
ree-gupta Oct 14, 2025
4fc8ec8
Changed probe_id to probe_name to avoid use of the concept ID against…
ree-gupta Oct 14, 2025
8a933ec
Merge branch 'bids-standard:bep032' into bep032
ree-gupta Oct 14, 2025
79f1059
Add missing probe_height def and rewrite desc to match current markdown
ree-gupta Oct 14, 2025
40993d2
Fixed minor typo failing schema validation
ree-gupta Oct 14, 2025
41b301d
Fix remark linting issues
ree-gupta Oct 14, 2025
4c95199
Added and modified texts for coordsystem requirements
ree-gupta Oct 14, 2025
05d19bf
Added icephys and ecephys distinction and restructured first section …
ree-gupta Oct 14, 2025
a127f57
Fixed initial_column to match AP, ML, DV
ree-gupta Oct 14, 2025
4c776e5
Update mock TSV and JSON and fix heading levels to match ieeg
ree-gupta Oct 14, 2025
d428dc8
Updated toy data section and links to example to match current spec
ree-gupta Oct 14, 2025
73d3975
Minor formatting and style issues
ree-gupta Oct 14, 2025
7fb3a28
Fix mock data tsv and JSON
ree-gupta Oct 15, 2025
8b39a2d
Merge branch 'master' into bep032
CodyCBakerPhD Oct 15, 2025
1cfa706
Apply various wording suggestions from code review
yarikoptic Oct 17, 2025
ae05b3b
Apply suggestion from @yarikoptic
bendichter Oct 26, 2025
d1835cf
Apply suggestion from @bendichter
bendichter Oct 26, 2025
76ef60a
add back type info that was accidentally removed from whole_blood_rad…
bendichter Oct 26, 2025
8368d47
Update link to iEEG stimulation documentation for clarity
bendichter Oct 26, 2025
401ee96
Merge branch 'master' into bep032
bendichter Nov 5, 2025
df637a4
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Nov 5, 2025
e970799
feat: add anatomical reference point to microelectrode electrophysiol…
bendichter Nov 5, 2025
91e4cb8
Fix up units and clarify that we need TODO work on the units/space more
yarikoptic Nov 5, 2025
e14db80
Fix typo Update src/schema/objects/suffixes.yaml
christinerogers Nov 21, 2025
cd7e17e
Merge branch 'master' into bep032
bendichter Dec 3, 2025
624ea76
rf: move "ProbeInterface Library" subsection down after probes.tsv
yarikoptic Dec 3, 2025
6499d0c
Revert "Apply suggestion from @bendichter" to bring back width__probes
yarikoptic Dec 3, 2025
cd7045e
docs: consolidate electrode coordinate system documentation
bendichter Dec 8, 2025
00aa234
docs(appendices): add microelectrode surgical coordinates appendix
bendichter Dec 8, 2025
33faf8f
Add probes related schema changes
ree-gupta Dec 8, 2025
97b616e
Merge branch 'master' into bep032
ree-gupta Dec 8, 2025
6284d36
docs: add microelectrode electrophysiology coordinate systems
bendichter Dec 8, 2025
724e4a2
Merge branch 'bep032' into bep032-coord-enum
bendichter Dec 8, 2025
803cf2c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 8, 2025
a92aad0
docs: convert RRID identifiers to hyperlinks in coordinate-systems
bendichter Dec 8, 2025
0957556
Merge pull request #2276 from bids-standard/bep032-coord-enum
ree-gupta Dec 8, 2025
36ab944
docs(ephys): add stream_id column documentation for channels.tsv
bendichter Dec 8, 2025
d12bfc1
docs(ephys): clarify electrode name uniqueness requirement
bendichter Dec 8, 2025
d6227c6
Merge pull request #2277 from bids-standard/bep032-stream_id
bendichter Dec 8, 2025
c162e31
Changed hemisphere cardinality from required to recommended
ree-gupta Dec 10, 2025
10886f9
Merge branch 'master' into bep032
bendichter Dec 10, 2025
544307b
fix: correct typo in description for reference__microephys
bendichter Dec 10, 2025
ef8a24e
fix: clarify electrode position coordinates for single electrode cases
bendichter Dec 10, 2025
70ccf9b
Merge branch 'bep032' into bpe032-electrode-name-uniqueness
bendichter Dec 10, 2025
63d7b89
fix: fix the name of matrial: material_probes -> material
bendichter Dec 15, 2025
cff172a
fix: remove unnecessary brackets in coordsystem selectors
bendichter Dec 15, 2025
0a5a656
fix: change tables from pipe syntax to html syntax. This removes lint…
bendichter Dec 15, 2025
0b6489c
Fix yamllint and codespell issues
ree-gupta Dec 17, 2025
b4ce1a1
feat(microephys): add channel-level filtering columns and documentation
bendichter Dec 26, 2025
777f533
fix: add missing closing brace in JSON example for task description
bendichter Dec 26, 2025
5af6791
fix: update description of MicroephysCoordinateSystem axes and link t…
bendichter Dec 26, 2025
1c3a26f
feat(schema): add model column for probes and fix electrode descriptions
bendichter Dec 26, 2025
35a64f1
fix: update description for IntendedFor field in microephysCoordsyste…
bendichter Dec 26, 2025
61a3372
fix: correct name and type for associated_brain_region_id field in co…
bendichter Dec 26, 2025
d1a010b
fix: remove deprecated hardware_filters and software_filters columns …
bendichter Dec 26, 2025
29bde4e
feat: add micrometer (um) as a valid unit for MicroephysCoordinateUnits
bendichter Dec 26, 2025
a597f3a
fix(schema): correct stereotaxic coordinate system axis definitions
bendichter Dec 26, 2025
a557abb
feat(microephys): add recording metadata fields to setup schema
bendichter Dec 26, 2025
605e2f5
docs(ephys): correct JSON metadata filename convention
bendichter Dec 26, 2025
b258c64
fix: correct pluralization in TODO comment for PharmaceuticalDoseUnits
bendichter Dec 26, 2025
9e3423c
fix(schema): update electrode position descriptions for clarity and c…
bendichter Dec 26, 2025
2c1e9c5
fix(schema): rename x/y/z columns to x/y/z__electrodes in microephys
bendichter Dec 26, 2025
eb5cd05
docs(ephys): update coordinate system names and fix Stereotaxic spelling
bendichter Dec 26, 2025
d7f09d7
feat(microephys): add brain atlas coordinate systems for rodents and …
bendichter Dec 26, 2025
50b0e73
Merge branch 'master' into bep032
bendichter Jan 4, 2026
e70421a
fix(linter): fix yamllint and remark errors
ree-gupta Jan 4, 2026
78719a5
fix(schema): remove unused column defintions
ree-gupta Jan 4, 2026
e88c744
Reverted commit and readded the removed type column for software_filters
ree-gupta Jan 4, 2026
f8217b0
fix: reconciling software_filter defintion with master
ree-gupta Jan 4, 2026
10893e8
Update src/schema/objects/metadata.yaml
bendichter Jan 4, 2026
6342c72
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 4, 2026
bc2d1dd
Merge branch 'bep032' into bpe032-electrode-name-uniqueness
bendichter Jan 4, 2026
fa07b77
Merge pull request #2278 from bids-standard/bpe032-electrode-name-uni…
bendichter Jan 4, 2026
38248f1
fix: microephys electrodes/coordsystem validation with space entity s…
ree-gupta Jan 4, 2026
0a0748e
fix(convention): update the schema selector convention from == to usi…
ree-gupta Jan 4, 2026
40cdcdc
fix(convention): use __ instead of _ for microephys context
ree-gupta Jan 4, 2026
5e91f38
cleanup(schema): remove old unused probe suffix
ree-gupta Jan 4, 2026
7a23830
cleanup(schema): remove unsused column contact_count
ree-gupta Jan 4, 2026
7c6aed2
fix(convention): fix display name capitalization and hypenation
ree-gupta Jan 4, 2026
ad50350
[BEP032] Review and clean-up suggestions (#2293)
ree-gupta Jan 6, 2026
5f71366
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 7, 2026
87de228
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 7, 2026
95ee115
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 7, 2026
3b2a8fe
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 7, 2026
673d107
Update src/modality-specific-files/microelectrode-electrophysiology.md
bendichter Jan 7, 2026
607a042
enh(schema): add electrode_name, make reference optional and generali…
ree-gupta Jan 7, 2026
eb893f3
Remove dimension_unit from electrode table description
bendichter Jan 7, 2026
c2978a5
Remove redundant statement about required columns order in *_electrod…
bendichter Jan 7, 2026
5e56978
move description of electrode position columns in microelectrode elec…
bendichter Jan 7, 2026
b46c11f
cleanup: remove additions to events that are not microephys specific
ree-gupta Jan 7, 2026
659c57c
Remove outdated comments and streamline pharmaceuticals section in mi…
bendichter Jan 7, 2026
78478ef
Merge branch 'bep032' of https://github.com/bids-standard/bids-specif…
bendichter Jan 7, 2026
6aa3f0e
update source attribution to BrainSTEM
bendichter Jan 7, 2026
f72e70b
fix(linter): fix remark linter error
ree-gupta Jan 8, 2026
7cb141f
Merge branch 'master' into bep032
ree-gupta Jan 8, 2026
67821db
fix(build): add missing closing ticks for TSV in md
ree-gupta Jan 8, 2026
7a1d9f1
Update src/modality-specific-files/microelectrode-electrophysiology.md
CodyCBakerPhD Jan 8, 2026
f1f472f
Update src/modality-specific-files/microelectrode-electrophysiology.md
CodyCBakerPhD Jan 8, 2026
e3ccafd
Merge branch 'master' into bep032
bendichter Jan 9, 2026
078ce68
docs(ephys): add electrode_name column to channels table example
bendichter Jan 9, 2026
3fde7c4
fix(microephys): move reference__microephys to be optional in channel…
bendichter Jan 9, 2026
5cbe907
move reference__microephys
bendichter Jan 9, 2026
bec3b0b
fix(coordinate-systems): update link format for Microelectrode Surgic…
bendichter Jan 12, 2026
9e465ed
Merge branch 'master' into bep032
ree-gupta Jan 14, 2026
f21acbf
fix: Correct formatting in electrode data table for clarity
bendichter Jan 14, 2026
bb009bf
fix: Correct electrode name formatting in electrophysiology examples …
bendichter Jan 14, 2026
27adf0e
docs: correct coordinate system descriptions and references
bendichter Jan 15, 2026
bbb8e1f
fix: Add ignore rule for SciCrunch URLs in link checker
bendichter Jan 15, 2026
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
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nav:
- Near-Infrared Spectroscopy: modality-specific-files/near-infrared-spectroscopy.md
- Motion: modality-specific-files/motion.md
- Magnetic Resonance Spectroscopy: modality-specific-files/magnetic-resonance-spectroscopy.md
- Microelectrode Electrophysiology: modality-specific-files/microelectrode-electrophysiology.md
- Electromyography: modality-specific-files/electromyography.md
- Derivatives:
- BIDS Derivatives: derivatives/introduction.md
Expand All @@ -44,6 +45,7 @@ nav:
- MEG file formats: appendices/meg-file-formats.md
- MEG systems: appendices/meg-systems.md
- Coordinate systems: appendices/coordinate-systems.md
- Microelectrode surgical coordinates: appendices/microelectrode-surgical-coordinates.md
- Quantitative MRI: appendices/qmri.md
- Arterial Spin Labeling: appendices/arterial-spin-labeling.md
- Cross modality correspondence: appendices/cross-modality-correspondence.md
Expand Down
159 changes: 159 additions & 0 deletions src/appendices/coordinate-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,165 @@ 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`):

<table>
<thead>
<tr>
<th><strong>Coordinate System</strong></th>
<th><strong>Description</strong></th>
<th><strong>Reference</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>Pixels</td>
<td>
If electrodes are localized in 2D space (x and y are specified and z is <code>n/a</code>), 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.
</td>
<td></td>
</tr>
<tr>
<td>Stereotaxic</td>
<td>
A generic stereotaxic coordinate system commonly used in animal neuroscience for surgical targeting
and electrode localization. The origin is at bregma, a skull landmark defined as the intersection
of the coronal and sagittal sutures. The three axes are: AP (Anterior-Posterior) with positive values
anterior to the reference point, ML (Medial-Lateral) with positive values to the right of midline,
and DV (Dorsal-Ventral) with positive values ventral to the reference point.
See the <a href="./microelectrode-surgical-coordinates.md">Microelectrode Surgical Coordinates</a>
appendix for detailed axis conventions and angle definitions.
Units are typically in millimeters or micrometers.
</td>
<td></td>
</tr>
<tr>
<td>AllenCCFv3</td>
<td>
Allen Common Coordinate Framework version 3 (<a href="https://scicrunch.org/resolver/RRID:SCR_020999">RRID:SCR_020999</a>),
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.
</td>
<td><a href="https://doi.org/10.1016/j.cell.2020.04.007">doi:10.1016/j.cell.2020.04.007</a></td>
</tr>
<tr>
<td>WaxholmSpace</td>
<td>
A standardized 3D coordinate system for the rat brain (<a href="https://scicrunch.org/resolver/RRID:SCR_001592">RRID:SCR_001592</a>)
based on high-resolution imaging data. Part of the Waxholm Space atlas of the Sprague Dawley rat brain.
</td>
<td><a href="https://doi.org/10.1371/journal.pcbi.1001065">doi:10.1371/journal.pcbi.1001065</a></td>
</tr>
<tr>
<td>WistarRatAtlas</td>
<td>
A multidimensional magnetic resonance histology atlas of the adult Wistar rat brain
(<a href="https://scicrunch.org/resolver/RRID:SCR_006288">RRID:SCR_006288</a>). This atlas provides
high-resolution anatomical reference for rat brain studies.
</td>
<td><a href="https://doi.org/10.1016/j.neuroimage.2012.05.041">doi:10.1016/j.neuroimage.2012.05.041</a></td>
</tr>
<tr>
<td>PaxinosWatson</td>
<td>
The Paxinos and Watson rat brain atlas (<a href="https://scicrunch.org/resolver/RRID:SCR_006369">RRID:SCR_006369</a>),
a widely used stereotaxic coordinate system for the rat brain.
Provides standardized coordinates based on skull landmarks (bregma, lambda) for targeting brain structures.
Multiple editions available; users should specify the edition used in <code>MicroephysCoordinateSystemDescription</code>.
</td>
<td>Paxinos G, Watson C. The Rat Brain in Stereotaxic Coordinates. Academic Press.</td>
</tr>
<tr>
<td>FranklinPaxinos</td>
<td>
The Franklin and Paxinos mouse brain atlas (<a href="https://scicrunch.org/resolver/RRID:SCR_007127">RRID:SCR_007127</a>),
a widely used stereotaxic coordinate system for the mouse brain.
Provides standardized coordinates based on skull landmarks (bregma, lambda) for targeting brain structures.
Multiple editions available; users should specify the edition used in <code>MicroephysCoordinateSystemDescription</code>.
</td>
<td>Franklin KBJ, Paxinos G. The Mouse Brain in Stereotaxic Coordinates. Academic Press.</td>
</tr>
<tr>
<td>SwansonRat</td>
<td>
The Swanson rat brain atlas (<a href="https://scicrunch.org/resolver/RRID:SCR_007367">RRID:SCR_007367</a>),
a widely used stereotaxic coordinate system for the rat brain.
Provides detailed cytoarchitectonic parcellation and standardized coordinates for targeting brain structures.
Multiple editions available; users should specify the edition used in <code>MicroephysCoordinateSystemDescription</code>.
</td>
<td>Swanson LW. Brain Maps: Structure of the Rat Brain. Elsevier.</td>
</tr>
<tr>
<td>CHARM</td>
<td>
Cortical Hierarchy Atlas of the Rhesus Macaque (<a href="https://scicrunch.org/resolver/RRID:SCR_023283">RRID:SCR_023283</a>),
a modern MRI-based atlas for the macaque brain.
Provides hierarchical cortical parcellation based on anatomical connectivity patterns.
</td>
<td><a href="https://doi.org/10.1016/j.neuroimage.2021.117997">doi:10.1016/j.neuroimage.2021.117997</a></td>
</tr>
<tr>
<td>D99</td>
<td>
Digital version of the Saleem and Logothetis macaque brain atlas (<a href="https://scicrunch.org/resolver/RRID:SCR_014606">RRID:SCR_014606</a>).
Provides detailed parcellation of the rhesus macaque brain based on histological sections.
</td>
<td><a href="https://doi.org/10.1093/cercor/bhw248">doi:10.1093/cercor/bhw248</a></td>
</tr>
<tr>
<td>PaxinosMacaque</td>
<td>
The Paxinos rhesus macaque brain atlas (<a href="https://scicrunch.org/resolver/RRID:SCR_016249">RRID:SCR_016249</a>),
a stereotaxic coordinate system for the macaque brain.
Provides standardized coordinates based on stereotaxic landmarks for targeting brain structures.
Multiple editions available; users should specify the edition used in <code>MicroephysCoordinateSystemDescription</code>.
</td>
<td>Paxinos G, Huang XF, Petrides M, Toga AW. The Rhesus Monkey Brain in Stereotaxic Coordinates. Academic Press.</td>
</tr>
<tr>
<td>MarmosetBrainAtlas</td>
<td>
A standardized 3D coordinate system for the common marmoset brain (<a href="https://scicrunch.org/resolver/RRID:SCR_023286">RRID:SCR_023286</a>).
Provides high-resolution anatomical reference for marmoset brain studies.
</td>
<td><a href="https://doi.org/10.1016/j.neuroimage.2017.12.004">doi:10.1016/j.neuroimage.2017.12.004</a></td>
</tr>
<tr>
<td>individual</td>
<td>
Subject-specific anatomical coordinate system derived from the individual subject's anatomy. The origin
and orientation should be specified in <code>MicroephysCoordinateSystemDescription</code>. This coordinate
system requires specifying an additional, subject-specific file to be fully defined.
</td>
<td></td>
</tr>
<tr>
<td>Other</td>
<td>
Use this for other coordinate systems and specify all required details in the
<code>MicroephysCoordinateSystemDescription</code> field.
</td>
<td></td>
</tr>
</tbody>
</table>

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-system-json-_coordsystemjson).

<!-- Link Definitions -->

[common file level metadata fields]: ../derivatives/common-data-types.md#common-file-level-metadata-fields
Expand Down
61 changes: 61 additions & 0 deletions src/appendices/microelectrode-surgical-coordinates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Microelectrode Surgical Coordinates

The surgical coordinates system provides a standard way to describe the placement of an intracranial probe implantation during surgery.

## Anatomical Reference Points

In neurosurgery and research, it can be important to define coordinates for where in the brain a surgical intervention will take place.
These coordinates rely on anatomical markers that are uniform across individuals.
There are two major anatomical markers on the dorsal surface of the brain that are formed when the plates of the skull fuse during development, and these markers are often used to identify the location of various anatomical structures of the brain.

<img src="../modality-specific-files/images/bregma_and_lambda.png" alt="Bregma and Lambda anatomical reference points" style="max-width: 600px;">

**Bregma**: the anatomical point on the skull at which the coronal suture (between frontal and parietal bones) is intersected perpendicularly by the sagittal suture (between left and right parietal bones).

**Lambda**: the meeting point of the sagittal suture (between left and right parietal bones) and the lambdoid suture (between parietal and occipital bones).

Both points serve as standard reference points for stereotaxic coordinates in neuroscience research. `(0,0,0)` is assumed to be Bregma when working with rodents. It may optionally be defined differently using `anatomical_reference_point`, and MUST be defined for other species.

## Stereotaxic Coordinate System Conventions

All stereotaxic coordinate systems follow a right-handed coordinate system with the following conventions:

<img src="../modality-specific-files/images/AP_ML_DV.png" alt="AP_ML_DV coordinate system" style="max-width: 600px;">

- **AP (Anterior-Posterior) axis:** Positive values are anterior to reference point
- **ML (Medial-Lateral) axis:** Positive values are to the right (as seen from behind)
- **DV (Dorsal-Ventral) axis:** Positive values are ventral (following right-hand rule). For humans, this is the superior-inferior axis, and positive values point to inferior.

Proper understanding and application of these angles is critical for accurate probe placement and experimental reproducibility. All stereotaxic measurements use three angles to specify orientation:

### AP angle (Anterior-Posterior rotation)

<img src="../modality-specific-files/images/AP_angle.png" alt="AP angle rotation diagram" style="max-width: 600px;">

- Measured as rotation from the vertical axis in the sagittal plane
- 0° represents vertical along DV axis
- Range: -180° to +180°
- Positive values indicate anterior rotation
- Example: +15° indicates probe tilted 15° anteriorly from vertical

### ML angle (Medial-Lateral rotation)

<img src="../modality-specific-files/images/ML_angle.png" alt="ML angle rotation diagram" style="max-width: 600px;">

- Measured as rotation from the vertical axis in the coronal plane
- 0° represents vertical along DV axis
- Range: -180° to +180°
- Positive values indicate rightward/clockwise rotation (as seen from behind)
- Example: +20° indicates probe tilted 20° to the right from vertical

### Rotation angle (around probe axis)

<img src="../modality-specific-files/images/rotation_angle.png" alt="Rotation angle diagram" style="max-width: 600px;">

- 0° when probe features align with the coronal plane
- Range: -180° to +180° (or 0° to 360°)
- Positive rotation is clockwise when viewed from above

!!! note "Source Attribution"

The coordinate system conventions and angle definitions presented in this section are adapted from the [BrainSTEM documentation](https://support.brainstem.org/datamodel/schemas/coordinates/).
Binary file added src/modality-specific-files/images/AP_ML_DV.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/modality-specific-files/images/AP_angle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/modality-specific-files/images/ML_angle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading