Mercurial > hg > orthanc-book
annotate Sphinx/source/plugins/osimis-webviewer.rst @ 334:5e2bf921f09c
removed CE marking for Osimis PRO viewer
| author | Alain Mazy <alain@mazy.be> |
|---|---|
| date | Wed, 18 Mar 2020 10:07:59 +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 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 | |
| 27 For Linux users, you'll find it in the `osimis/orthanc <https://hub.docker.com/repository/docker/osimis/orthanc>`__ | |
| 28 docker images or you can download the LSB binary `here <http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.3.1/libOsimisWebViewer.so>`__. | |
| 29 | |
| 30 The compilation process is quite complex since it requires to build | |
| 31 first the frontend and then the backend. All information can be found | |
| 32 in the `source code | |
| 33 <https://bitbucket.org/osimis/osimis-webviewer-plugin>`__. | |
| 34 | |
| 35 | |
| 36 Usage | |
| 37 ----- | |
| 38 | |
| 39 .. highlight:: json | |
| 40 | |
| 41 On Windows, the plugin is enabled by default. | |
| 42 | |
| 43 If you're using the ``osimis/orthanc`` docker image, you'll have | |
| 44 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>`__. | |
| 45 to ``true`` | |
| 46 | |
| 47 On Linux, the Osimis Web viewer will only work with LSB orthanc binaries | |
| 48 that can be downloaded from `here <https://lsb.orthanc-server.com/>`__ and | |
| 49 that will work with most recent Linux distros. | |
| 50 | |
| 51 Once Orthanc is installed, you must change the :ref:`configuration file | |
| 52 <configuration>` to tell Orthanc where it can find the plugin: This is | |
| 53 done by properly modifying the ``Plugins`` option. You could for | |
| 54 instance use the following configuration file:: | |
| 55 | |
| 56 { | |
| 57 "Name" : "MyOrthanc", | |
| 58 [...] | |
| 59 "Plugins" : [ | |
| 60 "/home/user/xxx/Downloads/libOsimisWebViewer.so" | |
| 61 ] | |
| 62 } | |
| 63 | |
| 64 .. highlight:: text | |
| 65 | |
| 66 Orthanc must of course be restarted after the modification of its | |
| 67 configuration file. | |
| 68 | |
| 69 Once a :ref:`DICOM study <model-world>` is opened using Orthanc | |
| 70 Explorer, a yellow button entitled ``Osimis Web Viewer`` will show | |
| 71 up. It will open the Web viewer for that particular study. See also | |
| 72 the demonstration video on `official homepage of the plugin | |
| 73 <https://www.orthanc-server.com/static.php?page=osimis-web-viewer>`__. | |
| 74 | |
| 75 Advanced options | |
| 76 ---------------- | |
| 77 | |
| 78 .. highlight:: json | |
| 79 | |
| 80 The configuration of the Web viewer can be fine-tuned by adding some in | |
| 81 the `configuration file <https://bitbucket.org/osimis/osimis-webviewer-plugin/src/master/doc/default-configuration.json>`__. | |
| 82 | |
| 83 FAQ | |
| 84 --- | |
| 85 | |
|
334
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
86 - **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
|
87 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
88 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
|
89 However, the viewer can be used by: |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
90 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
91 - Patients |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
92 - 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
|
93 - 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
|
94 - Researchers |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
95 - Teachers |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
96 |
|
5e2bf921f09c
removed CE marking for Osimis PRO viewer
Alain Mazy <alain@mazy.be>
parents:
305
diff
changeset
|
97 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
|
98 |
| 303 | 99 - **What video formats are supported by the Osimis Web Viewer ?** |
| 100 | |
| 101 The set of codecs supported by the Osimis Viewer is an intersection of the sets of codecs supported by | |
| 102 the `DICOM standard <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__ | |
| 103 and those supported by the `web browsers <https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats>`__. | |
| 104 In short, this mostly comes down to just MPEG-4. | |
| 105 | |
| 106 - **Where are the annotations stored ?** | |
| 107 | |
| 305 | 108 Annotations are stored in :ref:`metadata <metadata>` (id ``9999``) in a custom format. Note that annotation |
| 303 | 109 storage is disabled by default and can be enabled by setting ``"AnnotationStorageEnabled": true`` |
| 110 in the configuration file. | |
| 111 |