Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] revisions to @oesteban's Alternative proposal to BEP038 #1

Open
wants to merge 7 commits into
base: bep038-review
Choose a base branch
from

Conversation

pwighton
Copy link

@pwighton pwighton commented Nov 19, 2024

These revisions are based off of a conversation with @oesteban and @mnoergaard in which it was clarified that an atlas is an aggregation of nominal (discreet-valued) data and a template is an aggregation of ordinal (continuous-valued) data.

  • The distinction between atlas template is clarified

    • An Atlas is an aggregation of nominal (discreet-valued) data
    • A Template is aggregation of ordinal (continuous-valued) data that MAY serve as authoritative definition of a space
    • When a template IS an authoritative definition of space:
      • The space keyword MUST NOT be used. The space it defines is the name of the template
    • When a template IS NOT an authoritative definition of space:
      • The space keyword MUST be used
    • Template and atlas MUST NOT be used together
  • Original proposal seemed to imply it's an altas/template only if it aggregates over more than one subject, otherwise the sub-<label> is used. This has been removed as it seems unnecessary and introduced complications (e.g In the colin27 example, it is not clear from the filname that sub-01_T1w.nii.gz is an aggregation of data across 27 scans) This should be incorporated into the definition if it is to be re-introduced

  • Removes the concept of 'derived from' from the definition of atlas. Provenance should be considered out of scope of this spec, imo

  • Removes references to "original default or implicit atlas". I don't think this concept is necessary, but if it is, it should be formally defined.

  • Reworked examples:

    • if the suffix is _desg, _probseg or _mask it's an atlas
    • it it's _pet, it's a template
    • The file atlas-ps13_res-2_space-fsaverage_desc-nopvc_dseg.tsv in the PS13 example Is an aggregation of the data in atlas-ps13_res-2_space-fsaverage_stat-mean_desc-nopvc_mimap.nii.gz, using the ROIs in atlas-fsaverage_dseg.nii.gz to define how the data is aggregated. This file is now called tpl-ps13_seg-fsaverage_pet.tsv in this PR since it's an aggregation of continuous-valued data.

- Modified the colin27 example to use `sub-colin27` to make the filenames more informative
- Modifed the ps13 examples to denote a clear distinction between atlases (aggregation of nominal data) and templates (aggregation of ordinal data).
  - atlas/tpl can't be used at the same time
  - relax requirement of cohort directory
  - remove language of cohort as 'dual' to session
  - remove references to provenance (out of scope, imo)
- sub-colin27 --> tpl-colin27
- label- --> seg-
@@ -289,6 +289,7 @@ If you contributed to the BIDS ecosystem and your name is not listed, please add
| Parul Sethi | 📖🔧⚠️💻 |
| Patricia Clement | 💬🐛💻📖🔣💡📋🤔📆⚠️📢 |
| Patrick Park | 📖💡💬💻 |
| Paul Wighton | 📖 |

Choose a reason for hiding this comment

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

@pwighton To avoid losing this to a reversion, please update https://github.com/bids-standard/bids-specification/wiki/Recent-Contributors, as this page is auto-generated from a source during the release process.

Copy link
Author

Choose a reason for hiding this comment

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

Thanks @effigies, I just updated that page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants