Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/osimis-webviewer.rst @ 305:32829e166b9d
fix webviewer doc
| author | Alain Mazy <alain@mazy.be> |
|---|---|
| date | Fri, 31 Jan 2020 08:51:19 +0100 |
| parents | a6831d200d43 |
| children | ab0077ab5f5f 5e2bf921f09c |
| 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 | |
| 31 For Linux users, you'll find it in the `osimis/orthanc <https://hub.docker.com/repository/docker/osimis/orthanc>`__ | |
| 32 docker images or you can download the LSB binary `here <http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.3.1/libOsimisWebViewer.so>`__. | |
| 33 | |
| 34 The compilation process is quite complex since it requires to build | |
| 35 first the frontend and then the backend. All information can be found | |
| 36 in the `source code | |
| 37 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. | |
| 38 | |
| 39 | |
| 40 Usage | |
| 41 ----- | |
| 42 | |
| 43 .. highlight:: json | |
| 44 | |
| 45 On Windows, the plugin is enabled by default. | |
| 46 | |
| 47 If you're using the ``osimis/orthanc`` docker image, you'll have | |
| 48 to define the WVB_ENABLED `environment variable <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages?-OsimisWebViewer>`__. | |
| 49 to ``true`` | |
| 50 | |
| 51 On Linux, the Osimis Web viewer will only work with LSB orthanc binaries | |
| 52 that can be downloaded from `here <https://lsb.orthanc-server.com/>`__ and | |
| 53 that will work with most recent Linux distros. | |
| 54 | |
| 55 Once Orthanc is installed, you must change the :ref:`configuration file | |
| 56 <configuration>` to tell Orthanc where it can find the plugin: This is | |
| 57 done by properly modifying the ``Plugins`` option. You could for | |
| 58 instance use the following configuration file:: | |
| 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 | |
| 76 the demonstration video on `official homepage of the plugin | |
| 77 <https://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. | |
| 78 | |
| 79 Advanced options | |
| 80 ---------------- | |
| 81 | |
| 82 .. highlight:: json | |
| 83 | |
| 84 The configuration of the Web viewer can be fine-tuned by adding some in | |
| 85 the `configuration file <https://bitbucket.org/osimis/osimis-webviewer-plugin/src/master/doc/default-configuration.json>`__. | |
| 86 | |
| 87 FAQ | |
| 88 --- | |
| 89 | |
| 90 - **What video formats are supported by the Osimis Web Viewer ?** | |
| 91 | |
| 92 The set of codecs supported by the Osimis Viewer is an intersection of the sets of codecs supported by | |
| 93 the `DICOM standard <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__ | |
| 94 and those supported by the `web browsers <https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats>`__. | |
| 95 In short, this mostly comes down to just MPEG-4. | |
| 96 | |
| 97 - **Where are the annotations stored ?** | |
| 98 | |
| 305 | 99 Annotations are stored in :ref:`metadata <metadata>` (id ``9999``) in a custom format. Note that annotation |
| 303 | 100 storage is disabled by default and can be enabled by setting ``"AnnotationStorageEnabled": true`` |
| 101 in the configuration file. | |
| 102 | |
| 103 | |
| 104 | |
| 105 CE marking | |
| 106 ---------- | |
| 107 | |
| 108 Legally, in Europe, the Osimis Web viewer can not be used for medical usage unless you | |
| 304 | 109 purchase the `CE marked version by Osimis <https://www.osimis.io/en/services.html>`__. |
| 303 | 110 If you're outside Europe, you should check your local regulation but it's most likely |
| 111 that you're not allowed to use it for medical usage as well. | |
| 112 | |
| 113 Although the free and open source version of the Osimis Web viewer offers the same feature scope, | |
| 114 CE marking requires a "supplier-end user" agreement in which the supplier guarantees that: | |
| 115 | |
| 116 - the viewer has been tested for medical use against all possible patient risk, | |
| 117 - the end user receives regular updates on new features and bug fixes, | |
| 118 - the end user can be informed of any bug in the medical device. | |
| 119 |