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

docs(image loader/metadata provider): Clarify concept + how-to documentation. #1508

Merged
merged 2 commits into from
Oct 25, 2024

Conversation

sgielen
Copy link
Contributor

@sgielen sgielen commented Oct 22, 2024

NOTE: This PR is currently set to merge into the beta branch. We may want to await the merge of beta into main first and then merge this PR into main afterwards?

Context

This PR improves some Custom Image Loader / Metadata Provider related documentation.

The topic of writing a Custom Image Loader based on the existing DICOM Image Loader goes back years, and I've recently taken the time to research and understand the topic a lot better. (See also #1509 for the resulting PR.) These updates to the documentation are a result of that: they represent links between documentation pages that would have made this a lot clear to begin with.

Open points

I'd like to describe the following better in documentation as well, either in this PR or in follow-up.

  • Can Cornerstone display images without ANY metadata being present?
    • It looks like the IImage object has all the absolutely necessary properties, e.g. width/height, window level, pixel spacing, slice thickness. If there is no metadata at all, can Cornerstone still display the image?
    • If we need metadata, should we consider removing elements of the IImage interface, and document that these elements are instead requested via the metadata path?
  • What should a metadata provider do if metadata is requested for an image that has not been loaded yet, and the metadata can only be found inside the image? (e.g. in the case of loading volumes from images)
  • Should metadata still be available for an image even after decache is called on the image loader?

Changes & Results

Documentation only.

Testing

N/A

Checklist

PR

  • My Pull Request title is descriptive, accurate and follows the
    semantic-release format and guidelines.

Code

Public Documentation Updates

  • The documentation page has been updated as necessary for any public API
    additions or removals.

Tested Environment

  • [] "OS:
  • [] "Node version:
  • [] "Browser:

@sgielen sgielen force-pushed the docs/custom-loader-clarifications branch from f2370e2 to 9c8cbc0 Compare October 22, 2024 13:23
Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for cornerstone-3d-docs failed. Why did it fail? →

Name Link
🔨 Latest commit f2370e2
🔍 Latest deploy log https://app.netlify.com/sites/cornerstone-3d-docs/deploys/6717a7655b87b1000786da49

Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for cornerstone-3d-docs failed. Why did it fail? →

Name Link
🔨 Latest commit ba691a6
🔍 Latest deploy log https://app.netlify.com/sites/cornerstone-3d-docs/deploys/6717aea1e0a5790008d11256

Copy link
Member

@sedghi sedghi left a comment

Choose a reason for hiding this comment

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

I love PRs that change files are all *.md ! Thanks

@sedghi sedghi merged commit ca4475f into cornerstonejs:beta Oct 25, 2024
2 of 10 checks passed
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