ohif-viewer/platform/docs/docs
Joe Boccanfuso 5670a4d8d1
feat(PanelService): Left or right side panel to auto start as closed but auto open when needed (#3212)
* feat(SidePanel)
OHIF issue #3135
- Added a method to set a callback for a Panel to invoke when it is ready
to be shown (e.g. its data is loaded).
- Implemented such methods for both the segmentation and measurement panels.
- The SidePanel component now adds a callback to Panel components so that
it will automatically open a Panel that was initially closed and yet to
be opened.
- Updated the OHIF documentation accordingly.

* PR feedback
- added a PanelService that centralized much of the logic that existed in panel PanelModule
- the SidePanel subscribes to PanelService.EVENTS.ACTIVATE_PANEL for each of its child panels

* Removed the PanelMeasurementTableTracking setMeasurementPanelContentReadyCallback method.

* Made the forceActive flag in the PanelService optional and defaulted it to false.

* Fixed failing top level exports unit test.

* - PanelService subscriptions are now per panel (id) so subscribers do not
necessarily need to check the panel id in the event when it is fired
- PanelService activate panel trigger subscriptions are now returned
so that they can be (better) managed outside of the service
- updated/created the various documentation for panels and PanelService

* Clarified various documentation.
Moved the code to add the activate panel triggers out of the extensions
and into the longitudinal mode.

* Removed the openWhenPanelActivated flag.
PanelService now conforms to extending PubSubService like the other services.
Updated various documentation.

* Fixed failing e2e, mpr test.

* Renamed the ActivatePanelTriggers type properties.
The ExtensionManager now sets the id of various modules as a property on each of those modules.
2023-03-09 22:30:09 -05:00
..
assets feat(customizableOverlay): Add customizable overlay info (#3061) 2023-03-09 17:12:08 -05:00
configuration feat: use wadors instead of streaming wadors for volume loading (#3109) 2023-01-11 07:19:27 -05:00
deployment feat(imageLoader):Add an nth image loader strategy (#10) (#3044) 2022-12-29 11:00:13 -05:00
development cli: pass npm_token for private repos (#2987) 2022-10-18 22:01:35 -04:00
platform feat(PanelService): Left or right side panel to auto start as closed but auto open when needed (#3212) 2023-03-09 22:30:09 -05:00
user-guide feat(Calibration Tool): add a calibration tool that can manually recalibrate an image and measurements on it (#3136) 2023-02-22 21:01:36 -05:00
faq.md fix: fixing errors in documentation (#2728) 2022-03-03 11:28:07 -05:00
README.md feat: cornerstone3D stack and volume viewports (#2787) 2022-07-27 12:39:04 -04:00
release-notes.md feat: new Total Metabolic Tumor Volume tmtv (#2866) 2022-08-17 15:13:59 -04:00
resources.md feat: new Total Metabolic Tumor Volume tmtv (#2866) 2022-08-17 15:13:59 -04:00

id slug sidebar_position
Introduction / 1

The Open Health Imaging Foundation (OHIF) Viewer is an open source, web-based, medical imaging platform. It aims to provide a core framework for building complex imaging applications.

Key features:

  • Designed to load large radiology studies as quickly as possible. Retrieves metadata ahead of time and streams in imaging pixel data as needed.
  • Leverages Cornerstone3D for decoding, rendering, and annotating medical images.
  • Works out-of-the-box with Image Archives that support DICOMWeb. Offers a Data Source API for communicating with archives over proprietary API formats.
  • Provides a plugin framework for creating task-based workflow modes which can re-use core functionality.
  • Beautiful user interface (UI) designed with extensibility in mind. UI components available in a reusable component library built with React.js and Tailwind CSS

OHIF Viewer Screenshot

Where to next?

The Open Health Imaging Foundation intends to provide an imaging viewer framework which can be easily extended for specific uses. If you find yourself unable to extend the viewer for your purposes, please reach out via our GitHub issues. We are actively seeking feedback on ways to improve our integration and extension points.

Check out these helpful links:

Citing OHIF

To cite the OHIF Viewer in an academic publication, please cite

Open Health Imaging Foundation Viewer: An Extensible Open-Source Framework for Building Web-Based Imaging Applications to Support Cancer Research

Erik Ziegler, Trinity Urban, Danny Brown, James Petts, Steve D. Pieper, Rob Lewis, Chris Hafey, and Gordon J. Harris JCO Clinical Cancer Informatics, no. 4 (2020), 336-345, DOI: 10.1200/CCI.19.00131

This article is freely available on Pubmed Central: https://www.ncbi.nlm.nih.gov/pmc/articles/PMC7259879/

or, for Lesion Tracker of OHIF v1, please cite:

LesionTracker: Extensible Open-Source Zero-Footprint Web Viewer for Cancer Imaging Research and Clinical Trials

Trinity Urban, Erik Ziegler, Rob Lewis, Chris Hafey, Cheryl Sadow, Annick D. Van den Abbeele and Gordon J. Harris Cancer Research, November 1 2017 (77) (21) e119-e122 DOI: 10.1158/0008-5472.CAN-17-0334

This article is freely available on Pubmed Central. https://pubmed.ncbi.nlm.nih.gov/29092955/

Note: If you use or find this repository helpful, please take the time to star this repository on Github. This is an easy way for us to assess adoption, and it can help us obtain future funding for the project.

License

MIT © OHIF