orthanc-book: Sphinx/source/plugins/dicomweb.rst comparison

comparison Sphinx/source/plugins/dicomweb.rst @ 320:42104307e838

"Extrapolate" mode of DICOMweb plugin

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Fri, 21 Feb 2020 17:36:06 +0100
parents	83d822f11e78
children	89d4ee2e6e6e

comparison

equal deleted inserted replaced

-:be69f8c86f56
+:42104307e838
 "EnableWado" : true,        // Whether WADO-URI (previously known as WADO) support is enabled
 "WadoRoot" : "/wado",       // Root URI of the WADO-URI (aka. WADO) API
 "Ssl" : false,              // Whether HTTPS should be used for subsequent WADO-RS requests
 "QidoCaseSensitive" : true, // For QIDO-RS server, whether search is case sensitive (since release 0.5)
 "Host" : "localhost",       // Hard-codes the name of the host for subsequent WADO-RS requests (deprecated)
-"StudiesMetadata" : "Full", // How study-level metadata is retrieved ("Full" or "MainDicomTags", since 1.1)
+"StudiesMetadata" : "Full", // How study-level metadata is retrieved (since release 1.1, cf. section below)
-"SeriesMetadata" : "Full"   // How series-level metadata is retrieved ("Full" or "MainDicomTags", since 1.1)
+"SeriesMetadata" : "Full"   // How series-level metadata is retrieved (since release 1.1, cf. section below)
 }
 }
 Furthermore, the global option ``DefaultEncoding`` specifies the
 encoding (specific character set) that will be used when answering a
 QIDO-RS request. It might be a good idea to set this option to
 ``Utf8`` if you are dealing with an international environment.
+**Remark 1:** The following configuration options were present in
+releases <= 0.6 of the plugin, but are not used anymore::
+{
+[...]
+"DicomWeb" : {
+"StowMaxInstances" : 10,    // For STOW-RS client, the maximum number of instances in one single HTTP query (0 = no limit)
+"StowMaxSize" : 10,         // For STOW-RS client, the maximum size of the body in one single HTTP query (in MB, 0 = no limit)
+}
+}
+These older configuration options were used to limit the size of the
+HTTP requests, by issuing multiple calls to STOW-RS (set both options
+to 0 to send one single request).
+**Remark 2:** The option ``Host`` is deprecated. Starting with release
+0.7 of the DICOMweb plugin, its value are computed from the standard
+HTTP headers ``Forwarded`` and ``Host``, as provided by the HTTP
+clients.
+.. _dicomweb-server-metadata-config:
+Fine-tuning server for WADO-RS Retrieve Metadata
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 The options ``StudiesMetadata`` and ``SeriesMetadata`` were introduced
 in release 1.1 of the DICOMweb plugin. These options specify how the
 calls to ``/dicom-web/studies/.../metadata`` and
 ``/dicom-web/studies/.../series/.../metadata`` (i.e. `WADO-RS Retrieve
 Metadata
 <http://dicom.nema.org/medical/dicom/2019a/output/chtml/part18/sect_6.5.6.html>`__)
 are processed:
