Viewers

OHIF Medical Imaging Viewer

The OHIF Viewer is a zero-footprint medical image viewer provided by the Open Health Imaging Foundation (OHIF). It is a configurable and extensible progressive web application with out-of-the-box support for image archives which support DICOMweb.

About

The OHIF Viewer boasts a comprehensive feature set, including:

Image Handling:

1. Retrieval and loading of images from various sources and formats.

2. Rendering image sets in 2D, 3D, and reconstructed representations.

Annotation and Manipulation:

3. Manipulation, annotation, and serialization of observations.

Additional Features:

4. Internationalization support.

5. OpenID Connect integration.

6. Offline usage capabilities.

7. Extensive hotkey support.

The OHIF Viewer offers a high level of customization and configuration. If you require features not yet implemented, the community welcomes pull requests and the Extension System is constantly being improved.

Why Choose OHIF Viewer?

Community & Experience

The OHIF Viewer is a collaborative project that has been instrumental in developing many active, production, and FDA Cleared medical imaging viewers. It benefits from the vast experience of its community and contributions from individuals, research groups, and commercial organizations.

Built to Adapt

After over eight years of integration with various companies and organizations, the OHIF Viewer has been redesigned from the ground up to meet the diverse workflow and configuration needs of its user base. All core features are built using its own extension system. This extensibility allows you to:

1. Customize the viewer for your specific workflow.

2. Add new functionalities as needed.

3. Maintain these customizations privately without forking the repository.

Support

For commercial support, academic collaborations, or answers to common questions, please use the "Get Support" section to contact us.

Developing

Branches

The OHIF Viewer utilizes a branching strategy to manage development and releases:

1. master branch:

Contains the latest development (beta) release.

Features code that has passed code reviews and automated tests.

May not be deemed ready for production.

Represents the most recent changes and features being worked on by the development team.

Serves as the starting point for creating feature branches (for developing new features) and hotfix branches (for urgent fixes).

Each package is tagged with beta version numbers and published to npm (e.g., @ohif/[email protected]).

2. release/* branches:

House the latest stable releases.

Code in these branches has undergone thorough code review and QA testing and is deemed 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, a waiting period is enforced to ensure no critical bugs are found. If any critical bugs arise, they are fixed in the release branch and a new release with a minor version bump is created (e.g., 3.5.1 in the release/3.5 branch).

Each package is tagged with version numbers and published to npm (e.g., @ohif/[email protected]).

The master branch always remains ahead of the release branch.

Docker builds are published for both beta and stable releases.

Schematic Representation of Development Workflow:

[Insert schematic representation of the development workflow, depicting the master branch, release/* branches, and the flow of code between them.]

Requirements

[List the necessary software requirements for developing or using the OHIF Viewer, including operating system, specific programming languages, and any dependencies.]

Getting Started

[Provide a step-by-step guide for new users to set up and start using the OHIF Viewer. Include instructions for installing necessary software, configuring the viewer, and accessing basic features.]

To Develop

From this repository's root directory:

1. Enable Yarn Workspaces:

`bash

yarn config set workspaces-experimental true

`

2. Restore Dependencies:

`bash

yarn install

`

Commands

These commands are available from the root directory. Each project directory also supports various commands outlined in their respective README.md and package.json files.

[List the available commands for developing the OHIF Viewer. Include descriptions for each command and any specific usage notes.]

Project

The OHIF Medical Image Viewing Platform is maintained as a monorepo. This means that this repository contains multiple projects rather than a single one. Exploring the project structure reveals the following:

`

.

├── extensions #

│ ├── _example # Skeleton of example extension

│ ├── default # Basic set of useful functionalities (datasources, panels, etc)

│ ├── cornerstone # Image rendering and tools with Cornerstone3D

│ ├── 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

`

Acknowledgments

To acknowledge 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

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 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

Note: If you use or find this repository helpful, please star it on GitHub. This helps assess adoption and secure future funding for the project.

This work is supported primarily by the National Institutes of Health, National Cancer Institute, Informatics Technology for Cancer Research (ITCR) program, under a grant to Dr. Gordon Harris at Massachusetts General Hospital (U24 CA199460).

The 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 from Leidos 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!

License

MIT © OHIF