-
Notifications
You must be signed in to change notification settings - Fork 169
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] BEP031: Microscopy #881
Conversation
It depends on how your definition is different. Do you feel that the altered definition can be incorporated as an addition to the existing one? Is there are more general form of the existing definition that would work better for all applications? If microscopy requires a completely different definition, then we can support that in the schema, but we try to avoid that situation, so having context-dependent additions to the definition would be preferable. |
In both cases, it's context-dependent replacement, the first sentence (general description) remains the same, but the second sentence (DICOM tag and/or example) is different. So I think the first sentence could remain in the yaml file description, but the second one would go in modality-dependent files. Proposed changes are documented in the comments of 10-microscopy.md on line 213 and 247. |
Hi @bids-standard/maintainers , We also have opened a PR last week for 2 bids-examples for microscopy (#286) Please let us know if we forgot something or if there is something else we need to do prior to the maintainers review. |
A minor note on the "ShrinkageFactor" sidecar field: we do tissue expansion - the tissue is osmotically expanded to several times its original size to attain higher resolution from the same microscope objective. The explanation text reads, "Estimated shrinkage factor of the tissue, given in percent (between 0 and 100%)". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, IMO! I have a few comments. Feel free to push back on them...
Typo Co-authored-by: Chris Markiewicz <[email protected]>
Thank you @LeeKamentsky for pointing that out, this is a very interesting point. What about a “TissueDeformationScaling” field, expressed as a percentage of the original tissue size, with no upper limit.
Let me know your thoughts |
Thanks, Marie - your TissueDeformationScaling recommendation would be perfect. |
Thank you Lee, the modification is done in 2a5cf25. |
Hi @bids-standard/maintainers, |
Hi @bids-standard/maintainers, |
Hey @mariehbourget sorry for not getting back to you sooner - we just discussed this in our biweekly maintainers meeting, and will finish a final, quick pass very soon and then get back to you. |
Hi @satra, At this stage, we have completed the specification, examples and validators for the current supported microscopy formats (PNG, TIF, OME-TIFF). Making a “clean” addition of the NGFF format would most likely require adding at last one example dataset and do a major update to the validator. Apart from the file extension, the validator also check consistency for metadata between OME-TIFF files and BIDS JSON metadata. I don’t have a good enough knowledge of NGFF at this point to know if and how the same checks should be performed for NGFF files. I would suggest merging this PR and releasing the microscopy specification as is and treat the NGFF format as an extension to this BEP. |
@mariehbourget - i can send a separate PR for ngff after this is merged. |
Hi @bids-standard/maintainers, Following the merge of the microscopy examples PR bids-standard/bids-examples#286, I updated the link to the examples in the specs, so the post community-review checklist is complete. I also added "samples" to All the other comments have been addressed, but there are some conflicts with master related to the schema that I am not comfortable resolving. |
@mariehbourget @tsalo I resolved the conflict. Can you verify that the schema portions of the PR look correct? |
@effigies I don't see any issues with the merge. Thanks! |
Thanks @effigies! The merge looks good for the microscopy parts (on the PDF) but the RTD build failed with this error: EDIT: oops, it seems to be my fault with a broken link here.
|
I wonder whether it wouldn't be more consistent with BIDS practices to have the suffixes as lower-case, after all |
hum... I am pretty sure that BEP001 has introduced many precedents for using upper case suffixes: https://github.com/bids-standard/bids-specification/blob/master/src/schema/objects/suffixes.yaml So I don't think this should be an issue for concern. |
I was thinking of suffixes, but you're right, there are even upper-case suffixes: chymera@decohost ~/src/bids-specification/src/schema $ git rev-parse HEAD
febae4fb9b2c9f055dc1392e0283c85f05618de0
chymera@decohost ~/src/bids-specification/src/schema $ grep -R suffixes rules/datatypes/ -A 1
rules/datatypes/pet.yaml:- suffixes:
rules/datatypes/pet.yaml- - pet
--
rules/datatypes/pet.yaml:- suffixes:
rules/datatypes/pet.yaml- - blood
--
rules/datatypes/pet.yaml:- suffixes:
rules/datatypes/pet.yaml- - events
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - ieeg
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - channels
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - coordsystem
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - electrodes
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - events
--
rules/datatypes/ieeg.yaml:- suffixes:
rules/datatypes/ieeg.yaml- - photo
--
rules/datatypes/beh.yaml:- suffixes:
rules/datatypes/beh.yaml- - stim
--
rules/datatypes/beh.yaml:- suffixes:
rules/datatypes/beh.yaml- - events
--
rules/datatypes/perf.yaml:- suffixes:
rules/datatypes/perf.yaml- - asl
--
rules/datatypes/perf.yaml:- suffixes:
rules/datatypes/perf.yaml- - aslcontext
--
rules/datatypes/perf.yaml:- suffixes:
rules/datatypes/perf.yaml- - asllabeling
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - eeg
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - channels
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - coordsystem
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - electrodes
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - events
--
rules/datatypes/eeg.yaml:- suffixes:
rules/datatypes/eeg.yaml- - photo
--
rules/datatypes/func.yaml:- suffixes:
rules/datatypes/func.yaml- - bold
--
rules/datatypes/func.yaml:- suffixes:
rules/datatypes/func.yaml- - phase # deprecated
--
rules/datatypes/func.yaml:- suffixes:
rules/datatypes/func.yaml- - events
--
rules/datatypes/func.yaml:- suffixes:
rules/datatypes/func.yaml- - physio
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - T1w
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - T1map
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - defacemask
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - MESE
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - VFA
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - IRT1
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - MP2RAGE
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - MPM
--
rules/datatypes/anat.yaml:- suffixes:
rules/datatypes/anat.yaml- - MTR
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - phasediff
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - epi
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - TB1DAM
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - TB1EPI
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - TB1AFI
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - TB1SRGE
--
rules/datatypes/fmap.yaml:- suffixes:
rules/datatypes/fmap.yaml- - TB1map
--
rules/datatypes/dwi.yaml:- suffixes:
rules/datatypes/dwi.yaml- - dwi
--
rules/datatypes/dwi.yaml:- suffixes:
rules/datatypes/dwi.yaml- - sbref
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - meg
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - meg
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - meg
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - headshape
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - markers
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - coordsystem
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - channels
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - events
--
rules/datatypes/meg.yaml:- suffixes:
rules/datatypes/meg.yaml- - photo Is there any heuristic for when uppercase and when lowercase is used? Going by |
AFAICT not really. Although the all uppercase from quantitative MRI kinda help identify file collections. But there have been mixed cases (like |
Hi @effigies! I'm still unable to build the doc locally, see #881 (comment). I followed these instructions in a fresh environment with a fresh clone. |
OK everyone! Stand back! We are merging!!! |
Awesome!! 🎉 |
i second @mariehbourget , thank you very much to everyone helping. Longue vie à BIDS! 🙌 |
For BEP merge: we should have a BEP merge party with a countdown and have a github action that sends a bottle of champagne (or other beverage of their liking) to the contributors. |
This PR aims to incorporate the Microscopy BEP031 into the BIDS specification.
It follows PR #812 that integrated the new
sample
entity andsamples.tsv
file, and PR #816 still open for addition of animal metadata to theparticipants.tsv
columns.Link to the rendered draft: https://bids-specification--881.org.readthedocs.build/en/881/04-modality-specific-files/10-microscopy.html
Thank you to everyone who contributed to this BEP!
Moderators: @mariehbourget, @jcohenadad
Note to the maintainers:
src/schema/entities.yaml
andsrc/schema/datatypes/microscopy.yaml
for the "Entities" and "Entity table" appendix.StationName
andBodyPart
). From my understanding of the schema and macros, this is something that we will be able to fix after community review with the yaml files. Let me know if that is correct.There is a "Recommended participant data" section that overlaps with PR [ENH] BEP031 - New columns to participants.tsv file #816 regardingstrain
andstrain_rrid
columns in participants.tsv. Its content depends on whether or not those columns will be included in the "general" Participants file section.EDIT: The "Recommended participant data" section is now up-to-date following the merge of PR [ENH] BEP031 - New columns to participants.tsv file #816.
Post community-review checklist
Bonus: