Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/webviewer.rst @ 414:83f36bc9e725

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
gdcm plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 15 May 2020 16:35:22 +0200
parents 84e3a2612c36
children d3d0696c2258
comparison
equal deleted inserted replaced
411:b4cc2b6a9f13 414:83f36bc9e725
15 Compilation 15 Compilation
16 ----------- 16 -----------
17 17
18 .. highlight:: bash 18 .. highlight:: bash
19 19
20 The procedure to compile these plugins is similar of that for the 20 The procedure to compile this plugin is similar of that for the
21 :ref:`core of Orthanc <binaries>`. The following commands should work 21 :ref:`core of Orthanc <binaries>`. The following commands should work
22 for every UNIX-like distribution (including GNU/Linux):: 22 for every UNIX-like distribution (including GNU/Linux)::
23 23
24 $ mkdir Build 24 $ mkdir Build
25 $ cd Build 25 $ cd Build
31 Microsoft Windows `are also available 31 Microsoft Windows `are also available
32 <https://www.orthanc-server.com/browse.php?path=/plugin-webviewer>`__. 32 <https://www.orthanc-server.com/browse.php?path=/plugin-webviewer>`__.
33 33
34 *Remark:* Some older build instructions are also available in the 34 *Remark:* Some older build instructions are also available in the
35 `source distribution 35 `source distribution
36 <https://hg.orthanc-server.com/orthanc-webviewer/file/tip/Resources/BuildInstructions.txt>`__. 36 <https://hg.orthanc-server.com/orthanc-webviewer/file/default/Resources/BuildInstructions.txt>`__.
37 37
38 38
39 Usage 39 Usage
40 ----- 40 -----
41 41
94 "/home/user/OrthancWebViewer/Build/libOrthancWebViewer.so" 94 "/home/user/OrthancWebViewer/Build/libOrthancWebViewer.so"
95 ], 95 ],
96 "WebViewer" : { 96 "WebViewer" : {
97 "CachePath" : "WebViewerCache", 97 "CachePath" : "WebViewerCache",
98 "CacheSize" : 10, 98 "CacheSize" : 10,
99 "Threads" : 4, 99 "Threads" : 4
100 "EnableGdcm" : false
101 } 100 }
102 } 101 }
103 102
104 * ``CachePath`` specifies the location of the cache of the Web 103 * ``CachePath`` specifies the location of the cache of the Web
105 viewer. By default, the cache is located inside the storage 104 viewer. By default, the cache is located inside the storage
106 directory of Orthanc. 105 directory of Orthanc.
107 * ``CacheSize`` specifies the maximum size for the cached images, in 106 * ``CacheSize`` specifies the maximum size for the cached images, in
108 megabytes. By default, a cache of 100 MB is used. 107 megabytes. By default, a cache of 100 MB is used.
109 * ``Threads`` specifies the number of threads that are used by the 108 * ``Threads`` specifies the number of threads that are used by the
110 plugin to decode the DICOM images. 109 plugin to decode the DICOM images.
111 * ``EnableGdcm`` specifies whether `GDCM 110
111
112 Old advanced options (up to 2.5)
113 --------------------------------
114
115 Up to release 2.5 of the Orthanc Web Viewer plugin, the plugin was
116 shipping a decoder of DICOM images using the GDCM library. In May
117 2020, the support of GDCM has been :ref:`moved as a separate plugin
118 <gdcm>`. As a consequence, releases up to 2.5 had two more advanced
119 options, that were removed starting with version 3.0:
120
121 * ``EnableGdcm`` specified whether `GDCM
112 <https://sourceforge.net/projects/gdcm/>`__ should be used to decode 122 <https://sourceforge.net/projects/gdcm/>`__ should be used to decode
113 DICOM images, replacing the built-in decoder of Orthanc that 123 DICOM images, replacing the built-in decoder of Orthanc that
114 internally uses `DCMTK <https://dicom.offis.de/dcmtk.php.en>`__. 124 internally uses `DCMTK <https://dicom.offis.de/dcmtk.php.en>`__.
115 This is notably necessary to deal with DICOM images encoded using 125 This was notably necessary to deal with DICOM images encoded using
116 `JPEG2000 <https://en.wikipedia.org/wiki/JPEG_2000>`__, as this 126 `JPEG2000 <https://en.wikipedia.org/wiki/JPEG_2000>`__, as this
117 format is not readily supported by the core version of DCMTK. By 127 format is not readily supported by the core version of DCMTK. By
118 default, this option is set to ``true``. 128 default, this option was set to ``true``.
119 129
120 As a complement to the ``EnableGdcm`` option, you also have the 130 * As a complement to the ``EnableGdcm`` option, it was also possible
121 possibility to restrict the GDCM decoder to some specific `transfer 131 to restrict the GDCM decoder to some specific `transfer syntaxes
122 syntaxes 132 <http://dicom.nema.org/medical/dicom/current/output/html/part05.html#chapter_10>`__
123 <http://dicom.nema.org/medical/dicom/current/output/html/part05.html#chapter_10>`__ 133 using the ``RestrictTransferSyntaxes`` option.
124 using the ``RestrictTransferSyntaxes`` option. For instance, the 134
125 following configuration would use GDCM to decode JPEG 2000 images, 135
126 while using DCMTK to decode the other transfer syntaxes:: 136 .. highlight:: json
137
138 For instance, the following configuration would enable GDCM to decode
139 JPEG 2000 images, while using DCMTK to decode the other transfer
140 syntaxes::
127 141
128 { 142 {
129 [...] 143 [...]
130 "WebViewer" : { 144 "WebViewer" : {
131 "EnableGdcm" : true, 145 "EnableGdcm" : true,