-* If ``Full`` mode is used, the plugin will have to read all the DICOM
+* If ``Full`` mode is used, the plugin will read all the DICOM
-instances of the study/series from the :ref:`storage area
+instances of the study/series of interest from the :ref:`storage
-<orthanc-storage>`, which gives exact results but requires all the
+area <orthanc-storage>`, which gives fully accurate results but
-individual instances to be read and parsed from the filesystem,
+requires all the individual instances to be read and parsed from the
-leading to bad performance (cf. `issue 162
+filesystem, leading to slow performance (cf. `issue 162
 <https://bitbucket.org/sjodogne/orthanc/issues/162/dicomweb-metadata-resource-reads-all>`__).
 This is the default mode.
 * If ``MainDicomTags`` mode is used, the plugin will only report the
-main DICOM tags that are stored inside the Orthanc database index.
+main DICOM tags that are indexed by the Orthanc database. The DICOM
-The DICOM files are not read from the disk, which provides very good
+files are not read from the disk, which provides best
 performance. However, this is a small subset of all the tags that
 would be retrieved if using the ``Full`` mode: A DICOMweb viewer
 might need more tags.
-* *Work-in-progress:* In the future, another mode might be introduced
+* If ``Extrapolate`` mode is used, the plugin will read up to 3 DICOM
-for the series level, that would assume that the value of some
+instances at random that belong to the study/series of interest. It
-non-main DICOM tags is constant across all the instances of the
+will then test whether the majority of these instances share the
-series. It would then be sufficient for the DICOMweb plugin to only
+same value for a predefined subset of DICOM tags. If so, this value
-read one instance from the series. This mode would be a compromise
+is added to the metadata response; otherwise, the tag is not
-between ``MainDicomTags`` (focus on speed) and ``Full`` (focus on
+reported. In other words, this mode extrapolates the value of some
-accuracy). This mode is still under active investigation, as it
+predefined tags by assuming that these tags should be constant
-might silently break DICOMweb viewers.
+across all the instances of the study/series. This mode is a
+compromise between ``MainDicomTags`` (focus on speed) and ``Full``
+(focus on accuracy).
 * If you are using a DICOMweb viewer (such as forthcoming Stone Web
-viewer or OHIF viewer) in a setup where performance is important,
+viewer or `OHIF viewer
-you should most probably set ``StudiesMetadata`` to
+<https://groups.google.com/d/msg/orthanc-users/y1N5zOFVk0M/a3YMdhNqBwAJ>`__)
-``MainDicomTags`` and ``SeriesMetadata`` to ``Full``.
+in a setup where performance and accuracy are both important, you
+should most probably set ``StudiesMetadata`` to ``MainDicomTags``
+and ``SeriesMetadata`` to ``Full``. Forthcoming Stone Web viewer
+will probably specify a value for the
+``SeriesMetadataExtrapolatedTags`` option to be used for setups
+where performance is extremely important.
+If using the ``Extrapolate`` mode, the predefined tags are provided
+using the ``StudiesMetadataExtrapolatedTags`` and
+``SeriesMetadataExtrapolatedTags`` configuration options as follows::
-**Remark 1:** The following configuration options were present in
+{
-releases <= 0.6 of the plugin, but are not used anymore::
+[...]
+"DicomWeb" : {
-{
+[...]
-[...]
+"StudiesMetadata" : "Extrapolate",
-"DicomWeb" : {
+"StudiesMetadataExtrapolatedTags" : [
-"StowMaxInstances" : 10,    // For STOW-RS client, the maximum number of instances in one single HTTP query (0 = no limit)
+"AcquisitionDate"
-"StowMaxSize" : 10,         // For STOW-RS client, the maximum size of the body in one single HTTP query (in MB, 0 = no limit)
+],
-}
+"SeriesMetadata" : "Extrapolate",
-}
+"SeriesMetadataExtrapolatedTags" : [
+"BitsAllocated",
-These older configuration options were used to limit the size of the
+"BitsStored",
-HTTP requests, by issuing multiple calls to STOW-RS (set both options
+"Columns",
-to 0 to send one single request).
+"HighBit",
+"PhotometricInterpretation",
+"PixelSpacing",
-**Remark 2:** The option ``Host`` is deprecated. Starting with release
+"PlanarConfiguration",
-0.7 of the DICOMweb plugin, its value are computed from the standard
+"RescaleIntercept",
-HTTP headers ``Forwarded`` and ``Host``, as provided by the HTTP
+"RescaleSlope",
-clients.
+"Rows",
+"SOPClassUID",
+"SamplesPerPixel",
+"SliceThickness"
+]
+}
+}
 .. _dicomweb-client-config:
 Client-related options

Mercurial > hg > orthanc-book

comparison Sphinx/source/plugins/dicomweb.rst @ 320:42104307e838