- Notifications
You must be signed in to change notification settings - Fork3.6k
OHIF zero-footprint DICOM viewer and oncology specific Lesion Tracker, plus shared extension packages
License
OHIF/Viewers
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
The OHIF Viewer is a zero-footprint medical image viewerprovided by theOpen Health Imaging Foundation (OHIF). It is a configurable and extensible progressive web application with out-of-the-box support for image archives which supportDICOMweb.
![]() | Measurement Tracking | Demo |
![]() | Labelmap Segmentations | Demo |
![]() | Fusion and Custom Hanging protocols | Demo |
![]() | Volume Rendering | Demo |
![]() | Demo | |
![]() | RT STRUCT | Demo |
![]() | 4D | Demo |
![]() | Video | Demo |
![]() | Slide Microscopy | Demo |
The OHIF Viewer can retrieveand load images from most sources and formats; render sets in 2D, 3D, andreconstructed representations; allows for the manipulation, annotation, andserialization of observations; supports internationalization, OpenID Connect,offline use, hotkeys, and many more features.
Almost everything offers some degree of customization and configuration. If itdoesn't support something you need, we accept pull requests and have an everimproving Extension System.
The OHIF Viewer is a collaborative effort that has served as the basis for manyactive, production, and FDA Cleared medical imaging viewers. It benefits fromour extensive community's collective experience, and from the sponsoredcontributions of individuals, research groups, and commercial organizations.
After more than 8-years of integrating with many companies and organizations,The OHIF Viewer has been rebuilt from the ground up to better address thevarying workflow and configuration needs of its many users. All of the Viewer'score features are built using it's own extension system. The same extensibilitythat allows us to offer:
- 2D and 3D medical image viewing
- Multiplanar Reconstruction (MPR)
- Maximum Intensity Project (MIP)
- Whole slide microscopy viewing
- PDF and Dicom Structured Report rendering
- Segmentation rendering as labelmaps and contours
- User Access Control (UAC)
- Context specific toolbar and side panel content
- and many others
Can be leveraged by you to customize the viewer for your workflow, and to addany new functionality you may need (and wish to maintain privately withoutforking).
For commercial support, academic collaborations, and answers to commonquestions; please useGet Support to contactus.
master
- The latest dev release
This is typically where the latest development happens. Code that is in the master branch has passed code reviews and automated tests, but it may not be deemed ready for production. This branch usually contains the most recent changes and features being worked on by the development team. It's often the starting point for creating feature branches (where new features are developed) and hotfix branches (for urgent fixes).
Each package is tagged with beta version numbers, and published to npm such as@ohif/ui@3.6.0-beta.1
Once themaster
branch code reaches a stable, release-ready state, we conduct a comprehensive code review and QA testing. Upon approval, we create a new release branch frommaster
. These branches represent the latest stable version considered ready for production.
For example,release/3.5
is the branch for version 3.5.0, andrelease/3.6
is for version 3.6.0. After each release, we wait a few days to ensure no critical bugs. If any are found, we fix them in the release branch and create a new release with a minor version bump, e.g., 3.5.1 in therelease/3.5
branch.
Each package is tagged with version numbers and published to npm, such as@ohif/ui@3.5.0
. Note thatmaster
is always ahead of therelease
branch. We publish docker builds for both beta and stable releases.
Here is a schematic representation of our development workflow:
- Yarn 1.20.0+
- Node 18+
- Yarn Workspaces should be enabled on your machine:
yarn config set workspaces-experimental true
- Fork this repository
- Clone your forked repository
git clone https://github.com/YOUR-USERNAME/Viewers.git
- Navigate to the cloned project's directory
- Add this repo as a
remote
namedupstream
git remote add upstream https://github.com/OHIF/Viewers.git
yarn install
to restore dependencies and link projects
From this repository's root directory:
# Enable Yarn Workspacesyarn configset workspaces-experimentaltrue# Restore dependenciesyarn install
These commands are available from the root directory. Each project directoryalso supports a number of commands that can be found in their respectiveREADME.md
andpackage.json
files.
Yarn Commands | Description |
---|---|
Develop | |
dev | Default development experience for Viewer |
dev:fast | Our experimental fast dev mode that uses rsbuild instead of webpack |
test:unit | Jest multi-project test runner; overall coverage |
Deploy | |
build * | Builds production output for our PWA Viewer |
* - For more information on different builds, check out ourDeployDocs
The OHIF Medical Image Viewing Platform is maintained as amonorepo
. This means that this repository, instead of containing asingle project, contains many projects. If you explore our project structure,you'll see the following:
.├── extensions#│ ├── _example# Skeleton of example extension│ ├── default# basic set of useful functionalities (datasources, panels, etc)│ ├── cornerstone# image rendering and tools w/ Cornerstone3D│ ├── cornerstone-dicom-sr# DICOM Structured Report rendering and export│ ├── cornerstone-dicom-sr# DICOM Structured Report rendering and export│ ├── cornerstone-dicom-seg# DICOM Segmentation rendering and export│ ├── cornerstone-dicom-rt# DICOM RTSTRUCT rendering│ ├── cornerstone-microscopy# Whole Slide Microscopy rendering│ ├── dicom-pdf# PDF rendering│ ├── dicom-video# DICOM RESTful Services│ ├── measurement-tracking# Longitudinal measurement tracking│ ├── tmtv# Total Metabolic Tumor Volume (TMTV) calculation|│├── modes#│ ├── _example# Skeleton of example mode│ ├── basic-dev-mode# Basic development mode│ ├── longitudinal# Longitudinal mode (measurement tracking)│ ├── tmtv# Total Metabolic Tumor Volume (TMTV) calculation mode│ └── microscopy# Whole Slide Microscopy mode│├── platform#│ ├── core# Business Logic│ ├── i18n# Internationalization Support│ ├── ui# React component library│ ├── docs# Documentation│ └── viewer# Connects platform and extension projects│├── ...# misc. shared configuration├── lerna.json# MonoRepo (Lerna) settings├── package.json# Shared devDependencies and commands└── README.md# This file
To acknowledge the OHIF Viewer in an academic publication, please cite
Open Health Imaging Foundation Viewer: An Extensible Open-Source Frameworkfor Building Web-Based Imaging Applications to Support Cancer Research
Erik Ziegler, Trinity Urban, Danny Brown, James Petts, Steve D. Pieper, RobLewis, Chris Hafey, and Gordon J. Harris
JCO Clinical Cancer Informatics, no. 4 (2020), 336-345, DOI:10.1200/CCI.19.00131
Open-Access on Pubmed Central:https://www.ncbi.nlm.nih.gov/pmc/articles/PMC7259879/
or, for v1, please cite:
LesionTracker: Extensible Open-Source Zero-Footprint Web Viewer for CancerImaging 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
Note: If you use or find this repository helpful, please take the time tostar this repository on GitHub. This is an easy way for us to assess adoptionand it can help us obtain future funding for the project.
This work is supported primarily by the National Institutes of Health, NationalCancer Institute, Informatics Technology for Cancer Research (ITCR) program,under agrant to Dr. Gordon Harris at Massachusetts General Hospital (U24 CA199460).
NCI Imaging Data Commons (IDC) project supported the development of new features and bug fixes marked with"IDC:priority","IDC:candidate" or"IDC:collaboration". NCI Imaging Data Commons is supported by contract number 19X037Q fromLeidos Biomedical Research under Task Order HHSN26100071 from NCI.IDC Viewer is a customized version of the OHIF Viewer.
This project is tested with BrowserStack. Thank you for supporting open-source!
MIT ©OHIF
About
OHIF zero-footprint DICOM viewer and oncology specific Lesion Tracker, plus shared extension packages