versioned docs v1, and moved docs v2
No files matched your search
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "I Want to ...",
|
||||
"position": 8
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
# Add a Logo to the Viewer
|
||||
|
||||
The OHIF Framework provides [**ohif-header**](https://github.com/OHIF/Viewers/tree/master/Packages/ohif-header) package to add a header into application layout. **ohif-header** package is designed as a [custom block helper](http://blazejs.org/api/spacebars.html#Custom-Block-Helpers) named **header** to define your own header context.
|
||||
|
||||
If you would like to add SVG logo to header please follow these steps.
|
||||
|
||||
1. Add your SVG logo into public folder.
|
||||
|
||||
2. Add **header** content block which will be located on the top of the application layout into your application's main template. You can also pass some parameters to **header** content block to customize the header.
|
||||
|
||||
* headerClasses: the list of classes which will be applied to header element
|
||||
* brandHref: the url of the logo to link
|
||||
|
||||
|
||||
``` html
|
||||
{{#header headerClasses="header-big bg-blue" brandHref="your logo link"}}
|
||||
...
|
||||
{{/header}}
|
||||
```
|
||||
|
||||
|
||||
1. Create a section called as **brand** in **header** content block and add your logo content which is displayed on the left side of the header as default into section **brand**.
|
||||
|
||||
|
||||
``` html
|
||||
{{#header}}
|
||||
{{#section "brand"}}
|
||||
<!-- Add logo image -->
|
||||
<svg>
|
||||
<use xlink:href="/yourLogo.svg"}}></use>
|
||||
</svg>
|
||||
|
||||
<!-- Add logo text -->
|
||||
<div>Logo Text</div>
|
||||
{{/section}}
|
||||
{{/header}}
|
||||
```
|
||||
|
||||
|
||||
For example, see how it works in [OHIF Viewer](https://github.com/OHIF/Viewers/blob/master/OHIFViewer/client/components/ohifViewer/ohifViewer.html#L2)
|
||||
@@ -1,22 +0,0 @@
|
||||
# Add a Tool to the Viewer
|
||||
|
||||
To add a tool to the Viewer there are a few steps:
|
||||
|
||||
1. Add the tool itself to the repository.
|
||||
|
||||
If you're using something from Cornerstone Tools you can skip this step.
|
||||
|
||||
Some examples of custom tools can be found in the lesion tracker: https://github.com/OHIF/Viewers/tree/master/Packages/ohif-lesiontracker/client/compatibility
|
||||
|
||||
2. Add the toolbar button itself to the array of tools in the Toolbar:
|
||||
https://github.com/OHIF/Viewers/blob/574a6d02b090b8b2f020430c5919f8377b8316c6/OHIFViewer/client/components/toolbarSection/toolbarSection.js
|
||||
|
||||
3. **A:** Add it to the toolManager (if it's a tool, such as length / angle):
|
||||
|
||||
https://github.com/OHIF/Viewers/blob/574a6d02b090b8b2f020430c5919f8377b8316c6/Packages/lesiontracker/client/tools.js#L2
|
||||
|
||||
** --- OR --- **
|
||||
|
||||
**B:** Add it to the functionList if it's a command (e.g. toggle CINE play, or Invert the current viewport):
|
||||
|
||||
https://github.com/OHIF/Viewers/blob/574a6d02b090b8b2f020430c5919f8377b8316c6/OHIFViewer/client/components/viewer/viewer.js#L12
|
||||
@@ -1,59 +0,0 @@
|
||||
# OHIF Standalone Installation Instructions For Windows Server 2016:
|
||||
|
||||
**Note: Turn-Off Windows Defender Realtime protection during this process*
|
||||
|
||||
1. Install Chocolatey
|
||||
|
||||
a. Go to this URL for instructions:
|
||||
|
||||
https://chocolatey.org/install#install-with-cmdexe
|
||||
|
||||
b. Execute this command in the cmd line as Admin:
|
||||
`@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"`
|
||||
|
||||
c. Type `choco -?` to ensure the installation is OK.
|
||||
2. Install Meteor
|
||||
|
||||
a. Type the command: `choco install meteor`
|
||||
3. Install node.js
|
||||
|
||||
a. Download MSI from: https://nodejs.org/en/download/
|
||||
4. Install MongoDB
|
||||
|
||||
a. Download MSI from:
|
||||
https://www.mongodb.com/download-center/community
|
||||
5. Install Git
|
||||
|
||||
a. https://git-scm.com/download/win
|
||||
6. Download the OHIF Viewer repository from GitHub, or use Git to clone it (recommended)
|
||||
|
||||
a. GitHub Repo: https://github.com/OHIF/Viewers
|
||||
|
||||
b. GIT Clone command: `git clone https://github.com/OHIF/Viewers`
|
||||
7. Set the Meteor Packages folder environment variable
|
||||
|
||||
a. Go to Advanced System Settings
|
||||
|
||||
b. Under Advanced, click on the "Environment Variables..." button
|
||||
|
||||
c. Under System Variables, click "New..."
|
||||
|
||||
d. Set the following:
|
||||
|
||||
i. Variable name: METEOR_PACKAGE_DIRS
|
||||
|
||||
ii. Variable Value: {path to the OHIF Viewer Packages Folder}
|
||||
example: C:\OHIF\Viewers\Packages
|
||||
8. Using the command line, navigate/cs to the standalone viewer folder, example: `cd C:\OHIF\Viewers\StandaloneViewer\StandaloneViewer`
|
||||
9. run the command: `meteor npm install`
|
||||
10. Run the command: `meteor`
|
||||
|
||||
a. if you get this error "Error: EPERM: operation not permitted, unlink" Or,
|
||||
|
||||
b. You feel the build is stale for a very long time > 10min with no visual indication, restart the cmd prompt and repeat this step (`meteor`)
|
||||
|
||||
# Troubleshooting:
|
||||
|
||||
1. If you get an error: Error: EPERM: operation not permitted, unlink 'c:\xxxxx'
|
||||
|
||||
a. https://github.com/phoenixframework/phoenix/issues/2464
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Extras",
|
||||
"position": 13
|
||||
}
|
||||
@@ -1,345 +0,0 @@
|
||||
---
|
||||
title: Development Environment Installation
|
||||
---
|
||||
|
||||
**Development Environment Installation (Ubuntu)**
|
||||
|
||||
**CONFIDENTIAL DOCUMENT**
|
||||
|
||||
This is a confidential document and property of Radical Imaging LLC. It shall not be transmitted, copied or sent to anyone without prior authorization.
|
||||
|
||||
**Index**
|
||||
|
||||
[[TOC]]
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>Acronyms and definitions</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Acronym/Definition</td>
|
||||
<td>Meaning</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>Referenced Documents</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Doc No</td>
|
||||
<td>Doc Title</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DOC00001</td>
|
||||
<td>Radical Imaging Official Documents Template</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
# PURPOSE AND OBJECTIVES
|
||||
|
||||
The purpose of this document is to describe the development environment installation of OHIF viewer/Lesion Tracker on Linux Ubuntu.
|
||||
|
||||
# DEVELOPMENT ENVIRONMENT INSTALLATION
|
||||
|
||||
## Docker
|
||||
|
||||
Docker is an open source software platform to create, deploy and manage virtualized application containers on common operating systems, with several allied tools.
|
||||
|
||||
To install Docker, follow the instructions below:
|
||||
|
||||
1. Open a terminal, and update the apt package index, by running the following command:
|
||||
|
||||
sudo apt-get update
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
2. Install packages to allow apt to use a repository over HTTPS, by running the following command:
|
||||
|
||||
sudo apt-get install apt-transport-https ca-certificates curl software-properties-common
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
3. Add Docker’s official GPG key, by running the following command:
|
||||
|
||||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. Verify that you now have the key with the fingerprint **9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88**, by searching for the last 8 characters of the fingerprint after running the following command:
|
||||
|
||||
sudo apt-key fingerprint 0EBFCD88
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
5. Use the following command to set up the stable repository.
|
||||
|
||||
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
6. Install the latest version of Docker CE, by running the following command:
|
||||
|
||||
sudo apt-get install docker-ce
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
7. Verify that Docker CE is installed correctly by running the hello-world image:
|
||||
|
||||
sudo docker run hello-world
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
**Note**: Additional information about Docker installation on Linux Ubuntu OS can be foud at [https://docs.docker.com/install/linux/docker-ce/ubuntu/](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
|
||||
|
||||
## DCM4CHE
|
||||
|
||||
Dcm4che ([https://www.dcm4che.org/](https://www.dcm4che.org/)) is a collection of open source applications and utilities for healthcare.
|
||||
|
||||
To install Dcm4che, follow the instructions below:
|
||||
|
||||
1. Before start, you need to create the following folders on your *Home *directory:
|
||||
|
||||
* DCM4CHEE
|
||||
|
||||
* dcm4chee-arc
|
||||
|
||||
* db
|
||||
|
||||
* ldap
|
||||
|
||||
* slapd.d
|
||||
|
||||
* storage
|
||||
|
||||
* wildfly
|
||||
|
||||
|
||||
|
||||
2. Create the following files on the DCM4CHEE folder, with the correspondent contents:
|
||||
|
||||
docker-compose.env
|
||||
|
||||
```
|
||||
STORAGE_DIR=/storage/fs1
|
||||
POSTGRES_DB=pacsdb
|
||||
POSTGRES_USER=pacs
|
||||
POSTGRES_PASSWORD=pacs
|
||||
```
|
||||
|
||||
|
||||
docker-compose.yml
|
||||
|
||||
```
|
||||
version: "3"
|
||||
services:
|
||||
ldap:
|
||||
image: dcm4che/slapd-dcm4chee:2.4.44-14.1
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "10m"
|
||||
ports:
|
||||
- "389:389"
|
||||
env_file: docker-compose.env
|
||||
volumes:
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- ~/dcm4chee-arc/ldap:/var/lib/ldap
|
||||
- ~/dcm4chee-arc/slapd.d:/etc/ldap/slapd.d
|
||||
db:
|
||||
image: dcm4che/postgres-dcm4chee:10.4-14
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "10m"
|
||||
ports:
|
||||
- "5432:5432"
|
||||
env_file: docker-compose.env
|
||||
volumes:
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- ~/dcm4chee-arc/db:/var/lib/postgresql/data
|
||||
arc:
|
||||
image: dcm4che/dcm4chee-arc-psql:5.14.1
|
||||
logging:
|
||||
driver: json-file
|
||||
options:
|
||||
max-size: "10m"
|
||||
ports:
|
||||
- "8080:8080"
|
||||
- "8443:8443"
|
||||
- "9990:9990"
|
||||
- "11112:11112"
|
||||
- "2575:2575"
|
||||
env_file: docker-compose.env
|
||||
environment:
|
||||
WILDFLY_CHOWN: /opt/wildfly/standalone /storage
|
||||
WILDFLY_WAIT_FOR: ldap:389 db:5432
|
||||
depends_on:
|
||||
- ldap
|
||||
- db
|
||||
volumes:
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- ~/dcm4chee-arc/wildfly:/opt/wildfly/standalone
|
||||
- ~/dcm4chee-arc/storage:/storage</td>
|
||||
```
|
||||
|
||||
Files/Folder will become like the image above:
|
||||
|
||||
<!--  -->
|
||||
|
||||
1. Open a terminal inside DCM4CHE folder, and run the following command:
|
||||
|
||||
sudo snap install docker
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. Still inside the DCM4CHE folder, run the following command:
|
||||
|
||||
sudo docker-compose -p dcm4chee up -d
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
1. The following commands can be used to control DCM4CHE:
|
||||
|
||||
Stop all 3 containers: docker-compose -p dcm4chee stop
|
||||
|
||||
Start all 3 containers again: docker-compose -p dcm4chee start
|
||||
|
||||
Stop and delete all 3 containers: docker-compose -p dcm4chee down
|
||||
|
||||
2. Now it is necessary to import some DICOM studies to DCM4CHE. Before importing these studies, you will need to download them. To do so, access the address [http://34.224.187.57:3000/studylist](http://34.224.187.57:3000/studylist), right click one or more studies, and select the option Export:
|
||||
|
||||
<!--  -->
|
||||
|
||||
3. Confirm the study export on the modal window that will appear:
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. The study(ies) export will begin. You can follow the exporting progress:
|
||||
|
||||
<!--  -->
|
||||
|
||||
5. After the exporting progress, the study(ies) will be downloaded in a file called "studies.zip". Create a folder named “Studies” on your Home folder, and extract this and any other studies you download in this folder:
|
||||
|
||||
<!--  -->
|
||||
|
||||
6. Open the terminal, go to the DCM4CHE folder, and run the following command in order to send the studies to DCM4CHE:
|
||||
|
||||
docker run -v ~/Studies/:/tmp --rm --network=dcm4chee_default dcm4che/dcm4che-tools:5.14.0 storescu -cDCM4CHEE@arc:11112 /tmp
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
7. Now, go to your browser and access the URL [http://localhost:8080/dcm4chee-arc/ui2/](http://localhost:8080/dcm4chee-arc/ui2/). Once opened, click on the refresh icon on the most right:
|
||||
|
||||
<!--  -->
|
||||
|
||||
8. The studies received by DCM4CHE will be shown:
|
||||
|
||||
<!--  -->
|
||||
|
||||
9. Open the terminal, go to your Home folder, and run the following command in order to clone viewers repository to your local:
|
||||
|
||||
git clone https://github.com/OHIF/Viewers.git
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
10. Then, enter the Viewers folder, and run the following command in order to make sure that you are in master branch:
|
||||
|
||||
git checkout master
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
11. Now go to OHIFViewer folder and run the following command:
|
||||
|
||||
meteor npm install
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
12. Still on the OHIFViewer folder, run the following command:
|
||||
|
||||
./bin/dcm4cheeDICOMWeb.sh
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
13. Now, go to your browser and access the URL [http://localhost:3000](http://localhost:3000). Once opened, change the Study Date filter to start on the year 2000:
|
||||
|
||||
<!--  -->
|
||||
|
||||
14. The imported studies will be show. Double click a study to open it:
|
||||
|
||||
<!--  -->
|
||||
|
||||
## Meteor
|
||||
|
||||
Meteor is a JavaScript web framework that allows for rapid prototyping and produces cross-platform code.
|
||||
|
||||
To install Meteor, follow the instructions below:
|
||||
|
||||
**_Remark_***: This guide covers the Linux Ubuntu version. Installation instructions can be different on other operating systems.*
|
||||
|
||||
1. Open a terminal, and run the following command:
|
||||
|
||||
curl https://install.meteor.com/ | sh
|
||||
|
||||
Expected result:
|
||||
|
||||
<!--  -->
|
||||
|
||||
## Starting OHIF Viewer after system restart
|
||||
|
||||
These are the steps to run OHIFVIewer after system restart:.
|
||||
|
||||
1. Open terminal
|
||||
|
||||
2. Access the DCM4CHEE folder, on your Home folder
|
||||
|
||||
3. Run the following command in order to start docker containers:
|
||||
|
||||
docker-compose -p dcm4chee start
|
||||
|
||||
4. Access the Viewers/OHIFViewer folder, on your Home folder
|
||||
|
||||
5. Run the following command in order to run OHIF Viewer:
|
||||
|
||||
./bin/dcm4cheeDICOMWeb.sh
|
||||
|
||||
6. Access the address [http://localhost:3000](http://localhost:3000)
|
||||
@@ -1,96 +0,0 @@
|
||||
---
|
||||
title: Standalone Viewer
|
||||
---
|
||||
|
||||
# Standalone Viewer
|
||||
|
||||
## Quick Start
|
||||
|
||||
Install dependencies:
|
||||
|
||||
```bash
|
||||
meteor npm install
|
||||
```
|
||||
|
||||
Run the application:
|
||||
|
||||
```bash
|
||||
METEOR_PACKAGE_DIRS="../../Packages" ROOT_URL=http://localhost:3000 meteor
|
||||
```
|
||||
|
||||
Open your web browser and navigate to one of the following URLs to test the standalone viewer application:
|
||||
|
||||
```bash
|
||||
http://localhost:3000/testId
|
||||
```
|
||||
|
||||
Or, to load DICOMs:
|
||||
```bash
|
||||
http://localhost:3000/testDICOMs
|
||||
```
|
||||
|
||||
### To Build for the Client
|
||||
|
||||
It is possible to build this standalone viewer to run as a client-only bundle of HTML, JavaScript, and CSS.
|
||||
|
||||
1. First, install [meteor-build-client-fixed2](https://www.npmjs.com/package/meteor-build-client-fixed2).
|
||||
|
||||
````bash
|
||||
sudo npm install -g meteor-build-client-fixed2
|
||||
````
|
||||
|
||||
2. Next, build the client bundle into an output folder ("myOutputFolder") with a base URL ("localhost:3000"). In production, this would be the URL where the Viewer is available.
|
||||
|
||||
````
|
||||
METEOR_PACKAGE_DIRS="../../Packages" meteor-build-client-fixed2 ../myOutputFolder -u localhost:3000 --legacy
|
||||
````
|
||||
|
||||
3. Test the bundled client-side package locally.
|
||||
|
||||
Note: You will need to have Python installed to run the test server for this case. It is not a typical simple HTTP server. The bundled script redirects all URLs following the base URL to index.html. It will then use the routes defined in your application to handle the URL parameters.
|
||||
|
||||
In our case, this means it will request a JSON file at baseURL/api/[id parameter].
|
||||
|
||||
So if you navigate to http://localhost:3000/sampleJPEG.json the application will retrieve the JSON from http://localhost:3000/api/sampleJPEG.json and use it to populate the viewer. If something appears to be broken, make sure you retrieve a JSON file at the /api URL.
|
||||
|
||||
Create the api folder for your data
|
||||
|
||||
````bash
|
||||
cd myOutputFolder
|
||||
mkdir api
|
||||
````
|
||||
|
||||
Copy your data into the folder
|
||||
|
||||
````bash
|
||||
cp ../etc/sample* api/
|
||||
````
|
||||
|
||||
Run the server
|
||||
|
||||
```` bash
|
||||
python ../etc/redirectingSimpleServer.py
|
||||
````
|
||||
|
||||
Open your web browser and navigate to http://localhost:3000/sampleJPEG.json or http://localhost:3000/sampleDICOM.json
|
||||
|
||||
## Authorization Header
|
||||
|
||||
A ```token``` fragment parameter can be specified. If present this value will be used for http bearer authorization when making requests for the above JSON, and when retrieving images using the Cornerstone Image Loaders.
|
||||
|
||||
Example :
|
||||
|
||||
```
|
||||
http://localhost:3000/sampleDICOM.json#token=1a2b3c4d
|
||||
```
|
||||
|
||||
|
||||
### Testing the Sample client-only build
|
||||
For the sake of simplicity we have also included a pre-built client-only version of the standalone viewer, which can be found in the SampleClientOnlyBuild folder.
|
||||
|
||||
You can test this with:
|
||||
|
||||
```` bash
|
||||
cd SampleClientOnlyBuild
|
||||
python ../etc/redirectingSimpleServer.py
|
||||
````
|
||||
@@ -1,34 +1,60 @@
|
||||
---
|
||||
id: OHIF-v1 Documentation
|
||||
id: OHIF Documentation
|
||||
slug: /
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
##### Looking for your Deploy Preview? - <a onclick="function redirect() { window.location.href='/demo/'; } redirect();">Deploy Preview for Viewer</a>
|
||||
<div class='row'>
|
||||
<div class='column' style='text-align: right; padding: 0 20px'>
|
||||
<strong>Looking for a Live Demo?</strong>
|
||||
<a href="http://viewer.ohif.org/">Preview The OHIF Viewer</a>
|
||||
</div>
|
||||
<div class='column' style='text-align: left; padding: 0 20px'>
|
||||
<a href="https://www.netlify.com">
|
||||
<img src="https://www.netlify.com/img/global/badges/netlify-color-bg.svg"/>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
> ATTENTION! You are looking at the docs for the `React` version of the OHIF
|
||||
> Viewer. If you're looking for the `Meteor` version's documentation (now
|
||||
> deprecated), select it's version from the dropdown box in the top left corner
|
||||
> of this page.
|
||||
|
||||
# Introduction
|
||||
|
||||
The [Open Health Imaging Foundation](https://www.ohif.org) is developing an open source framework for constructing web-based medical imaging applications. The application framework is built using modern HTML / CSS / JavaScript and uses [Cornerstone](https://cornerstonejs.org/) at its core to display and manipulate medical images. It is built with Meteor, a Node.js-based full-stack JavaScript platform.
|
||||
|
||||
This documentation concerns the OHIF framework itself and its three example applications: the OHIF Viewer, Lesion Tracker, and the Standalone Viewer.
|
||||
|
||||
## The **OHIF Viewer**: A general purpose DICOM Viewer ([demo](http://viewer.ohif.org/))
|
||||
The [Open Health Imaging Foundation][ohif-org] (OHIF) Viewer is an open source,
|
||||
web-based, medical imaging viewer. It can be configured to connect to Image
|
||||
Archives that support [DicomWeb][dicom-web], and offers support for mapping to
|
||||
proprietary API formats. OHIF maintained extensions add support for viewing,
|
||||
annotating, and reporting on DICOM images in 2D (slices) and 3D (volumes).
|
||||
|
||||

|
||||
|
||||
The Open Health Imaging Foundation intends to provide a simple general purpose DICOM Viewer which can be easily extended for specific uses. The primary purpose of the OHIF Viewer is to serve as a testing ground for the underlying packages and the [Cornerstone](https://cornerstonejs.org/) family of libraries.
|
||||
<center><i>The <strong>OHIF Viewer</strong>: A general purpose DICOM Viewer (<a href="http://viewer.ohif.org/">Live Demo</a>)</center>
|
||||
|
||||
## **Lesion Tracker**: An oncology-focused imaging application ([demo](http://lesiontracker.ohif.org/))
|
||||
The Open Health Imaging Foundation intends to provide a simple general purpose
|
||||
DICOM Viewer 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][gh-issues]. We are actively seeking feedback on ways to improve
|
||||
our integration and extension points.
|
||||
|
||||

|
||||
## Where to next?
|
||||
|
||||
The Lesion Tracker is designed to facilitate quantitative assessments of tumour burden over time. It is similar in scope to the ePAD Imaging Platform (https://epad.stanford.edu/), developed at Stanford Medicine.
|
||||
Check out these helpful links:
|
||||
|
||||
## Study List & DICOM Connectivity
|
||||

|
||||
- Ready to dive into some code? Check out our
|
||||
[Getting Started Guide](./development/getting-started.md).
|
||||
- We're an active, vibrant community.
|
||||
[Learn how you can be more involved.](./development/contributing.md)
|
||||
- Feeling lost? Read our [help page](./help.md).
|
||||
|
||||
The solution provides a study list and other resources for connecting to PACS and other Image Archives through standard communication approaches (DICOM Web, DICOM Messages).
|
||||
<!--
|
||||
Links
|
||||
-->
|
||||
|
||||
## Standalone Viewer ([demo](ohif-viewer.s3-website.eu-central-1.amazonaws.com/?url=https://raw.githubusercontent.com/OHIF/Viewers/master/StandaloneViewer/etc/sampleDICOM.json))
|
||||
|
||||
The Standalone Viewer offers only the client-side portions of the OHIF Viewer with the Study List pages removed. This single-page viewer can be hosted as a static site (e.g. on Amazon S3, Azure Blob Storage, or Github Pages), and easily integrated with existing back-end DICOM storage systems. Alternative [Cornerstone](https://cornerstonejs.org/) Image Loaders can be included to allow your viewer to support non-DICOM objects (e.g. PNG, JPEG).
|
||||
<!-- prettier-ignore-start -->
|
||||
[ohif-org]: http://www.ohif.org
|
||||
[dicom-web]: https://en.wikipedia.org/wiki/DICOMweb
|
||||
[gh-issues]: https://github.com/OHIF/Viewers/issues
|
||||
<!-- prettier-ignore-end -->
|
||||
@@ -0,0 +1,153 @@
|
||||
# Architecture
|
||||
|
||||
Looking to extend your instance of the OHIF Viewer? Want learn how to reuse _a
|
||||
portion_ of the Viewer in your own application? Or maybe you want to get
|
||||
involved and draft or suggest a new feature? Regardless, you're in the right
|
||||
place!
|
||||
|
||||
The OHIF Viewer aims to be decoupled, configurable, and extensible; while this
|
||||
allows our code to be used in more ways, it also increases complexity. Below, we
|
||||
aim to demistify that complexity by providing insight into how our Viewer is
|
||||
architected, and the role each of it's dependent libraries plays.
|
||||
|
||||
- [Overview](#overview)
|
||||
- [Business Logic](#business-logic)
|
||||
- [Component Library](#react-component-library)
|
||||
- [Extensions & Configuration](#extensions--configuration)
|
||||
- [Common Questions](#common-questions)
|
||||
|
||||
## Overview
|
||||
|
||||
The [OHIF Medical Image Viewing Platform][viewers-project] 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
|
||||
.
|
||||
├── extensions
|
||||
│ ├── _example # Skeleton of example extension
|
||||
│ ├── cornerstone # 2D images w/ Cornerstone.js
|
||||
│ ├── dicom-html # Structured Reports as HTML in viewport
|
||||
│ ├── dicom-microscopy # Whole slide microscopy viewing
|
||||
│ ├── dicom-pdf # View DICOM wrapped PDFs in viewport
|
||||
│ └── vtk # MPR and Volume support w/ VTK.js
|
||||
│
|
||||
├── platform
|
||||
│ ├── core # Business Logic
|
||||
│ ├── i18n # Internationalization Support
|
||||
│ ├── ui # React component library
|
||||
│ └── viewer # Connects platform and extension projects
|
||||
│
|
||||
├── ... # misc. shared configuration
|
||||
├── lerna.json # MonoRepo (Lerna) settings
|
||||
├── package.json # Shared devDependencies and commands
|
||||
└── README.md
|
||||
```
|
||||
|
||||
The `platform` directory contains the business logic library, component library,
|
||||
and the application library that combines them to create a powerful medical
|
||||
imaging viewer.
|
||||
|
||||
The `extensions` directory contains many packages that can be registered with
|
||||
`@ohif/core`'s `ExtensionManager` to expand an application's supported features
|
||||
and functionality.
|
||||
|
||||

|
||||
|
||||
<center><i>architecture diagram</i></center>
|
||||
|
||||
This diagram is a conceptual illustration of how the Viewer is architected.
|
||||
|
||||
1. (optional) `extensions` can be registered with `@ohif/core`'s
|
||||
`ExtensionManager`
|
||||
2. `@ohif/core` provides bussiness logic and a way for `@ohif/viewer` to access
|
||||
registered extensions
|
||||
3. The `@ohif/viewer` composes and provides data to components from our
|
||||
component library (`@ohif/ui`)
|
||||
4. The `@ohif/viewer` can be built and served as a stand-alone PWA, or as an
|
||||
embeddable package ([`@ohif/viewer`][viewer-npm])
|
||||
|
||||
## Business Logic
|
||||
|
||||
The [`@ohif/core`][core-github] project offers pre-packaged solutions for
|
||||
features common to Web-based medical imaging viewers. For example:
|
||||
|
||||
- Hotkeys
|
||||
- DICOM Web requests
|
||||
- Hanging Protocols
|
||||
- Managing a study's measurements
|
||||
- Managing a study's DICOM metadata
|
||||
- [A flexible pattern for extensions](../extensions/index.md)
|
||||
- And many others
|
||||
|
||||
It does this while remaining decoupled from any particular view library or
|
||||
rendering logic. While we use it to power our React Viewer, it can be used with
|
||||
Vue, React, Vanilla JS, or any number of other frameworks.
|
||||
|
||||
## React Component Library
|
||||
|
||||
[`@ohif/ui`][ui-github] is a React Component library that contains the reusable
|
||||
components that power the OHIF Viewer. It allows us to build, compose, and test
|
||||
components in isolation; easing the development process by reducing the need to
|
||||
stand-up a local PACS with test case data.
|
||||
|
||||
Extension authors can also use these same components when building their
|
||||
extension's UI; allowing for a consistent look and feel with the rest of the
|
||||
application.
|
||||
|
||||
[Check out our component library!](https://react.ohif.org/)
|
||||
|
||||
## Extensions & Configuration
|
||||
|
||||
While OHIF maintains several high value and commonly requested features in its
|
||||
own extensions, there are many instances where one may wish to further extend
|
||||
the viewer. Some common use cases include:
|
||||
|
||||
- Adding AI/ML tools and insights
|
||||
- Custom workflows for guided diagnosis
|
||||
- Collecting specific annotations for training data or reports
|
||||
- Authentication and granular permissions
|
||||
- Teleconsultation workflow, image comments, and tracking
|
||||
- Adding surgical templating tools and reports
|
||||
- and many others
|
||||
|
||||
We expose common integration points via [extensions](../extensions/index.md) to
|
||||
make this possible. The viewer and many of our own extensions also offer
|
||||
[configuration][configuration]. For a list of extensions maintained by OHIF,
|
||||
[check out this helpful table](../extensions/index.md#maintained-extensions).
|
||||
|
||||
If you find yourself thinking "I wish the Viewer could do X", and you can't
|
||||
accomplish it with an extension today, create a GitHub issue! We're actively
|
||||
looking for ways to improve our extensibility ^\_^
|
||||
|
||||
[Click here to read more about extensions!](../extensions/index.md)
|
||||
|
||||
## Common Questions
|
||||
|
||||
> When should I use the packaged source `@ohif/viewer` versus building a PWA
|
||||
> from the source?
|
||||
|
||||
...
|
||||
|
||||
> Can I create my own Viewer using Vue.js or Angular.js?
|
||||
|
||||
You can, but you will not be able to leverage as much of the existing code and
|
||||
components. `@ohif/core` could still be used for business logic, and to provide
|
||||
a model for extensions. `@ohif/ui` would then become a guide for the components
|
||||
you would need to recreate.
|
||||
|
||||
<!--
|
||||
Links
|
||||
-->
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[monorepo]: https://github.com/OHIF/Viewers/issues/768
|
||||
[viewers-project]: https://github.com/OHIF/Viewers
|
||||
[viewer-npm]: https://www.npmjs.com/package/@ohif/viewer
|
||||
[pwa]: https://developers.google.com/web/progressive-web-apps/
|
||||
[configuration]: ../configuring/index.md
|
||||
[extensions]: ../extensions/index.md
|
||||
[core-github]: https://github.com/OHIF/viewers/platform/core
|
||||
[ui-github]: https://github.com/OHIF/Viewers/tree/master/platform/ui
|
||||
<!-- prettier-ignore-end -->
|
||||
@@ -0,0 +1,14 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16">
|
||||
<defs id="defs3051">
|
||||
<style type="text/css" id="current-color-scheme">
|
||||
.ColorScheme-Text {
|
||||
color:#4d4d4d;
|
||||
}
|
||||
</style>
|
||||
</defs>
|
||||
<path
|
||||
style="fill:currentColor;fill-opacity:1;stroke:none"
|
||||
d="M 7.5 2 A 4.5 4.5 0 0 0 3 6.5 A 4.5 4.5 0 0 0 3.0527344 7.15625 A 3 3 0 0 0 1 10 A 3 3 0 0 0 4 13 L 11.5 13 A 3.5 3.5 0 0 0 15 9.5 A 3.5 3.5 0 0 0 11.970703 6.0351562 A 4.5 4.5 0 0 0 7.5 2 z M 7.5 3 A 3.5 3.5 0 0 1 11 6.5 A 3.5 3.5 0 0 1 10.949219 7.0644531 A 2.5 2.5 0 0 1 11.5 7 A 2.5 2.5 0 0 1 14 9.5 A 2.5 2.5 0 0 1 11.5 12 L 4 12 A 2 2 0 0 1 2 10 A 2 2 0 0 1 4 8 A 2 2 0 0 1 4.3574219 8.0332031 A 3.5 3.5 0 0 1 4 6.5 A 3.5 3.5 0 0 1 7.5 3 z "
|
||||
id="path4139"
|
||||
class="ColorScheme-Text"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 818 B |
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<svg version="1.1" id="npm" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 780 250" style="enable-background:new 0 0 780 250;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:#C12127;}
|
||||
</style>
|
||||
<path class="st0" d="M240,250h100v-50h100V0H240V250z M340,50h50v100h-50V50z M480,0v200h100V50h50v150h50V50h50v150h50V0H480z
|
||||
M0,200h100V50h50v150h50V0H0V200z"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 473 B |
|
Before Width: | Height: | Size: 585 KiB |
|
Before Width: | Height: | Size: 227 KiB |
|
Before Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 311 KiB |
|
Before Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 733 KiB |
|
Before Width: | Height: | Size: 517 KiB |
|
Before Width: | Height: | Size: 424 KiB |
|
Before Width: | Height: | Size: 457 KiB |
|
Before Width: | Height: | Size: 257 KiB |
|
Before Width: | Height: | Size: 318 KiB |
|
Before Width: | Height: | Size: 305 KiB |
|
Before Width: | Height: | Size: 315 KiB |
|
Before Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 595 KiB |
|
Before Width: | Height: | Size: 576 KiB |
|
Before Width: | Height: | Size: 411 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 8.8 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 320 KiB |
|
Before Width: | Height: | Size: 521 KiB |
|
Before Width: | Height: | Size: 180 KiB |
|
Before Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 303 KiB |
|
Before Width: | Height: | Size: 292 KiB |
|
Before Width: | Height: | Size: 306 KiB |
|
Before Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 241 KiB |
|
Before Width: | Height: | Size: 314 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 135 KiB |
|
Before Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 117 KiB |
|
Before Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 402 KiB |
|
Before Width: | Height: | Size: 292 KiB |
|
Before Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 414 KiB |
|
Before Width: | Height: | Size: 329 KiB |
|
Before Width: | Height: | Size: 329 KiB |
|
Before Width: | Height: | Size: 311 KiB |
|
Before Width: | Height: | Size: 311 KiB |
|
Before Width: | Height: | Size: 485 KiB |
|
Before Width: | Height: | Size: 113 KiB |
|
Before Width: | Height: | Size: 319 KiB |
|
Before Width: | Height: | Size: 787 KiB |
|
Before Width: | Height: | Size: 424 KiB |
|
Before Width: | Height: | Size: 501 KiB |
|
Before Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 313 KiB |
|
Before Width: | Height: | Size: 292 KiB |
|
Before Width: | Height: | Size: 457 KiB |
|
Before Width: | Height: | Size: 292 KiB |
|
Before Width: | Height: | Size: 457 KiB |
|
Before Width: | Height: | Size: 289 KiB |
|
Before Width: | Height: | Size: 312 KiB |
|
Before Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 454 KiB |
|
Before Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 144 KiB |
|
Before Width: | Height: | Size: 440 KiB |
|
Before Width: | Height: | Size: 444 KiB |
|
Before Width: | Height: | Size: 154 KiB |
|
Before Width: | Height: | Size: 493 KiB |
|
After Width: | Height: | Size: 7.8 KiB |
|
After Width: | Height: | Size: 5.7 KiB |
|
After Width: | Height: | Size: 4.7 KiB |
|
After Width: | Height: | Size: 6.2 KiB |
|
After Width: | Height: | Size: 37 KiB |