Mercurial > hg > orthanc-book
diff Sphinx/source/plugins/volview.rst @ 925:897903f8deb8
added volview plugin
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 24 Mar 2023 15:11:02 +0100 |
parents | |
children | 6e61cb5edf4c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Sphinx/source/plugins/volview.rst Fri Mar 24 15:11:02 2023 +0100 @@ -0,0 +1,84 @@ +.. _volview: + + +Kitware's VolView plugin +======================== + +.. contents:: + +This **official** plugin by the `ICTEAM institute of UCLouvain +<https://uclouvain.be/en/research-institutes/icteam>`__ extends +Orthanc with `Kitware's VolView <https://volview.kitware.com/>`__ Web +interface for cinematic volume rendering of DICOM data. + + +Usage +----- + +This plugin adds a dedicated button to Orthanc Explorer, which +provides an easy access to VolView (click on the image to view a demo +video): + +.. image:: ../images/VolView.png + :align: center + :width: 800 + :target: https://www.youtube.com/watch?v=taQ6TiFJTHE +| + +Starting with its release 0.8.0, the :ref:`Orthanc Explorer 2 +<orthanc-explorer-2>` plugin also provides a button to open VolView. + +Compilation +----------- + +.. highlight:: bash + +Official releases can be `downloaded from the Orthanc homepage +<https://www.orthanc-server.com/browse.php?path=/plugin-volview>`__. As +an alternative, the `repository containing the source code +<https://orthanc.uclouvain.be/hg/orthanc-volview/>`__ can be accessed using +Mercurial. + +The procedure to compile this plugin is similar of that for the +:ref:`core of Orthanc <binaries>`. The following commands should work +on most GNU/Linux distributions, provided Docker is installed:: + + $ mkdir Build + $ cd Build + $ ../Resources/CreateVolViewDist.sh + $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release + $ make + +The compilation will produce a shared library ``libOrthancVolView.so`` +that contains the VolView plugin for Orthanc. + +Pre-compiled Linux Standard Base (LSB) binaries `are available for +download <https://lsb.orthanc-server.com/plugin-volview/>`__. + +Pre-compiled binaries for Microsoft Windows and macOS `are also +available +<https://www.orthanc-server.com/browse.php?path=/plugin-volview>`__. + +Furthermore, the :ref:`Docker images <docker>` +``jodogne/orthanc-plugins`` and ``osimis/orthanc`` also contain the +plugin. Debian and Ubuntu packages can be found in the +:ref:`standalone repository <binaries>` +``https://debian.orthanc-labs.com/``. + + +Configuration +------------- + +.. highlight:: json + +Here is a minimal sample :ref:`configuration file <configuration>` to +use this plugin:: + + { + "Plugins" : [ + "/home/user/OrthancVolView/Build/libOrthancVolView.so" + ] + } + +Orthanc must of course be restarted after the modification of its +configuration file.