Skip to content

Commit

Permalink
Address suggestions by @tsalo
Browse files Browse the repository at this point in the history
  • Loading branch information
agahkarakuzu authored and sappelhoff committed Nov 27, 2020
1 parent bcb0223 commit 6d3bbea
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
19 changes: 10 additions & 9 deletions src/02-common-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,19 +161,20 @@ A summary of all entities in BIDS and the order in which they MUST be
specified is available in the [entity table](./99-appendices/04-entity-table.md)
in the appendix.

### Parametrically linked file collections
### Entity-linked file collections

A set of files that are related to each other based on a repetitive acquisition of
sequential data by changing acquisition parameters one (or multiple) at a time.
The suffix serves as an identifier for these collections, holding a logical grouping
of constituent files.
sequential data by changing acquisition parameters one (or multiple) at a time and/or by
being inherent components of the same data. The suffix serves as an identifier for these
collections, holding a logical grouping of constituent files.
Within each collection, files MUST be distinguished from each other by at least one
entity (e.g., `echo`) that corresponds to an altered acquisition parameter (e.g.,
`EchoTime`). Note that these entities MUST be described by the specification and the
parameter changes they declare SHOULD NOT invalidate the definition of the accompanying
suffix. For example, the use of the `echo` entity along with the `T1w` suffix casts doubt on
the validity of the identified contrast weighting.
Provided the conditions above are satisfied, any suffix (e.g. `bold`) can identify a parametrically linked file collection, although certain suffixes are exclusive for this purpose (e.g., `MP2RAGE`).
`EchoTime`) or that defines a component relationship (e.g., `part`). Note that these entities
MUST be described by the specification and the parameter changes they declare SHOULD NOT invalidate
the definition of the accompanying suffix. For example, the use of the `echo` entity along with the
`T1w` suffix casts doubt on the validity of the identified contrast weighting.
Provided the conditions above are satisfied, any suffix (e.g. `bold`) can identify an entity-linked file
collection, although certain suffixes are exclusive for this purpose (e.g., `MP2RAGE`).
All the use cases concerning this convention are RECOMMENDED to be included in the [file collections](./99-appendices/10-file-collections.md) appendix for clarity. This convention is mainly intended for but not
limited to MRI modalities.

Expand Down
4 changes: 2 additions & 2 deletions src/99-appendices/10-file-collections.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Appendix X: File collections

To give context to the use of [parametrically linked file collections](./02-common-principles.md#file-name-structure), applications appealing to this common
principle are listed by descriptive tables under their respective modalities.
To give context to the use of [entity-linked file collections](./02-common-principles.md#file-name-structure), applications concerned with this
common principle are listed by descriptive tables under their respective modalities.

## Magnetic Resonance Imaging

Expand Down

0 comments on commit 6d3bbea

Please sign in to comment.