Mercurial > hg > orthanc-book

annotate Sphinx/source/plugins/stone-webviewer.rst @ 927:dfe96daba4f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
python in win installer
author Alain Mazy <am@osimis.io>
date Wed, 29 Mar 2023 11:54:58 +0200
parents b274a5d4d59d
children 1316bc62b5d5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 .. _stone_webviewer:
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 Stone Web Viewer plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 =======================
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 .. contents::
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 This plugin extends Orthanc with a Web viewer of medical images, with
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 more advanced features than the basic :ref:`Orthanc Web viewer plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 <webviewer>`.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 For general information and a demonstration, check out the `official
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 homepage of the plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 <https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 Also `check out the source code
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer>`__.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 How to get it
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 -------------
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 The Stone Web viewer is part of the `Windows installers
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 <https://www.orthanc-server.com/download-windows.php>`__ (since
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 release 20.12.0 of the installers).
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 For GNU/Linux users, the Stone Web viewer is part of the
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 :ref:`official Docker images <docker>`. Precompiled LSB binaries
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 (Linux Standard Base) are `available as well
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 <https://lsb.orthanc-server.com/stone-webviewer/>`__.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 The compilation process is quite complex since it requires using the
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 `Emscripten <https://emscripten.org/>`__ compiler toolchain. The full
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 build instructions are available in the `source code
899
b274a5d4d59d Stone Web viewer 2.5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 889
diff changeset
35 <https://hg.orthanc-server.com/orthanc-stone/file/StoneWebViewer-2.5/Applications/StoneWebViewer/WebAssembly/NOTES.txt>`__.
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 Usage
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 -----
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 On Microsoft Windows or if you are using the
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 ``jodogne/orthanc-plugins`` :ref:`Docker images <docker>`, the plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 is enabled by default and will work out-of-the-box.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 .. highlight:: bash
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 The ``osimis/orthanc`` :ref:`Docker images <docker-osimis>` are more
887
db16e0fffe67 re-indexing of the jodogne/orthanc Docker images
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 867
diff changeset
48 suited to devops needs, as they allow to start a minimal Docker
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 environment as follows::
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
731
f4ff5a1af41e Stone Web viewer 2.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 723
diff changeset
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:21.6.2
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 .. highlight:: json
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 On plain GNU/Linux distributions (i.e. if not using Docker), the Stone
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 Web viewer will only work with the LSB binaries (Linux Standard Base)
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 of the Orthanc server that can be downloaded from `here
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 <https://lsb.orthanc-server.com/orthanc/>`__ (this setup will work
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 with most recent GNU/Linux distributions). The Stone Web viewer also
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 requires the `DICOMweb plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 <https://lsb.orthanc-server.com/plugin-dicom-web/>`__ to be installed.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 Once the binaries are installed, you must change the
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 :ref:`configuration file <configuration>` to tell Orthanc where it can
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 find the plugin: This is done by properly modifying the ``Plugins``
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 option. You could for instance use the following configuration file::
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 {
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 "Name" : "MyOrthanc",
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 [...]
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 "Plugins" : [
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 "/home/user/xxx/Downloads/libStoneWebViewer.so",
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 "/home/user/xxx/Downloads/libOrthancDicomWeb.so"
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 ]
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 }
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 .. highlight:: text
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 Orthanc must of course be restarted after the modification of its
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 configuration file.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 Once a :ref:`DICOM study <model-world>` is opened using Orthanc
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 Explorer, a yellow button entitled ``Stone Web Viewer`` will show
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 up. It will open the Web viewer for that particular study. See also
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 the interactive demonstration on the `official homepage of the plugin
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 <https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 Advanced options
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 ----------------
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
828
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
92 * The configuration of the Web viewer can be fine-tuned by adapting
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
93 some **advanced options** in the `configuration file
899
b274a5d4d59d Stone Web viewer 2.5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 889
diff changeset
94 <https://hg.orthanc-server.com/orthanc-stone/file/StoneWebViewer-2.5/Applications/StoneWebViewer/WebApplication/configuration.json>`__.
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
828
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
96 * The source distribution of the Stone Web viewer contains a
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
97 `NOTES.txt file
899
b274a5d4d59d Stone Web viewer 2.5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 889
diff changeset
98 <https://hg.orthanc-server.com/orthanc-stone/file/StoneWebViewer-2.5/Applications/StoneWebViewer/NOTES.txt>`__
828
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
99 that discusses the differences with the :ref:`Osimis Web viewer
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
100 <osimis_webviewer>` as well as **advanced features** of the software
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
101 (opening multiple studies, authorization, display of OsiriX
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
102 annotations...).
829
6787e8af4316 point to the TODO of orthanc-stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 828
diff changeset
103
6787e8af4316 point to the TODO of orthanc-stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 828
diff changeset
104 * Also, check out our `TODO file
6787e8af4316 point to the TODO of orthanc-stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 828
diff changeset
105 <https://hg.orthanc-server.com/orthanc-stone/file/default/TODO>`__
6787e8af4316 point to the TODO of orthanc-stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 828
diff changeset
106 that is used to track **future features**.
828
e587ba35dba2 advanced stone web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 827
diff changeset
107
823
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
108
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
109 .. _stone_webviewer_troubleshooting:
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
110
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
111 Troubleshooting
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
112 ---------------
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
113
824
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
114 - `Some users
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
115 <https://groups.google.com/g/orthanc-users/c/RfQJFgkOUYY/m/d1uGW7APBgAJ>`__
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
116 have reported that some versions of Google Chrome and Chromium (in
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
117 particular release 97.0.4692.71) don't properly support
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
118 **drag-and-drop**. This is *not* an issue in Stone Web viewer, but
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
119 an issue in Chrome/Chromium (cf. `issue 1284605
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
120 <https://bugs.chromium.org/p/chromium/issues/detail?id=1284605>`__).
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
121 This problem can be overcome in 3 different ways:
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
122
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
123 1. Upgrade your Web browser (releases >= 98.0.x should run fine).
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
124
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
125 2. Replace drag-and-drop by clicking on the "drop a series here"
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
126 area, then clicking on the series you want to load.
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
127
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
128 3. Disable the option "Use system title bar and borders" in the
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
129 settings of Chrome/Chromium, as depicted in the following
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
130 screenshot:
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
131
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
132 .. image:: ../images/stone-webviewer-google-issue.png
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
133 :align: center
c568ec32c1eb stone-webviewer-google-issue.png
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 823
diff changeset
134 :width: 800
823
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
135
9e953bba1b21 added stone_webviewer_troubleshooting
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
136
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 FAQ
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 ---
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 - **Can I use the Stone Viewer in a medical environment?**
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 The Stone Viewer is not a Medical Device; it is not CE marked or FDA
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 approved. The Stone Viewer is free and open-source software that
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 cannot be used for diagnostic or therapeutic purposes.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 However, the viewer can be used as a communication tool that allows
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 researchers, teachers, technicians, medical physicists, general
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 practitioner or patients to visualize medical images for information
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 only.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
150
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
151 Check out your local regulations to ensure you're using it in a
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
152 legal manner.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153
867
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
154 - **Can the Stone Web Viewer display DICOM-SR (structured reports)?**
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
155
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
156 The Stone Web viewer doesn't provide built-in support for
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
157 DICOM-SR. However, it can display DICOM-SR that have been beforehand
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
158 converted to PDF.
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
159
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
160 To this end, you could for instance first use the ``dsr2html``
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
161 command-line tool that is provided by the `DCMTK project
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
162 <https://support.dcmtk.org/docs/mod_dcmsr.html>`__ to convert the
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
163 structured report to HTML, then use a HTML-to-PDF converter such as
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
164 `wkhtmltopdf <https://wkhtmltopdf.org/>`__, and finally convert the
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
165 PDF to DICOM using the ``/tools/create-dicom`` route in the `REST
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
166 API of Orthanc
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
167 <https://api.orthanc-server.com/index.html#tag/System/paths/~1tools~1create-dicom/post>`__.
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
168 It would be easy to automate this workflow using a :ref:`Python
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
169 plugin <python-plugin>`.
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
170
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
171 If you have an interest in DICOM-SR, the Orthanc community would
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
172 love to have access to sample DICOM files that could be used to
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
173 enhance the support of structured reports in the Stone Web viewer.
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
174 If you have such sample files, please post them to the `Orthanc
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
175 Users <https://groups.google.com/g/orthanc-users>`__ discussion
888d6b29245a faq: Can the Stone Web Viewer display DICOM-SR
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 829
diff changeset
176 forum.
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
177
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
178 - **What video formats are supported by the Stone Web Viewer?**
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
179
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180 The set of codecs supported by the Stone Viewer is an intersection
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
181 of the sets of codecs supported by the `DICOM standard
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
182 <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
183 and those supported by the `web browsers
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
184 <https://developer.mozilla.org/en-US/docs/Web/Media/Formats>`__.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185 In short, this mostly comes down to just MPEG-4.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187 Note that video playing is not supported using the plain DICOMweb
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
188 protocol: The Stone Web viewer will use the :ref:`REST API of
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
189 Orthanc <rest>` to play videos.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
190
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
191 - **How do Osimis Web viewer and Stone Web viewer compare?**
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 The two viewers use a very similar user interface. However, their
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 internal architecture is totally different:
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 - Stone Web viewer is a combination of C++, :ref:`Stone of Orthanc
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197 <stone>`, WebAssembly, DICOMweb and Vue.js.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 - Osimis Web viewer is a combination of JavaScript, `Cornerstone
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 <https://cornerstonejs.org/>`__, :ref:`Orthanc REST API <rest>`
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 and Angular.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
203 The Osimis Web viewer is deprecated and superseded by the Stone Web
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
204 viewer, as the Stone of Orthanc library allows to use a single C++
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
205 codebase between mobile apps, desktop software and Web applications.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
206
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
207 Some features from the Osimis Web viewer are not available (yet),
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
208 such as creating custom annotations or the Live Share feature.
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
209
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
210 - **How can I migrate from Osimis Web viewer to Stone Web viewer?**
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
211
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
212 Full instructions are provided in the `source distribution
899
b274a5d4d59d Stone Web viewer 2.5
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 889
diff changeset
213 <https://hg.orthanc-server.com/orthanc-stone/file/StoneWebViewer-2.5/Applications/StoneWebViewer/NOTES.txt>`__.
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
214
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
215 - **What are the future plans?**
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216
550
2c7d6586717b future stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
217 The internal use of :ref:`Stone of Orthanc library <stone>` gives us
2c7d6586717b future stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
218 a lot of flexibility to implement new advanced features, such as 3D
2c7d6586717b future stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 549
diff changeset
219 rendering (MPR, reslicing, image fusion...), DICOM-RT support,
734
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 731
diff changeset
220 storage of annotations/measurements, viewer for mobile devices,
635
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 553
diff changeset
221 internationalization (translation)...
549
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
222
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
223 We are looking for :ref:`industrial sponsors <contributing>` to
109c043907a1 documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
224 implement such new features in the Stone Web viewer.