Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/volview.rst @ 925:897903f8deb8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added volview plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 24 Mar 2023 15:11:02 +0100
parents
children 6e61cb5edf4c
comparison
equal deleted inserted replaced
924:c9d2ae104b1b 925:897903f8deb8
1 .. _volview:
2
3
4 Kitware's VolView plugin
5 ========================
6
7 .. contents::
8
9 This **official** plugin by the `ICTEAM institute of UCLouvain
10 <https://uclouvain.be/en/research-institutes/icteam>`__ extends
11 Orthanc with `Kitware's VolView <https://volview.kitware.com/>`__ Web
12 interface for cinematic volume rendering of DICOM data.
13
14
15 Usage
16 -----
17
18 This plugin adds a dedicated button to Orthanc Explorer, which
19 provides an easy access to VolView (click on the image to view a demo
20 video):
21
22 .. image:: ../images/VolView.png
23 :align: center
24 :width: 800
25 :target: https://www.youtube.com/watch?v=taQ6TiFJTHE
26 |
27
28 Starting with its release 0.8.0, the :ref:`Orthanc Explorer 2
29 <orthanc-explorer-2>` plugin also provides a button to open VolView.
30
31 Compilation
32 -----------
33
34 .. highlight:: bash
35
36 Official releases can be `downloaded from the Orthanc homepage
37 <https://www.orthanc-server.com/browse.php?path=/plugin-volview>`__. As
38 an alternative, the `repository containing the source code
39 <https://orthanc.uclouvain.be/hg/orthanc-volview/>`__ can be accessed using
40 Mercurial.
41
42 The procedure to compile this plugin is similar of that for the
43 :ref:`core of Orthanc <binaries>`. The following commands should work
44 on most GNU/Linux distributions, provided Docker is installed::
45
46 $ mkdir Build
47 $ cd Build
48 $ ../Resources/CreateVolViewDist.sh
49 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
50 $ make
51
52 The compilation will produce a shared library ``libOrthancVolView.so``
53 that contains the VolView plugin for Orthanc.
54
55 Pre-compiled Linux Standard Base (LSB) binaries `are available for
56 download <https://lsb.orthanc-server.com/plugin-volview/>`__.
57
58 Pre-compiled binaries for Microsoft Windows and macOS `are also
59 available
60 <https://www.orthanc-server.com/browse.php?path=/plugin-volview>`__.
61
62 Furthermore, the :ref:`Docker images <docker>`
63 ``jodogne/orthanc-plugins`` and ``osimis/orthanc`` also contain the
64 plugin. Debian and Ubuntu packages can be found in the
65 :ref:`standalone repository <binaries>`
66 ``https://debian.orthanc-labs.com/``.
67
68
69 Configuration
70 -------------
71
72 .. highlight:: json
73
74 Here is a minimal sample :ref:`configuration file <configuration>` to
75 use this plugin::
76
77 {
78 "Plugins" : [
79 "/home/user/OrthancVolView/Build/libOrthancVolView.so"
80 ]
81 }
82
83 Orthanc must of course be restarted after the modification of its
84 configuration file.