Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/stone-webviewer.rst @ 549:109c043907a1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documenting the Stone Web viewer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 02 Dec 2020 17:44:10 +0100
parents
children 2c7d6586717b
comparison
equal deleted inserted replaced
548:654e1614cec1 549:109c043907a1
1 .. _stone_webviewer:
2
3
4 Stone Web Viewer plugin
5 =======================
6
7 .. contents::
8
9 This plugin extends Orthanc with a Web viewer of medical images, with
10 more advanced features than the basic :ref:`Orthanc Web viewer plugin
11 <webviewer>`.
12
13 For general information and a demonstration, check out the `official
14 homepage of the plugin
15 <https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
16 Also `check out the source code
17 <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer>`__.
18
19
20 How to get it
21 -------------
22
23 The Stone Web viewer is part of the `Windows installers
24 <https://www.orthanc-server.com/download-windows.php>`__ (since
25 release 20.12.0 of the installers).
26
27 For GNU/Linux users, the Stone Web viewer is part of the
28 :ref:`official Docker images <docker>`. Precompiled LSB binaries
29 (Linux Standard Base) are `available as well
30 <https://lsb.orthanc-server.com/stone-webviewer/>`__.
31
32 The compilation process is quite complex since it requires using the
33 `Emscripten <https://emscripten.org/>`__ compiler toolchain. The full
34 build instructions are available in the `source code
35 <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/WebAssembly/NOTES.txt>`__.
36
37
38 Usage
39 -----
40
41 On Microsoft Windows or if you are using the
42 ``jodogne/orthanc-plugins`` :ref:`Docker images <docker>`, the plugin
43 is enabled by default and will work out-of-the-box.
44
45 .. highlight:: bash
46
47 The ``osimis/orthanc`` :ref:`Docker images <docker-osimis>` are more
48 suited to devops need, as they allow to start a minimal Docker
49 environment as follows::
50
51 $ docker run -p 4242:4242 -p 8042:8042 -e STONE_WEB_VIEWER_PLUGIN_ENABLED=true -e DICOM_WEB_PLUGIN_ENABLED=true --rm osimis/orthanc:20.12.0
52
53
54 .. highlight:: json
55
56 On plain GNU/Linux distributions (i.e. if not using Docker), the Stone
57 Web viewer will only work with the LSB binaries (Linux Standard Base)
58 of the Orthanc server that can be downloaded from `here
59 <https://lsb.orthanc-server.com/orthanc/>`__ (this setup will work
60 with most recent GNU/Linux distributions). The Stone Web viewer also
61 requires the `DICOMweb plugin
62 <https://lsb.orthanc-server.com/plugin-dicom-web/>`__ to be installed.
63
64 Once the binaries are installed, you must change the
65 :ref:`configuration file <configuration>` to tell Orthanc where it can
66 find the plugin: This is done by properly modifying the ``Plugins``
67 option. You could for instance use the following configuration file::
68
69 {
70 "Name" : "MyOrthanc",
71 [...]
72 "Plugins" : [
73 "/home/user/xxx/Downloads/libStoneWebViewer.so",
74 "/home/user/xxx/Downloads/libOrthancDicomWeb.so"
75 ]
76 }
77
78 .. highlight:: text
79
80 Orthanc must of course be restarted after the modification of its
81 configuration file.
82
83 Once a :ref:`DICOM study <model-world>` is opened using Orthanc
84 Explorer, a yellow button entitled ``Stone Web Viewer`` will show
85 up. It will open the Web viewer for that particular study. See also
86 the interactive demonstration on the `official homepage of the plugin
87 <https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
88
89 Advanced options
90 ----------------
91
92 .. highlight:: json
93
94 The configuration of the Web viewer can be fine-tuned by adapting some
95 options in the `configuration file
96 <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/WebApplication/configuration.json>`__.
97
98 FAQ
99 ---
100
101 - **Can I use the Stone Viewer in a medical environment?**
102
103 The Stone Viewer is not a Medical Device; it is not CE marked or FDA
104 approved. The Stone Viewer is free and open-source software that
105 cannot be used for diagnostic or therapeutic purposes.
106
107 However, the viewer can be used as a communication tool that allows
108 researchers, teachers, technicians, medical physicists, general
109 practitioner or patients to visualize medical images for information
110 only.
111
112 Check out your local regulations to ensure you're using it in a
113 legal manner.
114
115
116 - **What video formats are supported by the Stone Web Viewer?**
117
118 The set of codecs supported by the Stone Viewer is an intersection
119 of the sets of codecs supported by the `DICOM standard
120 <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__
121 and those supported by the `web browsers
122 <https://developer.mozilla.org/en-US/docs/Web/Media/Formats>`__.
123 In short, this mostly comes down to just MPEG-4.
124
125 Note that video playing is not supported using the plain DICOMweb
126 protocol: The Stone Web viewer will use the :ref:`REST API of
127 Orthanc <rest>` to play videos.
128
129 - **How do Osimis Web viewer and Stone Web viewer compare?**
130
131 The two viewers use a very similar user interface. However, their
132 internal architecture is totally different:
133
134 - Stone Web viewer is a combination of C++, :ref:`Stone of Orthanc
135 <stone>`, WebAssembly, DICOMweb and Vue.js.
136
137 - Osimis Web viewer is a combination of JavaScript, `Cornerstone
138 <https://cornerstonejs.org/>`__, :ref:`Orthanc REST API <rest>`
139 and Angular.
140
141 The Osimis Web viewer is deprecated and superseded by the Stone Web
142 viewer, as the Stone of Orthanc library allows to use a single C++
143 codebase between mobile apps, desktop software and Web applications.
144
145 Some features from the Osimis Web viewer are not available (yet),
146 such as creating custom annotations or the Live Share feature.
147
148 - **How can I migrate from Osimis Web viewer to Stone Web viewer?**
149
150 Full instructions are provided in the `source distribution
151 <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/NOTES.txt>`__.
152
153 - **What are the future plans?**
154
155 The use of :ref:`Stone of Orthanc library <stone>` gives us a lot of
156 flexibility to implement new advanced features, such as 3D rendering
157 (MPR, reslicing, image fusion...) and DICOM-RT support.
158
159 We are looking for :ref:`industrial sponsors <contributing>` to
160 implement such new features in the Stone Web viewer.
161