Mercurial > hg > orthanc-book
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 |
| rev | line source |
|---|---|
| 925 | 1 .. _volview: |
| 2 | |
| 3 | |
| 4 Kitware's VolView plugin | |
| 5 ======================== | |
| 6 | |
| 7 .. contents:: | |
| 8 | |
| 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 | 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 | 17 |
| 18 Usage | |
| 19 ----- | |
| 20 | |
| 21 This plugin adds a dedicated button to Orthanc Explorer, which | |
| 22 provides an easy access to VolView (click on the image to view a demo | |
| 23 video): | |
| 24 | |
| 25 .. image:: ../images/VolView.png | |
| 26 :align: center | |
| 27 :width: 800 | |
| 28 :target: https://www.youtube.com/watch?v=taQ6TiFJTHE | |
| 974 | 29 |
| 925 | 30 | |
| 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 | 39 |
| 40 Compilation | |
| 41 ----------- | |
| 42 | |
| 43 .. highlight:: bash | |
| 44 | |
| 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 | 47 an alternative, the `repository containing the source code |
| 48 <https://orthanc.uclouvain.be/hg/orthanc-volview/>`__ can be accessed using | |
| 49 Mercurial. | |
| 50 | |
| 51 The procedure to compile this plugin is similar of that for the | |
| 52 :ref:`core of Orthanc <binaries>`. The following commands should work | |
| 53 on most GNU/Linux distributions, provided Docker is installed:: | |
| 54 | |
| 55 $ mkdir Build | |
| 56 $ cd Build | |
| 57 $ ../Resources/CreateVolViewDist.sh | |
| 58 $ cmake .. -DSTATIC_BUILD=ON -DCMAKE_BUILD_TYPE=Release | |
| 59 $ make | |
| 60 | |
| 61 The compilation will produce a shared library ``libOrthancVolView.so`` | |
| 62 that contains the VolView plugin for Orthanc. | |
| 63 | |
| 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 | 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 | 69 |
| 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 | 72 plugin. Debian and Ubuntu packages can be found in the |
| 73 :ref:`standalone repository <binaries>` | |
| 74 ``https://debian.orthanc-labs.com/``. | |
| 75 | |
| 76 | |
| 77 Configuration | |
| 78 ------------- | |
| 79 | |
| 80 .. highlight:: json | |
| 81 | |
| 82 Here is a minimal sample :ref:`configuration file <configuration>` to | |
| 83 use this plugin:: | |
| 84 | |
| 85 { | |
| 86 "Plugins" : [ | |
| 87 "/home/user/OrthancVolView/Build/libOrthancVolView.so" | |
| 88 ] | |
| 89 } | |
| 90 | |
| 91 Orthanc must of course be restarted after the modification of its | |
| 92 configuration file. |