Viewers

<!-- prettier-ignore-start --> <div align="center"> <h1>OHIF Medical Imaging Viewer</h1> <p><strong>The OHIF Viewer</strong> is a zero-footprint medical image viewer provided by the <a href="https://ohif.org/">Open Health Imaging Foundation (OHIF)</a>. It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support <a href="https://www.dicomstandard.org/using/dicomweb/">DICOMweb</a>.</p> </div> <div align="center"> <a href="https://docs.ohif.org/"><strong>Read The Docs</strong></a> </div> <div align="center"> <a href="https://viewer.ohif.org/">Live Demo</a> | <a href="https://ui.ohif.org/">Component Library</a> </div> <div align="center"> 📰 <a href="https://ohif.org/news/"><strong>Join OHIF Newsletter</strong></a> 📰 </div> <div align="center"> 📰 <a href="https://ohif.org/news/"><strong>Join OHIF Newsletter</strong></a> 📰 </div> <hr />

[![NPM version][npm-version-image]][npm-url] [![MIT License][license-image]][license-url] ![This project is using Percy.io for visual regression testing.][percy-image]

<!-- [![NPM downloads][npm-downloads-image]][npm-url] --> <!-- [![Pulls][docker-pulls-img]][docker-image-url] --> <!-- [](https://app.fossa.io/projects/git%2Bgithub.com%2FOHIF%2FViewers?ref=badge_shield) --> <!-- [![Netlify Status][netlify-image]][netlify-url] --> <!-- [![CircleCI][circleci-image]][circleci-url] --> <!-- [![codecov][codecov-image]][codecov-url] --> <!-- [](#contributors) --> <!-- prettier-ignore-end -->

| | | | | :-: | :--- | :--- | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-measurements.webp?raw=true" alt="Measurement tracking" width="350"/> | Measurement Tracking | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-segmentation.webp?raw=true" alt="Segmentations" width="350"/> | Labelmap Segmentations | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-ptct.webp?raw=true" alt="Hanging Protocols" width="350"/> | Fusion and Custom Hanging protocols | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-volume-rendering.webp?raw=true" alt="Volume Rendering" width="350"/> | Volume Rendering | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-pdf.webp?raw=true" alt="PDF" width="350"/> | PDF | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-rtstruct.webp?raw=true" alt="RTSTRUCT" width="350"/> | RT STRUCT | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-4d.webp?raw=true" alt="4D" width="350"/> | 4D | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-video.webp?raw=true" alt="VIDEO" width="350"/> | Video | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/microscopy.webp?raw=true" alt="microscopy" width="350"/> | Slide Microscopy | Demo | | <img src="https://github.com/OHIF/Viewers/blob/master/platform/docs/docs/assets/img/demo-ecg.webp?raw=true" alt="ECG" width="350"/> | ECG Waveform | Demo |

About

The OHIF Viewer can retrieve and load images from most sources and formats, render sets in 2D, 3D, and reconstructed representations; allows for the manipulation, annotation, and serialization of observations; supports internationalization, OpenID Connect, offline use, hotkeys, and many more features.

Almost everything offers some degree of customization and configuration. If it doesn't support something you need, we accept pull requests and have an ever improving Extension System.

Why Choose Us

Community & Experience

The OHIF Viewer is a collaborative effort that has served as the basis for many active, production, and FDA Cleared medical imaging viewers. It benefits from our extensive community's collective experience, and from the sponsored contributions of individuals, research groups, and commercial organizations.

Built to Adapt

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 the varying workflow and configuration needs of its many users. All of the Viewer's core features are built using its own extension system. The same extensibility that 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 add any new functionality you may need (and wish to maintain privately without forking).

Support

• Report a Bug 🐛
• Request a Feature 🚀
• Ask a Question 🤗
• Slack Channel

For commercial support, academic collaborations, and answers to common questions; please use Get Support to contact us.

Developing

Branches

master branch - The latest dev (beta) release

• 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

release/* branches - The latest stable releases

Once the master 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 from master. These branches represent the latest stable version considered ready for production.

For example, release/3.5 is the branch for version 3.5.0, and release/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 the release/3.5 branch.

Each package is tagged with version numbers and published to npm, such as @ohif/ui@3.5.0. Note that master is always ahead of the release branch. We publish docker builds for both beta and stable releases.

Here is a schematic representation of our development workflow:

Requirements

• Yarn 1.20.0+
• Node 18+
• Yarn Workspaces should be enabled on your machine:
  • yarn config set workspaces-experimental true

Getting Started

1. [Fork this repository][how-to-fork]
2. [Clone your forked repository][how-to-clone]
   • git clone https://github.com/YOUR-USERNAME/Viewers.git
3. Navigate to the cloned project's directory
4. Add this repo as a remote named upstream
   • git remote add upstream https://github.com/OHIF/Viewers.git
5. yarn install --frozen-lockfile to restore dependencies and link projects

:::danger In general run yarn install with the --frozen-lockfile flag to help avoid supply chain attacks by enforcing reproducible dependencies. That is, if the yarn.lock file is clean and does NOT reference compromised packages, then no compromised packages should land on your machine by using this flag. :::

To Develop

From this repository's root directory:

# Enable Yarn Workspaces
yarn config set workspaces-experimental true

# Restore dependencies
yarn install --frozen-lockfile

Cornerstone3D Integration Testing

OHIF's Playwright end-to-end tests can run against a CS3D branch or a published CS3D version, allowing changes that span both repositories to be validated together before merging.

Setting