Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/ohif.rst @ 952:4a76327e83fb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
started documentation of ohif plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 19 Jun 2023 07:05:38 +0200
parents
children 2038eb1f55bb
comparison
equal deleted inserted replaced
951:7d835b341882 952:4a76327e83fb
1 .. _ohif:
2
3
4 OHIF plugin
5 ===========
6
7 .. contents::
8
9 This **official** plugin by the `ICTEAM institute of UCLouvain
10 <https://uclouvain.be/en/research-institutes/icteam>`__ extends
11 Orthanc with the `OHIF <https://ohif.org/>`__ extensible Web imaging
12 platform.
13
14
15 Usage
16 -----
17
18 This plugin adds a dedicated button to Orthanc Explorer, which
19 provides an easy, fast access to the OHIF viewers (click on the image
20 to view a demo video):
21
22 .. image:: ../images/OHIF.png
23 :align: center
24 :width: 800
25 :target: https://www.youtube.com/watch?v=-lzddzq9iT4
26 |
27
28 The plugin greatly simplifies the deployment of OHIF, as it does not
29 necessitate the setup of any reverse proxy.
30
31
32 Compilation
33 -----------
34
35 .. highlight:: bash
36
37 Official releases can be `downloaded from the Orthanc homepage
38 <https://www.orthanc-server.com/browse.php?path=/plugin-ohif>`__. As
39 an alternative, the `repository containing the source code
40 <https://orthanc.uclouvain.be/hg/orthanc-ohif/>`__ can be accessed
41 using Mercurial.
42
43 The procedure to compile this plugin is similar of that for the
44 :ref:`core of Orthanc <binaries>`. The following commands should work
45 on most GNU/Linux distributions, provided Docker is installed::
46
47 $ mkdir Build
48 $ cd Build
49 $ ../Resources/CreateOHIFDist.sh
50 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
51 $ make
52
53 The compilation will produce a shared library ``libOrthancOHIF.so``
54 that contains the OHIF plugin for Orthanc.
55
56 Pre-compiled Linux Standard Base (LSB) binaries `are available for
57 download <https://lsb.orthanc-server.com/plugin-ohif/>`__.
58
59 Pre-compiled binaries for Microsoft Windows and macOS `are also
60 available
61 <https://www.orthanc-server.com/browse.php?path=/plugin-ohif>`__.
62
63 Furthermore, the :ref:`Docker images <docker>`
64 ``jodogne/orthanc-plugins`` and ``osimis/orthanc`` also contain the
65 plugin. Debian and Ubuntu packages can be found in the
66 :ref:`standalone repository <binaries>`
67 ``https://debian.orthanc-labs.com/``.
68
69
70 Configuration
71 -------------
72
73 .. highlight:: json
74
75 Here is a minimal sample :ref:`configuration file <configuration>` to
76 use this plugin::
77
78 {
79 "Plugins" : [
80 "/home/user/orthanc-ohif/Build/libOHIF.so"
81 ]
82 }
83
84 Orthanc must of course be restarted after the modification of its
85 configuration file.
86
87
88 Using DICOMweb
89 ^^^^^^^^^^^^^^
90
91 By default, the plugin uses the `DICOM JSON data source
92 <https://v3-docs.ohif.org/configuration/datasources/dicom-json/>`__ of
93 OHIF. This data source is optimized to provide the fastest access to
94 the DICOM images, while requiring no additional plugin. However, in
95 order to deliver fast access, the OHIF plugin will cache additional
96 information about each DICOM instance in the Orthanc database, which
97 results in a larger size of the Orthanc database (an additional 1KB is
98 roughly needed per instance).
99
100 It is also possible to enable the `DICOMweb data source
101 <https://v3-docs.ohif.org/configuration/dataSources/dicom-web>`__. In
102 this case, the :ref:`DICOMweb plugin of Orthanc <dicomweb>` must also
103 be loaded. It can also be useful to load the :ref:`GDCM plugin <gdcm>`
104 if the images use a compressed transfer syntax.
105
106 The advantages of using DICOMweb over the default DICOM JSON are:
107
108 * More standard-compliant.
109
110 * The OHIF study list is accessible, notably as a button on the
111 welcome screen of Orthanc Explorer.
112
113 * No additional space is used in the Orthanc database.
114
115 Here is a minimal configuration file to use DICOMweb::
116
117 {
118 "Plugins" : [
119 "/home/user/orthanc-ohif/Build/libOHIF.so",
120 "/home/user/orthanc-dicomweb/Build/libOHIF.so"
121 ],
122 "OHIF" : {
123 "DataSource" : "dicom-web"
124 }
125 }
126
127
128 Router basename
129 ^^^^^^^^^^^^^^^
130
131 If Orthanc is not branched at the root of a Web server thanks of the
132 presence of a reverse proxy, the configuration option
133 ``RouterBasename`` must be adapted.
134
135 For instance, if Orthanc is running at address
136 ``https://host.com/imaging/demo/orthanc/``, the following
137 configuration file must be used for OHIF to work::
138
139 {
140 "Plugins" : [
141 "/home/user/orthanc-ohif/Build/libOHIF.so"
142 ],
143 "OHIF" : {
144 "RouterBasename" : "/imaging/demo/orthanc/ohif/"
145 }
146 }
147
148 The default value of ``RouterBasename`` is ``/ohif/``.
149
150
151 Preloading
152 ^^^^^^^^^^
153