Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/osimis-webviewer.rst @ 336:a5f7fc9fb611
Orthanc 1.6.0
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 18 Mar 2020 15:15:39 +0100 |
| parents | b7f045b23faa |
| children | 85524c571277 |
| 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 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
|
15 plugin |
|
b2baccb32101
page dedicated to the Osimis Web viewer plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 <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
|
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 | |
| 308 | 27 For Linux users, you'll find it in the `osimis/orthanc |
| 28 <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__ | |
| 29 Docker images or you can download the LSB (Linux Standard Base) | |
| 30 binaries `here | |
| 31 <http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.3.1/libOsimisWebViewer.so>`__. | |
| 303 | 32 |
| 33 The compilation process is quite complex since it requires to build | |
| 34 first the frontend and then the backend. All information can be found | |
| 35 in the `source code | |
| 36 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. | |
| 37 | |
| 38 | |
| 39 Usage | |
| 40 ----- | |
| 41 | |
| 42 .. highlight:: json | |
| 43 | |
| 308 | 44 On Windows, the plugin is enabled by default and will work |
| 45 out-of-the-box. | |
| 303 | 46 |
| 308 | 47 If you're using the ``osimis/orthanc`` Docker image, you'll have to |
| 48 define the WVB_ENABLED `environment variable | |
| 49 <https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images#Howtouseosimis/orthancDockerimages?-OsimisWebViewer>`__ | |
| 50 to ``true``. | |
| 303 | 51 |
| 308 | 52 On plain GNU/Linux distributions (i.e. if not using Docker), the |
| 53 Osimis Web viewer will only work with LSB (Linux Standard Base) | |
| 54 Orthanc binaries that can be downloaded from `here | |
| 55 <https://lsb.orthanc-server.com/orthanc/>`__ (that will work with most | |
| 56 recent GNU/Linux distributions). Once Orthanc is installed, you must | |
| 57 change the :ref:`configuration file <configuration>` to tell Orthanc | |
| 58 where it can find the plugin: This is done by properly modifying the | |
| 59 ``Plugins`` option. You could for instance use the following | |
| 60 configuration file:: | |
| 303 | 61 |
| 62 { | |
| 63 "Name" : "MyOrthanc", | |
| 64 [...] | |
| 65 "Plugins" : [ | |
| 66 "/home/user/xxx/Downloads/libOsimisWebViewer.so" | |
| 67 ] | |
| 68 } | |
| 69 | |
| 70 .. highlight:: text | |
| 71 | |
| 72 Orthanc must of course be restarted after the modification of its | |
| 73 configuration file. | |
| 74 | |
| 75 Once a :ref:`DICOM study <model-world>` is opened using Orthanc | |
| 76 Explorer, a yellow button entitled ``Osimis Web Viewer`` will show | |
| 77 up. It will open the Web viewer for that particular study. See also | |
| 308 | 78 the interactive demonstration on the `official homepage of the plugin |
| 303 | 79 <https://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. |
| 80 | |
| 81 Advanced options | |
| 82 ---------------- | |
| 83 | |
| 84 .. highlight:: json | |
| 85 | |
| 308 | 86 The configuration of the Web viewer can be fine-tuned by adapting some |
| 87 options in the `configuration file | |
| 88 <https://bitbucket.org/osimis/osimis-webviewer-plugin/src/master/doc/default-configuration.json>`__. | |
| 303 | 89 |
| 90 FAQ | |
| 91 --- | |
| 92 | |
|
334
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
93 - **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
|
94 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
95 The Osimis Viewer is not CE marked or FDA approved and can not be used to produce a diagnostic. |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
96 However, the viewer can be used by: |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
97 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
98 - Patients |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
99 - General practioner to explain a pathology to their patients |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
100 - Technicians to check the content/quality of studies |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
101 - Researchers |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
102 - Teachers |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
103 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
104 Check your local regulations to ensure you're using it in a legal manner. |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
105 |
| 303 | 106 - **What video formats are supported by the Osimis Web Viewer ?** |
| 107 | |
| 308 | 108 The set of codecs supported by the Osimis Viewer is an intersection |
| 109 of the sets of codecs supported by the `DICOM standard | |
| 110 <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__ | |
| 111 and those supported by the `web browsers | |
| 112 <https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats>`__. | |
| 303 | 113 In short, this mostly comes down to just MPEG-4. |
| 114 | |
| 115 - **Where are the annotations stored ?** | |
| 116 | |
| 308 | 117 Annotations are stored in :ref:`metadata <metadata>` (id ``9999``) |
| 118 in a custom format. Note that annotation storage is disabled by | |
| 119 default and can be enabled by setting ``"AnnotationStorageEnabled": | |
| 120 true`` in the configuration file. | |
| 303 | 121 |