Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/webviewer.rst @ 28:dc235678897c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
webviewer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 20 Jul 2016 10:48:43 +0200
parents c23f02a64caf
children 1a6c863cf364
comparison
equal deleted inserted replaced
27:c23f02a64caf 28:dc235678897c
8 8
9 This **official** plugin extends Orthanc with a Web viewer of medical images. 9 This **official** plugin extends Orthanc with a Web viewer of medical images.
10 10
11 For general information, check out the `official homepage of the 11 For general information, check out the `official homepage of the
12 plugin <http://www.orthanc-server.com/static.php?page=web-viewer>`__. 12 plugin <http://www.orthanc-server.com/static.php?page=web-viewer>`__.
13
14
15 Compilation
16 -----------
17
18 .. highlight:: text
19
20 The procedure to compile these plugins is similar of that for the
21 :ref:`core of Orthanc <compiling>`. The following commands should work
22 for every UNIX-like distribution (including GNU/Linux)::
23
24 $ mkdir Build
25 $ cd Build
26 $ cmake .. -DSTATIC_BUILD=ON
27 $ make
28
29 The compilation will produce a shared library ``OrthancWebViewer``
30 that contains the Web viewer plugin. Pre-compiled binaries for
31 Microsoft Windows `are also available
32 <http://www.orthanc-server.com/browse.php?path=/plugin-webviewer>`__.
33
34
35 Usage
36 -----
37
38 .. highlight:: json
39
40 You of course first have to :ref:`install Orthanc <compiling>`. Once
41 Orthanc is installed, you must change the :ref:`configuration file
42 <configuration>` to tell Orthanc where it can find the plugin: This is
43 done by properly modifying the ``Plugins`` option. You could for
44 instance use the following configuration file::
45
46 {
47 "Name" : "MyOrthanc",
48 [...]
49 "Plugins" : [
50 "/home/user/OrthancWebViewer/Build/libOrthancWebViewer.so"
51 ]
52 }
53
54 .. highlight:: text
55
56 Orthanc must of course be restarted after the modification of its
57 configuration file. The log will contain an output similar to::
58
59 # Orthanc ./Configuration.json
60 W0226 16:59:10.480226 7906 main.cpp:636] Orthanc version: mainline
61 [...]
62 W0226 16:59:10.519664 7906 PluginsManager.cpp:258] Registering plugin 'web-viewer' (version 1.0)
63 W0226 16:59:10.519696 7906 PluginsManager.cpp:148] Initializing the Web viewer
64 W0226 16:59:10.520004 7906 PluginsManager.cpp:148] Web viewer using 6 threads for the decoding of the DICOM images
65 W0226 16:59:10.520021 7906 PluginsManager.cpp:148] Storing the cache of the Web viewer in folder: OrthancStorage/WebViewerCache
66 W0226 16:59:10.522011 7906 PluginsManager.cpp:148] Web viewer using a cache of 100 MB
67 [...]
68 W0226 16:59:10.530807 7906 main.cpp:516] HTTP server listening on port: 8042
69 W0226 16:59:10.581029 7906 main.cpp:526] DICOM server listening on port: 4242
70 W0226 16:59:10.581066 7906 main.cpp:533] Orthanc has started
71
72 Once a :ref:`DICOM series <model-world>` is opened using Orthanc
73 Explorer, a yellow button entitled ``Orthanc Web Viewer`` will show
74 up. It will open the Web viewer for that particular series. See also
75 the demonstration video on `official homepage of the plugin
76 <http://www.orthanc-server.com/static.php?page=web-viewer>`__.
77
78
79 Advanced options
80 ----------------
81
82 .. highlight:: json
83
84 The configuration of the Web viewer can be fine-tuned by adding some options::
85
86 {
87 "Name" : "MyOrthanc",
88 [...]
89 "Plugins" : [
90 "/home/user/OrthancWebViewer/Build/libOrthancWebViewer.so"
91 ],
92 "WebViewer" : {
93 "CachePath" : "WebViewerCache",
94 "CacheSize" : 10,
95 "Threads" : 4
96 }
97 }
98
99 * ``CachePath`` specifies the location of the cache of the Web
100 viewer. By default, the cache is located inside the storage
101 directory of Orthanc.
102 * ``CacheSize`` specifies the maximum size for the cached images, in
103 megabytes. By default, a cache of 100 MB is used.
104 * ``Threads`` specifies the number of threads that are used by the
105 plugin to decode the DICOM images.