Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/ohif.rst @ 1071:63a3d4e82c2a
correct extensions of Nexus
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 22 May 2024 17:08:31 +0200 |
parents | ccba1d561379 |
children | f8a335fdeae7 |
rev | line source |
---|---|
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 .. _ohif: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 OHIF plugin |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 =========== |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 .. contents:: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
9 This **official** plugin by the `ICTEAM institute of UCLouvain |
1056
89bb195dfbc0
starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1055
diff
changeset
|
10 <https://orthanc.uclouvain.be/>`__ extends Orthanc with the `OHIF |
89bb195dfbc0
starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1055
diff
changeset
|
11 <https://ohif.org/>`__ extensible Web imaging platform. |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
12 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
13 The plugin greatly simplifies the deployment of OHIF, as it does not |
965
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
14 necessitate the setup of any reverse proxy. |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
15 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
16 If you face difficulties in using OHIF, please get in touch with the |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
17 `OHIF community <https://ohif.org/collaborate>`__ in the first place. |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
18 Indeed, the OHIF and Orthanc communities are entirely distinct. |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
19 |
1055
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
20 **For researchers**: `Please cite this paper |
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
21 <https://dial.uclouvain.be/pr/boreal/object/boreal:257257>`__. |
ebe3214f3ab0
added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
22 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
23 |
1066
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
24 .. _orthanc_vs_ohif: |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
25 |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
26 Orthanc project vs. OHIF project |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
27 -------------------------------- |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
28 |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
29 The Orthanc server and the OHIF viewer are **fully separate projects, |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
30 with distinct communities**. The OHIF plugin for Orthanc only aims at |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
31 facilitating the deployment of OHIF through Orthanc. |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
32 |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
33 As a consequence, the OHIF plugin for Orthanc **only packages official |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
34 releases of OHIF**. |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
35 |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
36 Furthermore, any question or issue that is related to OHIF must be |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
37 directly `asked to the OHIF community |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
38 <https://github.com/OHIF/Viewers/issues>`__, *not* to the Orthanc |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
39 discussion group. |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
40 |
ccba1d561379
added Orthanc project vs. OHIF project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1057
diff
changeset
|
41 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
42 Usage |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
43 ----- |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
44 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
45 This plugin adds a dedicated button to Orthanc Explorer, which |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
46 provides an easy, fast access to the OHIF viewers (click on the image |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
47 to view a demo video): |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
48 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
49 .. image:: ../images/OHIF.png |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
50 :align: center |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
51 :width: 800 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
52 :target: https://www.youtube.com/watch?v=-lzddzq9iT4 |
967
2df3597eacc8
documentation of IIIF support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
965
diff
changeset
|
53 |
2df3597eacc8
documentation of IIIF support
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
965
diff
changeset
|
54 | |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
55 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
56 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
57 Compilation |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
58 ----------- |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
59 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
60 .. highlight:: bash |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
61 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
62 Official releases can be `downloaded from the Orthanc homepage |
993
05b106383b2a
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
63 <https://orthanc.uclouvain.be/downloads/sources/orthanc-ohif/index.html>`__. As |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
64 an alternative, the `repository containing the source code |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
65 <https://orthanc.uclouvain.be/hg/orthanc-ohif/>`__ can be accessed |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
66 using Mercurial. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
67 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
68 The procedure to compile this plugin is similar of that for the |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
69 :ref:`core of Orthanc <binaries>`. The following commands should work |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
70 on most GNU/Linux distributions, provided Docker is installed:: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
71 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
72 $ mkdir Build |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
73 $ cd Build |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
74 $ ../Resources/CreateOHIFDist.sh |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
75 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
76 $ make |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
77 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
78 The compilation will produce a shared library ``libOrthancOHIF.so`` |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
79 that contains the OHIF plugin for Orthanc. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
80 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
81 Pre-compiled Linux Standard Base (LSB) binaries `are available for |
993
05b106383b2a
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
82 download <https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc-ohif/index.html>`__. |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
83 |
993
05b106383b2a
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
84 Pre-compiled binaries for `Microsoft Windows <https://orthanc.uclouvain.be/downloads/windows-32/orthanc-ohif/index.html>`__ |
1057
5a3c238575f8
documentation of stl
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1056
diff
changeset
|
85 and `macOS <https://orthanc.uclouvain.be/downloads/macos/orthanc-ohif/index.html>`__ are available as well. |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
86 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
87 Furthermore, the :ref:`Docker images <docker>` |
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
993
diff
changeset
|
88 ``jodogne/orthanc-plugins`` and ``orthancteam/orthanc`` also contain the |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
89 plugin. Debian and Ubuntu packages can be found in the |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
90 :ref:`standalone repository <binaries>` |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
91 ``https://debian.orthanc-labs.com/``. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
92 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
93 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
94 Configuration |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
95 ------------- |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
96 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
97 .. highlight:: json |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
98 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
99 Here is a minimal sample :ref:`configuration file <configuration>` to |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
100 use this plugin:: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
101 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
102 { |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
103 "Plugins" : [ |
956 | 104 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so" |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
105 ] |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
106 } |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
107 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
108 Orthanc must of course be restarted after the modification of its |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
109 configuration file. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
110 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
111 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
112 Using DICOMweb |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
113 ^^^^^^^^^^^^^^ |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
114 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
115 .. highlight:: json |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
116 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
117 By default, the plugin uses the `DICOM JSON data source |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
118 <https://v3-docs.ohif.org/configuration/datasources/dicom-json/>`__ of |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
119 OHIF. This data source is optimized to provide the fastest access to |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
120 the DICOM images, while requiring no additional plugin. However, in |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
121 order to deliver fast access, the OHIF plugin will cache additional |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
122 information about each DICOM instance as :ref:`metadata <metadata>` in |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
123 the Orthanc database, which results in a larger size of the Orthanc |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
124 database (an additional 1KB is roughly needed per instance). |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
125 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
126 As an alternative, it is possible to enable the `DICOMweb data source |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
127 <https://v3-docs.ohif.org/configuration/dataSources/dicom-web>`__. In |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
128 this case, the :ref:`DICOMweb plugin of Orthanc <dicomweb>` must also |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
129 be loaded. It can also be useful to load the :ref:`GDCM plugin <gdcm>` |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
130 if the DICOM images are encoded using a JPEG2k compressed transfer |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
131 syntax. |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
132 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
133 The advantages of using DICOMweb over the default DICOM JSON are: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
134 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
135 * More standard-compliant. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
136 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
137 * The OHIF study list is accessible, notably as a button on the |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
138 welcome screen of Orthanc Explorer. The study list is not available |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
139 if using the DICOM JSON data source. |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
140 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
141 * No additional space is used in the Orthanc database. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
142 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
143 Here is a minimal configuration file to use DICOMweb:: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
144 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
145 { |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
146 "Plugins" : [ |
956 | 147 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so", |
148 "/home/user/orthanc-dicomweb/Build/libOrthancDicomWeb.so" | |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
149 ], |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
150 "OHIF" : { |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
151 "DataSource" : "dicom-web" |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
152 } |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
153 } |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
154 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
155 |
954
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
156 User configuration of OHIF |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
157 ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
158 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
159 .. highlight:: json |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
160 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
161 OHIF comes with a number of `configuration options |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
162 <https://v3-docs.ohif.org/configuration/configurationfiles/#configuration-options>`__ |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
163 that can be fine-tuned by the user. User settings can be injected |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
164 using the ``UserConfiguration`` option as follows:: |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
165 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
166 { |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
167 "Plugins" : [ |
956 | 168 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so" |
954
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
169 ], |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
170 "OHIF" : { |
955 | 171 "UserConfiguration" : "ohif.js" |
954
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
172 } |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
173 } |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
174 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
175 .. highlight:: javascript |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
176 |
955 | 177 A minimal ``ohif.js`` would be:: |
954
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
178 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
179 window.config = { |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
180 extensions: [], |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
181 modes: [] |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
182 } |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
183 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
184 Note that the following configuration options will be overridden by |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
185 the OHIF plugin to properly configure the data source and the |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
186 integration with the Orthanc Web server: |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
187 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
188 * ``window.config.dataSources`` |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
189 * ``window.config.defaultDataSourceName`` |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
190 * ``window.config.routerBasename`` |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
191 * ``window.config.showStudyList`` (set to ``false`` if using the DICOM |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
192 JSON data source) |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
193 |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
194 |
965
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
195 .. _ohif-router-basename: |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
196 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
197 Router basename |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
198 ^^^^^^^^^^^^^^^ |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
199 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
200 .. highlight:: json |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
201 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
202 If Orthanc is not branched at the root of a Web server thanks of the |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
203 presence of a reverse proxy, the configuration option |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
204 ``RouterBasename`` must be adapted. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
205 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
206 For instance, if Orthanc is running at address |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
207 ``https://host.com/imaging/demo/orthanc/``, the following |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
208 configuration file must be used for OHIF to work:: |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
209 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
210 { |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
211 "Plugins" : [ |
956 | 212 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so" |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
213 ], |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
214 "OHIF" : { |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
215 "RouterBasename" : "/imaging/demo/orthanc/ohif/" |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
216 } |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
217 } |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
218 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
219 The default value of ``RouterBasename`` is ``/ohif/``. |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
220 |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
221 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
222 .. _ohif-preloading: |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
223 |
952
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
224 Preloading |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
225 ^^^^^^^^^^ |
4a76327e83fb
started documentation of ohif plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
226 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
227 .. highlight:: json |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
228 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
229 If using the DICOM JSON data source, whenever a new DICOM instance is |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
230 received by Orthanc, the OHIF plugin will compute a summary of the |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
231 DICOM tags of interest to OHIF, and will store it as :ref:`metadata |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
232 <metadata>` in the Orthanc database. This process has the advantage of |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
233 speeding up even the first opening of the DICOM study by OHIF, which |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
234 probably corresponds to the expectations of most radiologists. |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
235 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
236 However, if your Orthanc deployment is focused on speed, this |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
237 preloading might be undesirable, as it slows down the ingestion of new |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
238 DICOM instances by Orthanc. Furthermore, if your Orthanc server will |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
239 contain a large number of DICOM studies that will never be displayed |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
240 using OHIF, this can result in a waste of space in the Orthanc |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
241 database because of the metadata that will be preloaded, but that will |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
242 never be read. |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
243 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
244 It is consequently possible to turn off the automated preloading |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
245 of metadata using the following configuration:: |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
246 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
247 { |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
248 "Plugins" : [ |
956 | 249 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so" |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
250 ], |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
251 "OHIF" : { |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
252 "DataSource" : "dicom-json", |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
253 "Preload" : false |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
254 } |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
255 } |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
256 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
257 If the ``Preload`` option is set to ``false``, the first display of a |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
258 DICOM study can take several seconds because of the computation of the |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
259 metadata, but subsequent displays will run much faster. |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
260 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
261 Note that preloading is only applied to the newly received instances: |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
262 The DICOM instances that were stored in the Orthanc server before the |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
263 installation of the OHIF plugin will only benefit from the |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
264 optimization starting with their second display using OHIF. |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
265 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
266 |
965
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
267 .. _ohif-https: |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
268 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
269 HTTPS encryption |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
270 ^^^^^^^^^^^^^^^^ |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
271 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
272 .. highlight:: bash |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
273 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
274 In order to use the :ref:`built-in HTTPS encryption <https-builtin>` |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
275 of Orthanc together with the OHIF plugin, first generate a proper |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
276 X.509 certificate for the ``localhost``:: |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
277 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
278 $ openssl req -x509 -nodes -days 365 -newkey rsa:2048 \ |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
279 -subj "/C=BE/CN=localhost" -keyout /tmp/private.key -out /tmp/certificate.crt |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
280 $ cat /tmp/private.key /tmp/certificate.crt > /tmp/certificate.pem |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
281 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
282 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
283 .. highlight:: json |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
284 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
285 Secondly, create the following configuration file:: |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
286 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
287 { |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
288 "Plugins" : [ |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
289 "/home/user/orthanc-ohif/Build/libOrthancOHIF.so" |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
290 ], |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
291 "SslEnabled" : true, |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
292 "SslCertificate" : "/tmp/certificate.pem", |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
293 "OHIF" : { |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
294 "DataSource" : "dicom-json", |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
295 "RouterBasename" : "/ohif/" |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
296 } |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
297 } |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
298 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
299 If more complex scenarios with reverse proxies are involved, make sure |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
300 to properly setup :ref:`CORS in your reverse proxy <nginx-cors>` and |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
301 to :ref:`adapt the router basename <ohif-router-basename>`. If you |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
302 face difficulties, while the simple setup with the built-in HTTPS |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
303 encryption described above works, your issue is related to OHIF, so |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
304 please get in touch with the `OHIF community |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
305 <https://ohif.org/collaborate>`__. |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
306 |
dfd33c9624d8
HTTPS encryption with OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
307 |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
308 For developers |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
309 -------------- |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
310 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
311 Extensions to the REST API |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
312 ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
313 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
314 .. highlight:: bash |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
315 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
316 The content of the `DICOM JSON data source |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
317 <https://v3-docs.ohif.org/configuration/datasources/dicom-json/>`__ |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
318 for a DICOM study of interest can be retrieved as follows:: |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
319 |
991
1316bc62b5d5
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
967
diff
changeset
|
320 $ curl https://orthanc.uclouvain.be/demo/studies/6b9e19d9-62094390-5f9ddb01-4a191ae7-9766b715/ohif-dicom-json |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
321 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
322 This data source is constructed from the :ref:`metadata 4202 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
323 <registry>` associated with the individual DICOM instances of the |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
324 DICOM study. The metadata corresponds to the `Base64 encoding |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
325 <https://en.wikipedia.org/wiki/Base64>`__ of a gzipped JSON file. For |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
326 debugging, the JSON file associated with a DICOM instance can be |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
327 inspected using:: |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
328 |
991
1316bc62b5d5
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
967
diff
changeset
|
329 $ curl https://orthanc.uclouvain.be/demo/instances/1f3c00bd-49df10b7-f416a598-1b3bb5a2-cb791b52/metadata/4202 | base64 -d | gunzip -c |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
330 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
331 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
332 Preloading existing studies |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
333 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
334 |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
335 :ref:`As explained above <ohif-preloading>`, the metadata associated |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
336 with DICOM instances are only preloaded for the newly ingested DICOM |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
337 instances. Using the REST API of Orthanc, it is easy to create a |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
338 script that would preload the metadata for the already existing DICOM |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
339 studies, hereby greatly speeding up the first opening of those studies |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
340 as well. |
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
341 |
954
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
342 This script would loop over the :ref:`the DICOM studies that are |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
343 stored by Orthanc <rest-access>` using ``GET /studies``. For each |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
344 study whose :ref:`Orthanc identifier <orthanc-ids>` is ``id``, the |
19fd9eab4ec0
user configuration of OHIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
953
diff
changeset
|
345 script would simply call ``GET /studies/{id}/ohif-dicom-json``. |
953
2038eb1f55bb
finalized ohif documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
952
diff
changeset
|
346 |