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