Mercurial > hg > orthanc-book

annotate Sphinx/source/plugins/volview.rst @ 945:11d7d30ca273

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