2019-04-25 21:12:10 +02:00
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< div align = "center" >
2019-08-13 21:36:46 +02:00
< h1 > OHIF Medical Imaging Viewer< / h1 >
2023-03-28 17:18:33 +02:00
< 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/dicomweb/" > DICOMweb< / a > .< / p >
2019-04-25 21:12:10 +02:00
< / div >
2019-04-25 20:01:35 +02:00
< div align = "center" >
2023-06-06 19:34:26 +02:00
< a href = "https://docs.ohif.org/" > < strong > Read The Docs< / strong > < / a >
2019-04-25 20:01:35 +02:00
< / div >
2019-05-22 20:52:26 +02:00
< div align = "center" >
2019-09-04 16:55:54 +02:00
< a href = "https://viewer.ohif.org/" > Live Demo< / a > |
2023-06-06 19:34:26 +02:00
< a href = "https://ui.ohif.org/" > Component Library< / a >
2019-05-22 20:52:26 +02:00
< / div >
2023-06-06 19:34:26 +02:00
< div align = "center" >
📰 < a href = "https://ohif.org/news/" > < strong > Join OHIF Newsletter< / strong > < / a > 📰
< / div >
2019-04-25 20:01:35 +02:00
< hr / >
2019-04-25 20:59:59 +02:00
[![NPM version][npm-version-image]][npm-url]
[![MIT License][license-image]][license-url]
2019-10-16 17:51:45 +02:00
[![This project is using Percy.io for visual regression testing.][percy-image]](percy-url)
2023-06-07 03:47:51 +02:00
<!-- [![NPM downloads][npm - downloads - image]][npm - url] -->
<!-- [![Pulls][docker - pulls - img]][docker - image - url] -->
2023-06-06 19:34:26 +02:00
<!-- [](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) -->
2019-09-04 22:22:40 +02:00
<!-- prettier - ignore - end -->
2019-04-25 20:01:19 +02:00
2023-06-07 03:47:51 +02:00
2019-09-05 04:08:03 +02:00
## About
2019-04-25 21:31:01 +02:00
2019-09-04 22:22:40 +02:00
The OHIF Medical Imaging Viewer is for viewing medical images. It 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.
2019-04-25 21:00:48 +02:00
2019-09-04 22:22:40 +02:00
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.
2019-04-25 21:00:48 +02:00
2019-08-13 21:36:46 +02:00
## Why Choose Us
2019-04-25 21:00:48 +02:00
2019-08-13 21:36:46 +02:00
### Community & Experience
2019-04-25 21:00:48 +02:00
2019-09-04 22:22:40 +02:00
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.
2019-04-25 21:00:48 +02:00
2019-08-13 21:36:46 +02:00
### Built to Adapt
2019-04-25 21:00:48 +02:00
2023-06-06 19:34:26 +02:00
After more than 8-years of integrating with many companies and organizations,
2019-09-04 22:22:40 +02:00
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 it's 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
2023-06-06 19:34:26 +02:00
- Segmentation rendering as labelmaps and contours
2019-09-04 22:22:40 +02:00
- 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).
2019-04-25 21:00:48 +02:00
2019-08-13 21:36:46 +02:00
### Support
2019-04-25 21:31:01 +02:00
2019-09-04 22:22:40 +02:00
We offer support through
[GitHub Issues ](https://github.com/OHIF/Viewers/issues/new/choose ). You can:
2023-06-06 19:34:26 +02:00
- [Report a Bug 🐛 ](https://github.com/OHIF/Viewers/issues/new?assignees=&labels=Community%3A+Report+%3Abug%3A%2CAwaiting+Reproduction&projects=&template=bug-report.yml&title=%5BBug%5D+ )
- [Request a Feature 🚀 ](https://github.com/OHIF/Viewers/issues/new?assignees=&labels=Community%3A+Request+%3Ahand%3A&projects=&template=feature-request.yml&title=%5BFeature+Request%5D+ )
- [Ask a Question 🤗 ](community.ohif.org )
- [Slack Channel ](https://join.slack.com/t/cornerstonejs/shared_invite/zt-1r8xb2zau-dOxlD6jit3TN0Uwf928w9Q )
2019-09-04 22:22:40 +02:00
2021-08-24 14:13:54 +02:00
For commercial support, academic collaborations, and answers to common
2019-09-04 22:22:40 +02:00
questions; please read our
2019-12-07 06:12:08 +01:00
[documented FAQ ](https://docs.ohif.org/faq/index.html#does-ohif-offer-commercial-support ).
2019-04-25 21:31:01 +02:00
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
## Developing
2019-06-22 16:02:07 +02:00
2023-06-07 03:47:51 +02:00
### 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` branch - The latest stable release
This branch represents the latest stable version of the project that is considered ready for production. The code in this branch should be fully tested and vetted for release. Once the code in the master branch reaches a state where it's stable and ready to be released to users,
we do a comprehensive code review and QA testing. Once the code is approved,
we merge it into the release branch and tag a new release.
Each package is tagged with version numbers, and published to npm such as `@ohif/ui@3.5.0`
Note: `master` is always ahead of `release` branch. We publish both docker builds for beta and stable releases.
Here is a schematic representation of our development workflow:
2019-08-13 21:36:46 +02:00
### Requirements
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
- [Yarn 1.17.3+ ](https://yarnpkg.com/en/docs/install )
2023-06-06 19:34:26 +02:00
- [Node 16+ ](https://nodejs.org/en/ )
2019-08-13 21:36:46 +02:00
- Yarn Workspaces should be enabled on your machine:
- `yarn config set workspaces-experimental true`
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
### Getting Started
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
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` to restore dependencies and link projects
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
#### To Develop
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
_From this repository's root directory:_
2019-06-22 16:02:07 +02:00
2019-08-13 21:36:46 +02:00
```bash
# Enable Yarn Workspaces
yarn config set workspaces-experimental true
2019-07-01 12:01:18 +02:00
2019-08-13 21:36:46 +02:00
# Restore dependencies
yarn install
2019-06-22 16:02:07 +02:00
```
2019-08-13 21:36:46 +02:00
## Commands
2019-09-04 22:22:40 +02:00
These commands are available from the root directory. Each project directory
also supports a number of commands that can be found in their respective
`README.md` and `project.json` files.
2019-08-13 21:36:46 +02:00
2019-09-04 22:22:40 +02:00
| Yarn Commands | Description |
| ---------------------------- | ------------------------------------------------------------- |
| **Develop** | |
| `dev` or `start` | Default development experience for Viewer |
| `test:unit` | Jest multi-project test runner; overall coverage |
| **Deploy** | |
2021-08-24 14:13:54 +02:00
| `build` \* | Builds production output for our PWA Viewer | |
2019-08-13 21:36:46 +02:00
2019-09-04 22:22:40 +02:00
\* - For more information on our different builds, check out our [Deploy
Docs][deployment-docs]
2019-08-13 21:36:46 +02:00
2023-06-06 19:34:26 +02:00
## Project
2019-08-13 21:36:46 +02:00
The OHIF Medical Image Viewing Platform is maintained as a
[`monorepo`][monorepo]. This means that this repository, instead of containing a
single project, contains many projects. If you explore our project structure,
you'll see the following:
```bash
.
2021-03-01 16:52:54 +01:00
├── extensions #
│ ├── _example # Skeleton of example extension
2023-06-06 19:34:26 +02:00
│ ├── 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
|
2019-08-13 21:36:46 +02:00
│
2021-03-01 16:52:54 +01:00
├── modes #
│ ├── _example # Skeleton of example mode
2022-07-27 18:39:04 +02:00
│ ├── basic-dev-mode # Basic development mode
2023-06-06 19:34:26 +02:00
│ ├── longitudinal # Longitudinal mode (measurement tracking)
│ ├── tmtv # Total Metabolic Tumor Volume (TMTV) calculation mode
│ └── microscopy # Whole Slide Microscopy mode
2019-08-13 21:36:46 +02:00
│
2021-03-01 16:52:54 +01:00
├── platform #
│ ├── core # Business Logic
│ ├── i18n # Internationalization Support
│ ├── ui # React component library
2023-06-06 19:34:26 +02:00
│ ├── docs # Documentation
2021-03-01 16:52:54 +01:00
│ └── viewer # Connects platform and extension projects
│
├── ... # misc. shared configuration
├── lerna.json # MonoRepo (Lerna) settings
├── package.json # Shared devDependencies and commands
└── README.md # This file
2019-04-25 21:00:29 +02:00
```
2019-08-13 21:36:46 +02:00
Want to better understand why and how we've structured this repository? Read
more about it in our [Architecture Documentation][ohif-architecture].
2019-04-25 21:00:17 +02:00
2021-08-24 14:13:54 +02:00
| Name | Description | Links |
| ---------------------------------------------------- | ----------------------------------------------------- | ---------------------- |
| [@ohif/extension-cornerstone][extension-cornerstone] | 2D image viewing, annotation, and segementation tools | [NPM][cornerstone-npm] |
2019-04-25 21:00:17 +02:00
2019-05-17 16:16:22 +02:00
## Acknowledgments
To acknowledge the OHIF Viewer in an academic publication, please cite
2021-08-24 14:13:54 +02:00
> _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](https://www.doi.org/10.1200/CCI.19.00131)
>
> Open-Access on Pubmed Central:
> https://www.ncbi.nlm.nih.gov/pmc/articles/PMC7259879/
or, for v1, please cite:
2019-05-20 17:31:05 +02:00
> _LesionTracker: Extensible Open-Source Zero-Footprint Web Viewer for Cancer
> Imaging Research and Clinical Trials_
2019-05-17 16:16:22 +02:00
>
2019-05-20 17:31:05 +02:00
> Trinity Urban, Erik Ziegler, Rob Lewis, Chris Hafey, Cheryl Sadow, Annick D.
> Van den Abbeele and Gordon J. Harris
2019-05-17 16:16:22 +02:00
>
2019-05-20 17:31:05 +02:00
> _Cancer Research_, November 1 2017 (77) (21) e119-e122 DOI:
> [10.1158/0008-5472.CAN-17-0334](https://www.doi.org/10.1158/0008-5472.CAN-17-0334)
2019-05-17 16:16:22 +02:00
2019-05-20 17:31:05 +02:00
**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.
2019-05-17 16:16:22 +02:00
2019-05-20 17:31:05 +02:00
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) ](https://projectreporter.nih.gov/project_info_description.cfm?aid=8971104 ).
2019-05-17 16:16:22 +02:00
2023-02-22 18:15:30 +01:00
This project is tested with BrowserStack. Thank you for supporting open source
2019-08-13 21:36:46 +02:00
## License
MIT © [OHIF ](https://github.com/OHIF )
2019-04-25 21:00:17 +02:00
<!--
2019-08-13 21:36:46 +02:00
Links
-->
2019-04-25 21:00:17 +02:00
2019-04-25 20:59:59 +02:00
<!-- prettier - ignore - start -->
2019-08-13 21:36:46 +02:00
<!-- Badges -->
[lerna-image]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
[lerna-url]: https://lerna.js.org/
2019-12-10 14:57:03 +01:00
[netlify-image]: https://api.netlify.com/api/v1/badges/32708787-c9b0-4634-b50f-7ca41952da77/deploy-status
[netlify-url]: https://app.netlify.com/sites/ohif-dev/deploys
2019-04-25 20:59:59 +02:00
[all-contributors-image]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
[circleci-image]: https://circleci.com/gh/OHIF/Viewers.svg?style=svg
[circleci-url]: https://circleci.com/gh/OHIF/Viewers
2019-09-04 22:22:40 +02:00
[codecov-image]: https://codecov.io/gh/OHIF/Viewers/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/OHIF/Viewers/branch/master
2019-04-25 20:59:59 +02:00
[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
[prettier-url]: https://github.com/prettier/prettier
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
<!-- ROW -->
2023-06-06 19:34:26 +02:00
[npm-url]: https://npmjs.org/package/@ohif/app
[npm-downloads-image]: https://img.shields.io/npm/dm/@ohif/app.svg?style=flat-square
[npm-version-image]: https://img.shields.io/npm/v/@ohif/app.svg?style=flat-square
2019-05-21 21:11:35 +02:00
[docker-pulls-img]: https://img.shields.io/docker/pulls/ohif/viewer.svg?style=flat-square
2023-06-07 03:47:51 +02:00
[docker-image-url]: https://hub.docker.com/r/ohif/app
2019-04-25 20:59:59 +02:00
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license-url]: LICENSE
2019-10-16 17:51:45 +02:00
[percy-image]: https://percy.io/static/images/percy-badge.svg
[percy-url]: https://percy.io/Open-Health-Imaging-Foundation/OHIF-Viewer
2019-08-13 21:36:46 +02:00
<!-- Links -->
[monorepo]: https://en.wikipedia.org/wiki/Monorepo
[how-to-fork]: https://help.github.com/en/articles/fork-a-repo
[how-to-clone]: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
2019-12-07 03:57:35 +01:00
[ohif-architecture]: https://docs.ohif.org/architecture/index.html
[ohif-extensions]: https://docs.ohif.org/architecture/index.html
2019-08-13 21:36:46 +02:00
[deployment-docs]: https://docs.ohif.org/deployment/
2019-04-25 21:01:18 +02:00
[react-url]: https://reactjs.org/
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
2023-06-06 19:34:26 +02:00
[ohif-viewer-url]: https://www.npmjs.com/package/@ohif/app
2019-12-07 06:12:08 +01:00
[configuration-url]: https://docs.ohif.org/configuring/
2019-12-07 03:57:35 +01:00
[extensions-url]: https://docs.ohif.org/extensions/
2019-08-13 21:36:46 +02:00
<!-- Platform -->
[platform-core]: platform/core/README.md
2019-09-05 03:54:29 +02:00
[core-npm]: https://www.npmjs.com/package/@ohif/core
2019-08-13 21:36:46 +02:00
[platform-i18n]: platform/i18n/README.md
2019-09-05 03:54:29 +02:00
[i18n-npm]: https://www.npmjs.com/package/@ohif/i18n
2019-08-13 21:36:46 +02:00
[platform-ui]: platform/ui/README.md
2019-09-05 03:54:29 +02:00
[ui-npm]: https://www.npmjs.com/package/@ohif/ui
2023-06-06 19:34:26 +02:00
[platform-viewer]: platform/app/README.md
[viewer-npm]: https://www.npmjs.com/package/@ohif/app
2019-08-13 21:36:46 +02:00
<!-- Extensions -->
[extension-cornerstone]: extensions/cornerstone/README.md
2019-09-05 03:54:29 +02:00
[cornerstone-npm]: https://www.npmjs.com/package/@ohif/extension-cornerstone
2019-08-13 21:36:46 +02:00
[extension-dicom-html]: extensions/dicom-html/README.md
2019-09-05 03:54:29 +02:00
[html-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-html
2019-08-13 21:36:46 +02:00
[extension-dicom-microscopy]: extensions/dicom-microscopy/README.md
2019-09-05 03:54:29 +02:00
[microscopy-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-microscopy
2019-08-13 21:36:46 +02:00
[extension-dicom-pdf]: extensions/dicom-pdf/README.md
2019-09-05 03:54:29 +02:00
[pdf-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-pdf
2019-08-13 21:36:46 +02:00
[extension-vtk]: extensions/vtk/README.md
2019-09-05 03:54:29 +02:00
[vtk-npm]: https://www.npmjs.com/package/@ohif/extension-vtk
2019-04-25 21:01:18 +02:00
<!-- prettier - ignore - end -->
2019-11-12 03:43:25 +01:00
2019-12-07 03:57:35 +01:00
[](https://app.fossa.io/projects/git%2Bgithub.com%2FOHIF%2FViewers?ref=badge_large)
