Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
150 commits
Select commit Hold shift + click to select a range
9878702
First draft of the atlas spec
melanieganz Jan 23, 2024
8304769
Added proper content
melanieganz Jan 23, 2024
01178db
First pass of adding BEP038 content
melanieganz Jan 23, 2024
81d5ccc
Fixed details
melanieganz Jan 23, 2024
7626992
case 3 files renamed
melanieganz Jan 24, 2024
11ed800
update wording and fix typos in atlas.md
PeerHerholz Jan 25, 2024
1129d8d
add draft for outlining desc- usage
PeerHerholz Jan 25, 2024
6881c9c
add ref to template and lnter
CPernet Jan 31, 2024
e2b3ddb
Remove trailing whitespace, normalize indentation to two spaces
effigies Feb 6, 2024
f7a268d
Run codespell and aspell
effigies Feb 6, 2024
a96ab79
Replace i.e. and e.g.
effigies Feb 6, 2024
18e2bcc
Line break at sentences, format nested list as markdown
effigies Feb 6, 2024
803f0d4
Replace unicode quotes with ASCII
effigies Feb 6, 2024
dda4790
Include atlas.md in table of contents
effigies Feb 6, 2024
ba30c0e
Semantic line breaks, mostly at commas
effigies Feb 6, 2024
9c803d7
FIX: Whitespace in schema.objects.entities.atlas.description
effigies Feb 6, 2024
33e55b5
Merge pull request #1 from effigies/bep038
PeerHerholz Feb 6, 2024
9baaeec
Merge branch 'master' into bep038
effigies Feb 28, 2024
4fa15e5
first iteration of the alternative proposal
oesteban Jun 12, 2024
0180e3b
STY: codespell
effigies Jun 12, 2024
bba4159
Replace links to the schema with links to the glossary
effigies Jun 12, 2024
f159e61
enh: generalization of atlas metadata cc/ @jdkent
oesteban Jun 17, 2024
9390602
enh: address some of @effigies' comments
oesteban Jun 17, 2024
3f8c210
enh: reference entities from glossary
oesteban Jun 17, 2024
927335c
fix: folder => directory
oesteban Jun 17, 2024
6a3dcc7
fix: resolving issues with/within entities
oesteban Jun 17, 2024
f7e906d
enh: add mention to transforms files cc/ @peerherholz
oesteban Jun 17, 2024
57160cd
fix: revise more glossary links
oesteban Jun 17, 2024
1db3fd4
enh: move all filetree examples to macros
oesteban Jun 17, 2024
48e77ae
enh: miscellaneous improvements (sort entries in examples, etc.)
oesteban Jun 17, 2024
d6cf6a4
enh: improve intro
oesteban Jun 18, 2024
8bfc7ac
enh: add datatype comment to make it recommended cc/ @effigies
oesteban Jun 18, 2024
f2be20a
enh: start drafting cohort
oesteban Jun 18, 2024
d15677a
enh: add multi-cohort example
oesteban Jun 18, 2024
b275ca3
fix: pacify pre-commit build
oesteban Jun 18, 2024
f9ff346
enh: add the PS13 example
oesteban Jun 18, 2024
f0e8e0e
test
jdkent Jun 21, 2024
b00bdf8
Update src/derivatives/atlas.md
jdkent Jun 21, 2024
abe37b4
Update src/derivatives/atlas.md
jdkent Jun 21, 2024
d812b08
incorporate meeting feedback in schema
jdkent Jun 21, 2024
3accb28
enh: add note about 'MNI Space' below template identifiers @CPernet
oesteban Oct 7, 2024
e5e27f1
enh: clarify the creation of BOTH a new template AND atlas
oesteban Oct 7, 2024
8ffda51
fix: avoid using an atlas name for a segmentation label
oesteban Oct 7, 2024
d62f0d9
enh: rework the text to clarify notions: atlas, template, space
oesteban Oct 7, 2024
161db11
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 7, 2024
44cb808
fix: addressing some inconsistencies about segmentations
oesteban Oct 11, 2024
c77df10
fix: add clarification about cohort
oesteban Oct 11, 2024
947f279
fix: replace ``_mimap`` with ``_pet``
oesteban Oct 11, 2024
a5111aa
fix: replace ``label-`` with ``seg-`` where applies
oesteban Oct 12, 2024
c05146c
enh: update schema according to this proposal
oesteban Oct 12, 2024
f221ad0
fix: folder -> directory (pacify pre-commit)
oesteban Oct 12, 2024
9ec94cd
fix: order of ``scale-`` in the schema
oesteban Oct 12, 2024
1a258b5
enh: refine atlas' definition in common principles
oesteban Oct 12, 2024
79f1ea9
enh: add "authoritative definition of spaces" to template
oesteban Oct 12, 2024
3f2bde5
enh: update schema to consider ``tpl-`` and ``cohort-``
oesteban Oct 12, 2024
95a85a1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 12, 2024
0d7f965
enh(schema): add ``atlas`` to entities
oesteban Oct 12, 2024
a9fa24a
fix: delete photo from atlas' file rules
oesteban Oct 12, 2024
44c3ad8
Update src/schema/objects/columns.yaml
oesteban Oct 12, 2024
b66c3ee
fix: dereference twice schema files
oesteban Oct 14, 2024
c3b6f41
fix: add missing properties to atlas entity definition
oesteban Oct 14, 2024
891bcf0
FIX: update PET examples
mnoergaard Oct 23, 2024
3c517b2
Merge remote-tracking branch 'upstream/master' into bep038
effigies Nov 5, 2024
ef1817b
Merge remote-tracking branch 'upstream/bep038' into bep038-review
effigies Nov 5, 2024
bc6b064
schema: Move templates out of rules.files
effigies Nov 5, 2024
226f134
test: Fix check to avoid overlap between common_principles and common
effigies Nov 5, 2024
ac745e6
schema: Update metaschema, fix errors caught by metaschema
effigies Nov 5, 2024
4cd7f1d
Revert "FIX: update PET examples"
oesteban Mar 12, 2025
ee708fd
Merge remote-tracking branch 'upstream/master' into bep038-review
oesteban Mar 12, 2025
b527298
Merge remote-tracking branch 'upstream/master' into bep038
effigies Mar 12, 2025
be32035
Merge branch 'bep038' into bep038-review
effigies Mar 12, 2025
b0775ac
enh: deep refactor after March 11 meeting
oesteban Mar 13, 2025
595ff58
Merge branch 'bep038-review' of github.com:oesteban/bids-specificatio…
oesteban Mar 13, 2025
6ac57c1
fix: typos
oesteban Mar 13, 2025
e67df38
fix: sloppy merge
oesteban Mar 18, 2025
dc84d11
enh: cleanup before merging cc @effigies
oesteban Apr 14, 2025
3639a41
enh: add ``SampleSize`` as required atlas description metadata
oesteban Apr 14, 2025
045a4cb
enh: add one more subsection to atlas
oesteban Apr 14, 2025
d615e66
fix: pacify codespell + links to entities (rather than glossary)
oesteban Apr 15, 2025
0ec4649
Merge pull request #1856 from oesteban/bep038-review
effigies Apr 15, 2025
4722c22
Merge remote-tracking branch 'upstream/master' into bep038
effigies Apr 15, 2025
2266fb7
fix: Latin phrases
effigies Apr 15, 2025
01160d9
sty: remark complaints
effigies Apr 15, 2025
64c7179
Update src/schema/objects/common_principles.yaml
effigies May 6, 2025
1937b5d
Update src/schema/objects/common_principles.yaml
effigies May 6, 2025
6be8664
Update src/schema/objects/common_principles.yaml
effigies May 6, 2025
819ea5f
Apply suggestions from code review
effigies May 6, 2025
390885b
Merge remote-tracking branch 'upstream/master' into bep038
effigies May 27, 2025
393707e
sty: Address yamllint errors
effigies May 27, 2025
598c64c
Apply suggestions from code review
effigies May 30, 2025
58dec06
Update src/schema/rules/tabular_data/derivatives/common_derivatives.yaml
effigies Jun 3, 2025
2176709
Apply suggestions from code review
effigies Jun 3, 2025
265cc91
feat: Update definitions of cohort and atlas entities
effigies Jun 3, 2025
9438c09
Apply suggestions from code review
effigies Jun 6, 2025
a5e3857
Make tpl/cohort to sub/ses analogy in a note
effigies Jun 6, 2025
7f757d9
Add statement to preface examples
effigies Jun 6, 2025
f6f29a3
fix: TSV spacing
effigies Jun 6, 2025
71bfe0e
Remove unenforceable recommendation
effigies Jun 7, 2025
e3541f4
Cleanup suggestions from @pwighton
effigies Jun 17, 2025
0298a6e
Merge remote-tracking branch 'upstream/master' into bep038
effigies Jun 17, 2025
b8c29ac
schema: Allow template directories
effigies Jun 17, 2025
ddae920
schema: Define atlas-*_description.json files
effigies Jun 17, 2025
442022a
feat(schema): Add meta.templates
effigies Jun 18, 2025
ec4c6ac
fix(test): Replace removed schema location
effigies Jun 18, 2025
735115a
feat(schema): Move more imaging data into imaging.yaml
effigies Jun 19, 2025
651cf87
feat(schema): Remove redundant anatomical derivative rules
effigies Jun 19, 2025
64d16fe
feat(schema): Expand use of raw templates
effigies Jun 19, 2025
723c265
rf: Dereference while looking up references
effigies Jun 20, 2025
c8cc8af
Merge branch 'multiref' into bep038
effigies Jun 20, 2025
a017a1e
rf(schema): Move atlas definitions into derivatives
effigies Jun 20, 2025
9a8dd63
Add description suffix
effigies Jun 20, 2025
2bb65c1
Merge remote-tracking branch 'upstream/master' into bep038
effigies Jun 20, 2025
3ba6693
Merge remote-tracking branch 'upstream/bep038' into bep38-schema-refa…
effigies Jun 20, 2025
e5e0c07
Merge pull request #2145 from effigies/bep38-schema-refactor
effigies Jun 20, 2025
aa50928
Apply suggestions from code review
effigies Jun 20, 2025
f830888
Update tools/schemacode/src/bidsschematools/schema.py
effigies Jun 20, 2025
7af68de
Apply suggestions from code review
effigies Jun 20, 2025
f6b62f5
Merge remote-tracking branch 'upstream/master' into bep038
effigies Jun 20, 2025
2afe0b0
Merge commit 'dd1e5d23' into bep038
effigies Oct 30, 2025
6ff150d
Merge commit '6d002b21' into bep038
effigies Oct 30, 2025
4262905
Merge remote-tracking branch 'upstream/master' into bep038
effigies Oct 30, 2025
84bd2e5
fix: Drop cohort from non-atlas derivatives
effigies Oct 30, 2025
0c6e99c
fix: Move atlas description to the top of the dataset
effigies Oct 30, 2025
b2ffc8e
schema: Add atlas description association
effigies Oct 30, 2025
afeb393
Apply suggestions from code review
effigies Nov 4, 2025
8a07810
Update src/schema/rules/files/deriv/imaging.yaml
effigies Nov 4, 2025
e3bc354
feat: Validate presence of associated atlas-<label>_description.json
effigies Nov 4, 2025
2764ece
Add recommendation for non-template atlas descriptions
effigies Nov 5, 2025
6de3e40
Set atlas description contents
effigies Nov 5, 2025
ac7ad10
Move atlas descriptions to dataset root
effigies Nov 5, 2025
61c08c9
Update text and example headings
effigies Nov 5, 2025
3be49c3
Simplify templates, remove single-subject
effigies Nov 5, 2025
3917225
Clarify scope of xfm warning, render atlas definition
effigies Nov 5, 2025
0c36a54
Remove surface-space atlas examples
effigies Nov 5, 2025
e18e4bc
Remove PS13 example
effigies Nov 5, 2025
ebb91b3
Remove SpatialReference from example atlas descriptions, clarify requ…
effigies Nov 5, 2025
5b223cd
Allow tpl/space to be standard
effigies Nov 5, 2025
120d7a4
Fix spaces, more updates
effigies Nov 5, 2025
96492c2
Add RRID metadata to match example
effigies Nov 5, 2025
d9c9a50
Remove references to probseg/mask.tsv
effigies Nov 5, 2025
a9f73ba
schema: Fix nlin6asym capitals, make tpl valid space source
effigies Nov 5, 2025
b7af093
schema: Deduplicate atlas description specs
effigies Nov 6, 2025
f0b8c4d
fix: Use correct schema path
effigies Nov 6, 2025
d088e6d
chore: Update metaschema
effigies Nov 6, 2025
b67ac34
Merge remote-tracking branch 'upstream/master' into bep038
effigies Nov 6, 2025
932cf69
Merge branch 'master' into bep038
effigies Nov 6, 2025
6caad0e
Bump
effigies Nov 10, 2025
d4f0a33
Update src/derivatives/atlas.md
effigies Nov 12, 2025
f56ebb1
Update src/derivatives/atlas.md
effigies Nov 12, 2025
df5f710
Update src/derivatives/imaging.md
effigies Nov 13, 2025
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
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ nav:
- BIDS Derivatives: derivatives/introduction.md
- Common data types and metadata: derivatives/common-data-types.md
- Imaging data types: derivatives/imaging.md
- Templates and atlases: derivatives/atlas.md
- Longitudinal and multi-site studies: longitudinal-and-multi-site-studies.md
- Glossary: glossary.md
- BIDS Extension Proposals: extensions.md
Expand Down
7 changes: 7 additions & 0 deletions src/appendices/coordinate-systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,13 @@ However, their use is [DEPRECATED][deprecated].
| fsaverage\[3\|4\|5\|6\|sym\] | Images were sampled to the FreeSurfer surface reconstructed from the subject's T1w image, and registered to an fsaverage template | fsaverage\[Sym\] |
| UNCInfant\[0\|1\|2\]V\[21\|22\|23\] | Infant Brain Atlases from Neonates to 1- and 2-year-olds. [https://www.nitrc.org/projects/pediatricatlas](https://www.nitrc.org/projects/pediatricatlas) | UNCInfant |

!!! note "Important"

Please note that the template identifiers starting with `MNI` (for example `MNI305`)
are typically referred to with the umbrella term of *MNI Space*.
The [Common Principles](../common-principles.md#definitions) deliver a more precise definitions
of template, space, and atlas.

### Nonstandard coordinate system identifiers

The following template identifiers are RECOMMENDED for individual- and study-specific reference
Expand Down
33 changes: 30 additions & 3 deletions src/common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ data type as defined above.
A data type directory SHOULD NOT be defined if there are no files to be placed
in that directory.

**Specific structure of derived data**.
In the case of [storing derived data (see below)](#source-vs-raw-vs-derived-data),
template (`tpl-<label>`) directories may be found at the root of the dataset,
and these may include cohort (`cohort-<label>`) subdirectories.
These directories are described in [Templates and atlases](derivatives/atlas.md).

### Other top level directories

In addition to the subject directories, the root directory of a BIDS dataset
Expand Down Expand Up @@ -297,6 +303,15 @@ However, in the case that these data are to be included:
through the `sourcedata/` directory mechanism.
In the case of source data, these aspects are likely more stringent.

**Templates and atlases as derived data.**
Templates and atlases are key neuroscientific tools to carry out group-level inferences
and also employed in many atlas-based methodologies (such as atlas-based segmentation).
Original templates and atlases employed as primary data to the analysis MAY be stored
within the `sourcedata/atlases/` directory.
Atlases and artifacts derived from atlases are considered derived data
and MUST be stored as derivative datasets,
as described in the next section.

### Storage of derived datasets

Derivatives can be stored/distributed in two ways:
Expand Down Expand Up @@ -332,6 +347,15 @@ Derivatives can be stored/distributed in two ways:
<dataset>/derivatives/spm-stats/sub-0001
```

Example of an atlas-generating pipeline, including outputs for individual subjects
prior to aggregation in the
[`MNI152NLin2009cAsym` standard space](appendices/coordinate-systems.md):

```Plain
<dataset>/derivatives/atlas-generator/sub-0001
<dataset>/derivatives/atlas-generator/tpl-MNI152NLin2009cAsym
```

Example of a pipeline with nested derivative directories:

```Plain
Expand Down Expand Up @@ -386,11 +410,14 @@ Case 2.
In both cases, every derivatives dataset is considered a BIDS dataset and must
include a `dataset_description.json` file at the root level (see
[Dataset description][dataset-description]).
Consequently, files should be organized to comply with BIDS to the full extent
Consequently, files SHOULD be organized to comply with BIDS to the full extent
possible (that is, unless explicitly contradicted for derivatives).
Any subject-specific derivatives should be housed within each subject's directory;
if session-specific derivatives are generated, they should be deposited under a
Any subject-specific derivatives SHOULD be housed within each subject's directory;
if session-specific derivatives are generated, they SHOULD be deposited under a
session subdirectory within the corresponding subject directory; and so on.
Likewise, any template-specific derivatives SHOULD be housed within each template's directory;
if cohort-specific derivatives are generated, they SHOULD be deposited under a
cohort subdirectory within the corresponding template directory; and so on.

### Non-compliant derivatives

Expand Down
Loading