Mercurial > hg > orthanc-book

changeset 549:109c043907a1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documenting the Stone Web viewer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 02 Dec 2020 17:44:10 +0100
parents 654e1614cec1
children 2c7d6586717b
files Sphinx/source/plugins.rst Sphinx/source/plugins/osimis-webviewer.rst Sphinx/source/plugins/stone-webviewer.rst Sphinx/source/users/docker-osimis.rst
diffstat 4 files changed, 185 insertions(+), 31 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins.rst	Sun Nov 22 10:40:34 2020 +0100
+++ b/Sphinx/source/plugins.rst	Wed Dec 02 17:44:10 2020 +0100
@@ -3,17 +3,6 @@
 Plugins
 =======
 
-.. toctree::
-   :hidden:
-
-   plugins/authorization.rst
-   plugins/google-cloud-platform.rst
-   plugins/mysql.rst
-   plugins/object-storage.rst
-   plugins/osimis-webviewer.rst
-   plugins/python.rst
-   plugins/transfers.rst
-
 .. contents::
 
 Overview
@@ -49,8 +38,8 @@
 Index of the official plugins
 -----------------------------
 
-From University Hospital of Liège
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+From Osimis and University Hospital of Liège
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. toctree::
    :maxdepth: 1
@@ -62,19 +51,23 @@
    plugins/worklists-plugin.rst
    plugins/serve-folders.rst
    plugins/gdcm.rst
+   plugins/stone-webviewer.rst
 
 .. _plugins-osimis:
    
 From Osimis
 ^^^^^^^^^^^
 
-* :ref:`osimis_webviewer`
-* :ref:`mysql`
-* :ref:`authorization`
-* :ref:`transfers`
-* :ref:`google`    
-* :ref:`python-plugin` 
-* :ref:`object-storage`   
+.. toctree::
+   :maxdepth: 1
+
+   plugins/osimis-webviewer.rst
+   plugins/mysql.rst
+   plugins/authorization.rst
+   plugins/transfers.rst
+   plugins/google-cloud-platform.rst    
+   plugins/python.rst 
+   plugins/object-storage.rst   
 
 .. _plugins-contributed:
 
--- a/Sphinx/source/plugins/osimis-webviewer.rst	Sun Nov 22 10:40:34 2020 +0100
+++ b/Sphinx/source/plugins/osimis-webviewer.rst	Wed Dec 02 17:44:10 2020 +0100
@@ -1,8 +1,8 @@
 .. _osimis_webviewer:
 
 
-Osimis Web Viewer plugin
-========================
+Osimis Web Viewer plugin (deprecated)
+=====================================
 
 .. contents::
 
@@ -24,11 +24,10 @@
 The Osimis Web viewer is part of the `Windows installers
 <https://www.orthanc-server.com/download-windows.php>`__.
 
-For Linux users, you'll find it in the `osimis/orthanc
-<https://osimis.atlassian.net/wiki/spaces/OKB/pages/26738689/How+to+use+osimis+orthanc+Docker+images>`__
-Docker images or you can download the LSB (Linux Standard Base)
-binaries `here
-<http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.3.1/libOsimisWebViewer.so>`__.
+For GNU/Linux users, you'll find it in the :ref:`osimis/orthanc
+<docker-osimis>` Docker images or you can download the LSB (Linux
+Standard Base) binaries `here
+<http://orthanc.osimis.io/lsb/plugin-osimis-webviewer/releases/1.4.1/libOsimisWebViewer.so>`__.
 
 The compilation process is quite complex since it requires to build
 first the frontend and then the backend.  All information can be found
@@ -44,9 +43,8 @@
 On Windows, the plugin is enabled by default and will work
 out-of-the-box.
 
