Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/osimis-webviewer.rst @ 1113:a588960a72e5 default tip
spelling
| author | Alain Mazy <am@orthanc.team> |
|---|---|
| date | Mon, 28 Oct 2024 09:23:08 +0100 |
| parents | 60b0b7ea409b |
| children |
| rev | line source |
|---|---|
|
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 .. _osimis_webviewer: |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
4 Osimis Web viewer plugin (deprecated) |
|
549
109c043907a1
documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
361
diff
changeset
|
5 ===================================== |
|
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 .. contents:: |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
9 .. warning:: |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
10 |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
11 The Osimis Web viewer is now deprecated and superseded by the |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
12 :ref:`Stone Web viewer <stone_webviewer>`. |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
13 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
14 This plugin, originally written by Osimis, extends Orthanc with a Web |
|
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
15 viewer of medical images, with more advanced features than the basic |
|
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
16 :ref:`Orthanc Web viewer plugin <webviewer>`. The Osimis Web viewer |
|
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
17 plugin adds tools for measuring, for viewing multiple series, and for |
|
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
18 split-pane. |
|
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
20 This plugin adds a dedicated button to Orthanc Explorer to open the |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
21 viewer that looks like the following image: |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
22 |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
23 .. image:: ../images/osimis-web-viewer.png |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
24 :align: center |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
25 :width: 800 |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
26 |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
27 |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
28 |
|
301
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
29 |
| 303 | 30 |
| 31 How to get it | |
| 32 ------------- | |
| 33 | |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
34 For general information, `check out the source code |
|
1012
34f30ddc0dec
changed location of osimis-webviewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
997
diff
changeset
|
35 <https://github.com/orthanc-team/osimis-webviewer-deprecated>`__. |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
36 |
| 303 | 37 The Osimis Web viewer is part of the `Windows installers |
| 38 <https://www.orthanc-server.com/download-windows.php>`__. | |
| 39 | |
|
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
1012
diff
changeset
|
40 For GNU/Linux users, you'll find it in the :ref:`orthancteam/orthanc |
|
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
1012
diff
changeset
|
41 <docker-orthancteam>` Docker images or you can download precompiled LSB |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
42 (Linux Standard Base) binaries `here |
|
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
43 <https://orthanc.uclouvain.be/downloads/linux-standard-base/osimis-web-viewer/index.html>`__. |
| 303 | 44 |
| 45 The compilation process is quite complex since it requires to build | |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
46 first the frontend and then the backend. All information can be found |
| 303 | 47 in the `source code |
|
1012
34f30ddc0dec
changed location of osimis-webviewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
997
diff
changeset
|
48 <https://github.com/orthanc-team/osimis-webviewer-deprecated>`__. |
| 303 | 49 |
| 50 | |
| 51 Usage | |
| 52 ----- | |
| 53 | |
| 54 .. highlight:: json | |
| 55 | |
| 308 | 56 On Windows, the plugin is enabled by default and will work |
| 57 out-of-the-box. | |
| 303 | 58 |
|
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
1012
diff
changeset
|
59 If you're using the ``orthancteam/orthanc`` Docker images, you'll have to |
|
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
1012
diff
changeset
|
60 define the ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED`` :ref:`environment variable <docker-orthancteam>` |
| 308 | 61 to ``true``. |
| 303 | 62 |
| 308 | 63 On plain GNU/Linux distributions (i.e. if not using Docker), the |
| 64 Osimis Web viewer will only work with LSB (Linux Standard Base) | |
| 65 Orthanc binaries that can be downloaded from `here | |
|
1023
5d4701d8fe28
replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents:
1012
diff
changeset
|
66 <https://orthanc.uclouvain.be/downloads/linux-standard-base/osimis-web-viewer/1.4.3/index.html>`__ (that will work with most |
| 308 | 67 recent GNU/Linux distributions). Once Orthanc is installed, you must |
| 68 change the :ref:`configuration file <configuration>` to tell Orthanc | |
| 69 where it can find the plugin: This is done by properly modifying the | |
| 70 ``Plugins`` option. You could for instance use the following | |
| 71 configuration file:: | |
| 303 | 72 |
| 73 { | |
| 74 "Name" : "MyOrthanc", | |
| 75 [...] | |
| 76 "Plugins" : [ | |
| 77 "/home/user/xxx/Downloads/libOsimisWebViewer.so" | |
| 78 ] | |
| 79 } | |
| 80 | |
| 81 .. highlight:: text | |
| 82 | |
| 83 Orthanc must of course be restarted after the modification of its | |
| 84 configuration file. | |
| 85 | |
| 86 Once a :ref:`DICOM study <model-world>` is opened using Orthanc | |
| 87 Explorer, a yellow button entitled ``Osimis Web Viewer`` will show | |
|
994
df9162e80fc8
Osimis has discontinued the sample demo server for the Osimis Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
549
diff
changeset
|
88 up. It will open the Web viewer for that particular study. |
| 303 | 89 |
| 90 Advanced options | |
| 91 ---------------- | |
| 92 | |
| 93 .. highlight:: json | |
| 94 | |
| 308 | 95 The configuration of the Web viewer can be fine-tuned by adapting some |
| 96 options in the `configuration file | |
|
1012
34f30ddc0dec
changed location of osimis-webviewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
997
diff
changeset
|
97 <https://github.com/orthanc-team/osimis-webviewer-deprecated/blob/dev/doc/default-configuration.json>`__. |
| 303 | 98 |
| 99 FAQ | |
| 100 --- | |
| 101 | |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
102 - **Can I use the Osimis Web viewer in a medical environment?** |
|
334
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
103 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
104 The Osimis Web viewer is not a Medical Device; it is not CE marked or FDA approved. |
|
337
85524c571277
rephrased Osimis viewer usage according to VCA suggestions
Alain Mazy <alain@mazy.be>
parents:
335
diff
changeset
|
105 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
106 The Osimis Web viewer is an open source Viewer that cannot be used for diagnostic or therapeutic purposes. |
|
334
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
107 |
|
337
85524c571277
rephrased Osimis viewer usage according to VCA suggestions
Alain Mazy <alain@mazy.be>
parents:
335
diff
changeset
|
108 However, the viewer can be used as a communication tool that allows Researchers, Teachers, Technicians, General Practitioner or Patients to visualize medical images for information only. |
|
85524c571277
rephrased Osimis viewer usage according to VCA suggestions
Alain Mazy <alain@mazy.be>
parents:
335
diff
changeset
|
109 |
|
549
109c043907a1
documenting the Stone Web viewer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
361
diff
changeset
|
110 Check your local regulations to ensure you're using it in a legal manner. |
|
337
85524c571277
rephrased Osimis viewer usage according to VCA suggestions
Alain Mazy <alain@mazy.be>
parents:
335
diff
changeset
|
111 |
|
334
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
112 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
113 - **What video formats are supported by the Osimis Web viewer?** |
| 303 | 114 |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
115 The set of codecs supported by the Osimis Web viewer is an intersection |
| 308 | 116 of the sets of codecs supported by the `DICOM standard |
| 117 <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__ | |
| 118 and those supported by the `web browsers | |
|
358
011b01ccf52d
fixing external hyperlinks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
337
diff
changeset
|
119 <https://developer.mozilla.org/en-US/docs/Web/Media/Formats>`__. |
| 303 | 120 In short, this mostly comes down to just MPEG-4. |
| 121 | |
|
1027
60b0b7ea409b
migration to orthancteam
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1023
diff
changeset
|
122 - **Where are the annotations stored?** |
| 303 | 123 |
| 308 | 124 Annotations are stored in :ref:`metadata <metadata>` (id ``9999``) |
| 125 in a custom format. Note that annotation storage is disabled by | |
| 126 default and can be enabled by setting ``"AnnotationStorageEnabled": | |
| 127 true`` in the configuration file. | |
| 303 | 128 |