Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/osimis-webviewer.rst @ 308:ab0077ab5f5f
typos
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 04 Feb 2020 14:28:03 +0100 |
| parents | 32829e166b9d |
| children | b7f045b23faa |
| 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 |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 Osimis Web Viewer plugin |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 ======================== |
|
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 |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
14 Importantly, contrarily to the basic Orthanc Web viewer, **CE |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
15 marking** is available. By buying such a CE marking, this viewer can |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 be used for diagnostic purpose. |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
17 |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
18 For general information, check out the `official homepage of the |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 plugin |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
20 <http://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
21 Also `check out the source code |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
22 <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
|
23 |
| 303 | 24 |
| 25 How to get it | |
| 26 ------------- | |
| 27 | |
| 28 The Osimis Web viewer is part of the `Windows installers | |
| 29 <https://www.orthanc-server.com/download-windows.php>`__. | |
| 30 | |
| 308 | 31 For Linux users, you'll find it in the `osimis/orthanc |
| 32 <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__ | |
| 33 Docker images or you can download the LSB (Linux Standard Base) | |
| 34 binaries `here | |
| 35 <http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.3.1/libOsimisWebViewer.so>`__. | |
| 303 | 36 |
| 37 The compilation process is quite complex since it requires to build | |
| 38 first the frontend and then the backend. All information can be found | |
| 39 in the `source code | |
| 40 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. | |
| 41 | |
| 42 | |
| 43 Usage | |
| 44 ----- | |
| 45 | |
| 46 .. highlight:: json | |
| 47 | |
| 308 | 48 On Windows, the plugin is enabled by default and will work |
| 49 out-of-the-box. | |
| 303 | 50 |
| 308 | 51 If you're using the ``osimis/orthanc`` Docker image, you'll have to |
| 52 define the WVB_ENABLED `environment variable | |
| 53 <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages?-OsimisWebViewer>`__ | |
| 54 to ``true``. | |
| 303 | 55 |
| 308 | 56 On plain GNU/Linux distributions (i.e. if not using Docker), the |
| 57 Osimis Web viewer will only work with LSB (Linux Standard Base) | |
| 58 Orthanc binaries that can be downloaded from `here | |
| 59 <https://lsb.orthanc-server.com/orthanc/>`__ (that will work with most | |
| 60 recent GNU/Linux distributions). Once Orthanc is installed, you must | |
| 61 change the :ref:`configuration file <configuration>` to tell Orthanc | |
| 62 where it can find the plugin: This is done by properly modifying the | |
| 63 ``Plugins`` option. You could for instance use the following | |
| 64 configuration file:: | |
| 303 | 65 |
| 66 { | |
| 67 "Name" : "MyOrthanc", | |
| 68 [...] | |
| 69 "Plugins" : [ | |
| 70 "/home/user/xxx/Downloads/libOsimisWebViewer.so" | |
| 71 ] | |
| 72 } | |
| 73 | |
| 74 .. highlight:: text | |
| 75 | |
| 76 Orthanc must of course be restarted after the modification of its | |
| 77 configuration file. | |
| 78 | |
| 79 Once a :ref:`DICOM study <model-world>` is opened using Orthanc | |
| 80 Explorer, a yellow button entitled ``Osimis Web Viewer`` will show | |
| 81 up. It will open the Web viewer for that particular study. See also | |
| 308 | 82 the interactive demonstration on the `official homepage of the plugin |
| 303 | 83 <https://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. |
| 84 | |
| 85 Advanced options | |
| 86 ---------------- | |
| 87 | |
| 88 .. highlight:: json | |
| 89 | |
| 308 | 90 The configuration of the Web viewer can be fine-tuned by adapting some |
| 91 options in the `configuration file | |
| 92 <https://bitbucket.org/osimis/osimis-webviewer-plugin/src/master/doc/default-configuration.json>`__. | |
| 303 | 93 |
| 94 FAQ | |
| 95 --- | |
| 96 | |
| 97 - **What video formats are supported by the Osimis Web Viewer ?** | |
| 98 | |
| 308 | 99 The set of codecs supported by the Osimis Viewer is an intersection |
| 100 of the sets of codecs supported by the `DICOM standard | |
| 101 <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__ | |
| 102 and those supported by the `web browsers | |
| 103 <https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats>`__. | |
| 303 | 104 In short, this mostly comes down to just MPEG-4. |
| 105 | |
| 106 - **Where are the annotations stored ?** | |
| 107 | |
| 308 | 108 Annotations are stored in :ref:`metadata <metadata>` (id ``9999``) |
| 109 in a custom format. Note that annotation storage is disabled by | |
| 110 default and can be enabled by setting ``"AnnotationStorageEnabled": | |
| 111 true`` in the configuration file. | |
| 303 | 112 |
| 113 | |
| 114 | |
| 115 CE marking | |
| 116 ---------- | |
| 117 | |
| 308 | 118 Legally, in Europe, the Osimis Web viewer cannot be used for medical |
| 119 usage unless you purchase the `CE marked version by Osimis | |
| 120 <https://www.osimis.io/en/services.html>`__. If you are located | |
| 121 outside of Europe, you should check your local regulation: However, | |
| 122 you are most likely not allowed to use it for medical usage as well. | |
| 303 | 123 |
| 308 | 124 Although the free and open-source version of the Osimis Web viewer |
| 125 offers the same feature scope, CE marking requires a "supplier-end | |
| 126 user" agreement in which the supplier guarantees that: | |
| 303 | 127 |
| 128 - the viewer has been tested for medical use against all possible patient risk, | |
| 129 - the end user receives regular updates on new features and bug fixes, | |
| 130 - the end user can be informed of any bug in the medical device. |