-If you're using the ``osimis/orthanc`` Docker image, you'll have 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>`__
+If you're using the ``osimis/orthanc`` Docker images, you'll have to
+define the ``WVB_ENABLED`` :ref:`environment variable <docker-osimis>`
 to ``true``.
 
 On plain GNU/Linux distributions (i.e. if not using Docker), the
@@ -98,7 +96,7 @@
 
   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.
 
-  Check your local regulations to ensure you’re using it in a legal manner.
+  Check your local regulations to ensure you're using it in a legal manner.
 
 
 - **What video formats are supported by the Osimis Web Viewer ?**
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/plugins/stone-webviewer.rst	Wed Dec 02 17:44:10 2020 +0100
@@ -0,0 +1,161 @@
+.. _stone_webviewer:
+
+
+Stone Web Viewer plugin
+=======================
+
+.. contents::
+
+This plugin extends Orthanc with a Web viewer of medical images, with
+more advanced features than the basic :ref:`Orthanc Web viewer plugin
+<webviewer>`.
+
+For general information and a demonstration, check out the `official
+homepage of the plugin
+<https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
+Also `check out the source code
+<https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer>`__.
+
+
+How to get it
+-------------
+
+The Stone Web viewer is part of the `Windows installers
+<https://www.orthanc-server.com/download-windows.php>`__ (since
+release 20.12.0 of the installers).
+
+For GNU/Linux users, the Stone Web viewer is part of the
+:ref:`official Docker images <docker>`. Precompiled LSB binaries
+(Linux Standard Base) are `available as well
+<https://lsb.orthanc-server.com/stone-webviewer/>`__.
+
+The compilation process is quite complex since it requires using the
+`Emscripten <https://emscripten.org/>`__ compiler toolchain. The full
+build instructions are available in the `source code
+<https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/WebAssembly/NOTES.txt>`__.
+
+
+Usage
+-----
+
+On Microsoft Windows or if you are using the
+``jodogne/orthanc-plugins`` :ref:`Docker images <docker>`, the plugin
+is enabled by default and will work out-of-the-box.
+
+.. highlight:: bash
+
+The ``osimis/orthanc`` :ref:`Docker images <docker-osimis>` are more
+suited to devops need, as they allow to start a minimal Docker
+environment as follows::
+
+  $ docker run -p 4242:4242 -p 8042:8042 -e STONE_WEB_VIEWER_PLUGIN_ENABLED=true -e DICOM_WEB_PLUGIN_ENABLED=true --rm osimis/orthanc:20.12.0
+
+
+.. highlight:: json
+
+On plain GNU/Linux distributions (i.e. if not using Docker), the Stone
+Web viewer will only work with the LSB binaries (Linux Standard Base)
+of the Orthanc server that can be downloaded from `here
+<https://lsb.orthanc-server.com/orthanc/>`__ (this setup will work
+with most recent GNU/Linux distributions). The Stone Web viewer also
+requires the `DICOMweb plugin
+<https://lsb.orthanc-server.com/plugin-dicom-web/>`__ to be installed.
+
+Once the binaries are installed, you must change the
+:ref:`configuration file <configuration>` to tell Orthanc where it can
+find the plugin: This is done by properly modifying the ``Plugins``
+option. You could for instance use the following configuration file::
+
+  {
+    "Name" : "MyOrthanc",
+    [...]
+    "Plugins" : [
+      "/home/user/xxx/Downloads/libStoneWebViewer.so",
+      "/home/user/xxx/Downloads/libOrthancDicomWeb.so"
+    ]
+  }
+
+.. highlight:: text
+
+Orthanc must of course be restarted after the modification of its
+configuration file. 
+
+Once a :ref:`DICOM study <model-world>` is opened using Orthanc
+Explorer, a yellow button entitled ``Stone Web Viewer`` will show
+up. It will open the Web viewer for that particular study.  See also
+the interactive demonstration on the `official homepage of the plugin
+<https://www.orthanc-server.com/static.php?page=stone-web-viewer>`__.
+
+Advanced options
+----------------
+
+.. highlight:: json
+
+The configuration of the Web viewer can be fine-tuned by adapting some
+options in the `configuration file
+<https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/WebApplication/configuration.json>`__.
+
+FAQ
+---
+
+- **Can I use the Stone Viewer in a medical environment?**
+
+  The Stone Viewer is not a Medical Device; it is not CE marked or FDA
+  approved. The Stone Viewer is free and open-source software that
+  cannot be used for diagnostic or therapeutic purposes.
+
+  However, the viewer can be used as a communication tool that allows
+  researchers, teachers, technicians, medical physicists, general
+  practitioner or patients to visualize medical images for information
+  only.
+
+  Check out your local regulations to ensure you're using it in a
+  legal manner.
+
+
+- **What video formats are supported by the Stone Web Viewer?**
+
+  The set of codecs supported by the Stone Viewer is an intersection
+  of the sets of codecs supported by the `DICOM standard
+  <http://dicom.nema.org/medical/dicom/current/output/chtml/part05/PS3.5.html>`__
+  and those supported by the `web browsers
+  <https://developer.mozilla.org/en-US/docs/Web/Media/Formats>`__.
+  In short, this mostly comes down to just MPEG-4.
+
+  Note that video playing is not supported using the plain DICOMweb
+  protocol: The Stone Web viewer will use the :ref:`REST API of
+  Orthanc <rest>` to play videos.
+  
+- **How do Osimis Web viewer and Stone Web viewer compare?**
+
+  The two viewers use a very similar user interface. However, their
+  internal architecture is totally different:
+
+  - Stone Web viewer is a combination of C++, :ref:`Stone of Orthanc
+    <stone>`, WebAssembly, DICOMweb and Vue.js.
+
+  - Osimis Web viewer is a combination of JavaScript, `Cornerstone
+    <https://cornerstonejs.org/>`__, :ref:`Orthanc REST API <rest>`
+    and Angular.
+    
+  The Osimis Web viewer is deprecated and superseded by the Stone Web
+  viewer, as the Stone of Orthanc library allows to use a single C++
+  codebase between mobile apps, desktop software and Web applications.
+
+  Some features from the Osimis Web viewer are not available (yet),
+  such as creating custom annotations or the Live Share feature.
+
+- **How can I migrate from Osimis Web viewer to Stone Web viewer?**
+
+  Full instructions are provided in the `source distribution
+  <https://hg.orthanc-server.com/orthanc-stone/file/default/Applications/StoneWebViewer/NOTES.txt>`__.
+
+- **What are the future plans?**
+
+  The use of :ref:`Stone of Orthanc library <stone>` gives us a lot of
+  flexibility to implement new advanced features, such as 3D rendering
+  (MPR, reslicing, image fusion...) and DICOM-RT support.
+
+  We are looking for :ref:`industrial sponsors <contributing>` to
+  implement such new features in the Stone Web viewer.
+  
--- a/Sphinx/source/users/docker-osimis.rst	Sun Nov 22 10:40:34 2020 +0100
+++ b/Sphinx/source/users/docker-osimis.rst	Wed Dec 02 17:44:10 2020 +0100
@@ -287,6 +287,8 @@
 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
 | **OrthancWebViewer**                             | ``ORTHANC_WEB_VIEWER_PLUGIN_ENABLED``            |                                                                                                    |
 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
+| **StoneWebViewer**                               | ``ORTHANC_STONE_VIEWER_PLUGIN_ENABLED``          |                                                                                                    |
++--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
 | **OsimisWebViewerBasic**                         | ``OSIMIS_WEB_VIEWER1_PLUGIN_ENABLED``            |                                                                                                    |
 +--------------------------------------------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------+
 | **OsimisWebViewerBasicAlpha**                    | ``OSIMIS_WEB_VIEWER1_ALPHA_PLUGIN_ENABLED``      |                                                                                                    |