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