annotate Sphinx/source/plugins/volview.rst @ 1113:a588960a72e5 default tip

spelling
author Alain Mazy <am@orthanc.team>
date Mon, 28 Oct 2024 09:23:08 +0100
parents 89bb195dfbc0
children
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
1056
89bb195dfbc0 starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1055
diff changeset
10 <https://orthanc.uclouvain.be/>`__ extends Orthanc with `Kitware's
89bb195dfbc0 starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1055
diff changeset
11 VolView <https://volview.kitware.com/>`__ Web interface for cinematic
89bb195dfbc0 starting stl documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1055
diff changeset
12 volume rendering of DICOM data.
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13
1055
ebe3214f3ab0 added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1023
diff changeset
14 **For researchers**: `Please cite this paper
ebe3214f3ab0 added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1023
diff changeset
15 <https://dial.uclouvain.be/pr/boreal/object/boreal:257257>`__.
ebe3214f3ab0 added citation instructions
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1023
diff changeset
16
925
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 Usage
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 -----
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 This plugin adds a dedicated button to Orthanc Explorer, which
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 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
23 video):
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 .. image:: ../images/VolView.png
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 :align: center
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 :width: 800
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 :target: https://www.youtube.com/watch?v=taQ6TiFJTHE
974
01f61385877f fix syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 926
diff changeset
29
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 |
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
926
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 925
diff changeset
32 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
33 <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
34
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 925
diff changeset
35
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 925
diff changeset
36 .. image:: ../images/VolView-OE2.png
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 925
diff changeset
37 :align: center
6e61cb5edf4c volview in oe2 and docker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 925
diff changeset
38 :width: 800
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 Compilation
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 -----------
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 .. highlight:: bash
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 Official releases can be `downloaded from the Orthanc homepage
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 974
diff changeset
46 <https://orthanc.uclouvain.be/downloads/sources/orthanc-volview/index.html>`__. As
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 an alternative, the `repository containing the source code
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 <https://orthanc.uclouvain.be/hg/orthanc-volview/>`__ can be accessed using
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 Mercurial.
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 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
52 :ref:`core of Orthanc <binaries>`. The following commands should work
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 on most GNU/Linux distributions, provided Docker is installed::
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 $ mkdir Build
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 $ cd Build
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 $ ../Resources/CreateVolViewDist.sh
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 $ make
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 The compilation will produce a shared library ``libOrthancVolView.so``
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 that contains the VolView plugin for Orthanc.
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 Pre-compiled Linux Standard Base (LSB) binaries `are available for
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 974
diff changeset
65 download <https://orthanc.uclouvain.be/downloads/linux-standard-base/orthanc-volview/index.html>`__.
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66
993
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 974
diff changeset
67 Pre-compiled binaries for `Microsoft Windows <https://orthanc.uclouvain.be/downloads/windows-32/orthanc-volview/index.html>`__
05b106383b2a migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 974
diff changeset
68 and `macOS <https://orthanc.uclouvain.be/downloads/macos/orthanc-volview/index.html>`__ are available as well.
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 Furthermore, the :ref:`Docker images <docker>`
1023
5d4701d8fe28 replaced osimis/orthanc by orthancteam/orthanc
Alain Mazy <am@osimis.io>
parents: 993
diff changeset
71 ``jodogne/orthanc-plugins`` and ``orthancteam/orthanc`` also contain the
925
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 plugin. Debian and Ubuntu packages can be found in the
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 :ref:`standalone repository <binaries>`
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 ``https://debian.orthanc-labs.com/``.
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 Configuration
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
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 .. highlight:: json
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 Here is a minimal sample :ref:`configuration file <configuration>` to
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 use this plugin::
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
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 "Plugins" : [
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 "/home/user/OrthancVolView/Build/libOrthancVolView.so"
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 ]
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 }
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 Orthanc must of course be restarted after the modification of its
897903f8deb8 added volview plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 configuration file.