Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/dicomweb.rst @ 318:83d822f11e78

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
SeriesMetadata and StudiesMetadata in DICOMweb
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 17 Feb 2020 16:14:33 +0100
parents 0078d465c768
children 42104307e838
comparison
equal deleted inserted replaced
317:65a29c2fe22c 318:83d822f11e78
96 96
97 97
98 Options 98 Options
99 ------- 99 -------
100 100
101
102 .. _dicomweb-server-config:
103
101 Server-related options 104 Server-related options
102 ^^^^^^^^^^^^^^^^^^^^^^ 105 ^^^^^^^^^^^^^^^^^^^^^^
103 106
104 .. highlight:: json 107 .. highlight:: json
105 108
115 "Root" : "/dicom-web/", // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS) 118 "Root" : "/dicom-web/", // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS)
116 "EnableWado" : true, // Whether WADO-URI (previously known as WADO) support is enabled 119 "EnableWado" : true, // Whether WADO-URI (previously known as WADO) support is enabled
117 "WadoRoot" : "/wado", // Root URI of the WADO-URI (aka. WADO) API 120 "WadoRoot" : "/wado", // Root URI of the WADO-URI (aka. WADO) API
118 "Ssl" : false, // Whether HTTPS should be used for subsequent WADO-RS requests 121 "Ssl" : false, // Whether HTTPS should be used for subsequent WADO-RS requests
119 "QidoCaseSensitive" : true, // For QIDO-RS server, whether search is case sensitive (since release 0.5) 122 "QidoCaseSensitive" : true, // For QIDO-RS server, whether search is case sensitive (since release 0.5)
120 "Host" : "localhost" // Hard-codes the name of the host for subsequent WADO-RS requests (deprecated) 123 "Host" : "localhost", // Hard-codes the name of the host for subsequent WADO-RS requests (deprecated)
124 "StudiesMetadata" : "Full", // How study-level metadata is retrieved ("Full" or "MainDicomTags", since 1.1)
125 "SeriesMetadata" : "Full" // How series-level metadata is retrieved ("Full" or "MainDicomTags", since 1.1)
121 } 126 }
122 } 127 }
123 128
124 Furthermore, the global option ``DefaultEncoding`` specifies the 129 Furthermore, the global option ``DefaultEncoding`` specifies the
125 encoding (specific character set) that will be used when answering a 130 encoding (specific character set) that will be used when answering a
126 QIDO-RS request. It might be a good idea to set this option to 131 QIDO-RS request. It might be a good idea to set this option to
127 ``Utf8`` if you are dealing with an international environment. 132 ``Utf8`` if you are dealing with an international environment.
128 133
129 The following configuration options were present in releases <= 0.6 of the plugin, 134
130 but are not used anymore:: 135 The options ``StudiesMetadata`` and ``SeriesMetadata`` were introduced
136 in release 1.1 of the DICOMweb plugin. These options specify how the
137 calls to ``/dicom-web/studies/.../metadata`` and
138 ``/dicom-web/studies/.../series/.../metadata`` (i.e. `WADO-RS Retrieve
139 Metadata
140 <http://dicom.nema.org/medical/dicom/2019a/output/chtml/part18/sect_6.5.6.html>`__)
141 are processed:
142
143 * If ``Full`` mode is used, the plugin will have to read all the DICOM
144 instances of the study/series from the :ref:`storage area
145 <orthanc-storage>`, which gives exact results but requires all the
146 individual instances to be read and parsed from the filesystem,
147 leading to bad performance (cf. `issue 162
148 <https://bitbucket.org/sjodogne/orthanc/issues/162/dicomweb-metadata-resource-reads-all>`__).
149 This is the default mode.
150
151 * If ``MainDicomTags`` mode is used, the plugin will only report the
152 main DICOM tags that are stored inside the Orthanc database index.
153 The DICOM files are not read from the disk, which provides very good
154 performance. However, this is a small subset of all the tags that
155 would be retrieved if using the ``Full`` mode: A DICOMweb viewer
156 might need more tags.
157
158 * *Work-in-progress:* In the future, another mode might be introduced
159 for the series level, that would assume that the value of some
160 non-main DICOM tags is constant across all the instances of the
161 series. It would then be sufficient for the DICOMweb plugin to only
162 read one instance from the series. This mode would be a compromise
163 between ``MainDicomTags`` (focus on speed) and ``Full`` (focus on
164 accuracy). This mode is still under active investigation, as it
165 might silently break DICOMweb viewers.
166
167 * If you are using a DICOMweb viewer (such as forthcoming Stone Web
168 viewer or OHIF viewer) in a setup where performance is important,
169 you should most probably set ``StudiesMetadata`` to
170 ``MainDicomTags`` and ``SeriesMetadata`` to ``Full``.
171
172
173 **Remark 1:** The following configuration options were present in
174 releases <= 0.6 of the plugin, but are not used anymore::
131 175
132 { 176 {
133 [...] 177 [...]
134 "DicomWeb" : { 178 "DicomWeb" : {
135 "StowMaxInstances" : 10, // For STOW-RS client, the maximum number of instances in one single HTTP query (0 = no limit) 179 "StowMaxInstances" : 10, // For STOW-RS client, the maximum number of instances in one single HTTP query (0 = no limit)
140 These older configuration options were used to limit the size of the 184 These older configuration options were used to limit the size of the
141 HTTP requests, by issuing multiple calls to STOW-RS (set both options 185 HTTP requests, by issuing multiple calls to STOW-RS (set both options
142 to 0 to send one single request). 186 to 0 to send one single request).
143 187
144 188
145 **Remark:** The option ``Host`` is deprecated. Starting with release 189 **Remark 2:** The option ``Host`` is deprecated. Starting with release
146 0.7 of the DICOMweb plugin, its value are computed from the standard 190 0.7 of the DICOMweb plugin, its value are computed from the standard
147 HTTP headers ``Forwarded`` and ``Host``, as provided by the HTTP 191 HTTP headers ``Forwarded`` and ``Host``, as provided by the HTTP
148 clients. 192 clients.
149 193
150 194