generated from w3c-ccg/markdown-to-spec
-
Notifications
You must be signed in to change notification settings - Fork 64
RFC 4: review from David Horsfall/ Hannifa lab #435
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
Open
clbarnes
wants to merge
1
commit into
ome:main
Choose a base branch
from
clbarnes:rfc4-review-horsfall
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # **RFC-4: Review 3** | ||
|
|
||
| (rfcs:rfc4:review3)= | ||
|
|
||
| * [https://github.com/ome/ngff/pull/253](https://github.com/ome/ngff/pull/253) | ||
| * [https://ngff.openmicroscopy.org/rfc/4/](https://ngff.openmicroscopy.org/rfc/4/) | ||
| * [https://ngff.openmicroscopy.org/rfc/1/templates/review\_template.html](https://ngff.openmicroscopy.org/rfc/1/templates/review_template.html) | ||
|
|
||
| **Review Authors**: Dave Horsfall | ||
| **Conflicts of Interest**: None declared | ||
|
|
||
| This review was primarily generated through discussions during a Hannifa Lab meeting, which involved diverse roles, including wet lab scientists, clinicians, bioinformaticians, data scientists, and engineers. I have tried to capture the key points of discussion in this review. | ||
|
|
||
| ## Summary | ||
|
|
||
| The RFC proposes an optional ***orientation*** field for the OME-NGFF specification to explicitly define axis direction using a controlled vocabulary. We support this addition. In fields like spatial transcriptomics and high-resolution histology, biological symmetry often makes it impossible to determine orientation after acquisition. | ||
|
|
||
| ## Significant Comments and Questions | ||
|
|
||
| ### **Clarification: "Subject-Local" vs "Patient-Global" Orientation** | ||
|
|
||
| The current proposal seems primarily geared toward imaging where the subject is a whole patient. In spatial transcriptomics and pathology, our subject is frequently a tissue biopsy, or histology slide. | ||
|
|
||
| * **The Gap:** The RFC states this metadata "MUST only be used... where the subject is roughly aligned to the imaging axes." In our use cases, we may not know how the biopsy was aligned to the patient, but we do know the internal orientation of the tissue itself. | ||
| * **Recommendation:** Clarify that "subject" can refer to local tissue structures. For a skin biopsy, the z-axis is "Superficial-to-Deep" regardless of the sample's original global position on the donor. Supporting local orientation makes this RFC universally applicable to the tissue-profiling community without requiring full "Patient-to-Atlas" registration. | ||
|
|
||
| ### **Controlled Vocabulary Expansion** | ||
|
|
||
| The current vocabulary has a focus on biped/quadruped canonical directions. To support clinical and other research contexts (e.g., dermatology, cardiology, and oncology), we recommend adding terms that describe layered and polarized tissues to controlled vocabulary: | ||
|
|
||
| * ***superficial-to-deep*** / ***deep-to-superficial***: for layered tissues like skin, gut, or cortex. | ||
| * ***apical-to-basal*** / ***basal-to-apical***: for epithelial layers and polarized cell structures. | ||
| * ***apex-to-base*** / ***base-to-apex***: for specific organs like the heart or lungs. | ||
|
|
||
| ### **Integration with RFC-5: A semantic bridge to Transformation?** | ||
|
|
||
| We see RFC-4 is a critical prerequisite for the successful implementation of RFC-5 (Transformations). While RFC-5 provides the mathematical framework for coordinate transforms, RFC-4 provides the necessary biological context. | ||
|
|
||
| * **Semantic Labeling:** RFC-5 allows us to define a transformation to a Common Coordinate Framework. We envisage that through explicit labels provided by RFC-4, a registration tool might programmatically determine if it needs to apply a flip or rotation to align with an atlas, etc. | ||
| * This might be outside the scope of this RFC, but establishing the relationship between RFC-4 and RFC-5 is important and we would be happy to offer input and collaborate on this in the future. | ||
|
|
||
| ### **Recommendation** | ||
|
|
||
| * Accept, with minor changes | ||
|
|
||
| Explicitly support Subject-Local orientation and expand the vocabulary to include layered-tissue terms. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The current RFC gives the orientation a "type"; for now, the RFC only defines "type":"anatomical". The examples given below are good candidates for additional types with a separate namespace.
In my opinion, the namespacing means that this feedback should not block the acceptance of the RFC as-is; if reasonably complete vocabularies can be provided for other orientation types then they could be added to RFC-4, or if it takes longer/ a more in-depth survey to gather those vocabularies, they can be added in another RFC or via some (yet-to-be-proposed) extension mechanism.