Mercurial > hg > orthanc-book
comparison Sphinx/source/plugins/dicomweb.rst @ 30:79b6d3ea92aa
dicomweb
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 20 Jul 2016 11:13:46 +0200 |
parents | c23f02a64caf |
children | 93bbfaf0e62c |
comparison
equal
deleted
inserted
replaced
29:1a6c863cf364 | 30:79b6d3ea92aa |
---|---|
1 .. _dicomweb: | 1 .. _dicomweb: |
2 | 2 |
3 | 3 |
4 DICOMweb plugin | 4 DICOMweb plugin |
5 =============== | 5 =============== |
6 | |
7 .. contents:: | |
6 | 8 |
7 This **official** plugin extends Orthanc with support of the `DICOMweb | 9 This **official** plugin extends Orthanc with support of the `DICOMweb |
8 protocols <https://en.wikipedia.org/wiki/DICOMweb>`__. More precisely, | 10 protocols <https://en.wikipedia.org/wiki/DICOMweb>`__. More precisely, |
9 the plugin introduces a basic, reference implementation of WADO-URI, | 11 the plugin introduces a basic, reference implementation of WADO-URI, |
10 WADO-RS, QIDO-RS and STOW-RS, following `DICOM PS3.18 | 12 WADO-RS, QIDO-RS and STOW-RS, following `DICOM PS3.18 |
16 The full standard is not implemented yet, the supported features are | 18 The full standard is not implemented yet, the supported features are |
17 `tracked in the repository | 19 `tracked in the repository |
18 <https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Status.txt>`__. Some | 20 <https://bitbucket.org/sjodogne/orthanc-dicomweb/src/default/Status.txt>`__. Some |
19 integration tests are `available separately | 21 integration tests are `available separately |
20 <https://bitbucket.org/sjodogne/orthanc-tests/src/default/Plugins/DicomWeb/Run.py>`__. | 22 <https://bitbucket.org/sjodogne/orthanc-tests/src/default/Plugins/DicomWeb/Run.py>`__. |
23 | |
24 | |
25 Compilation | |
26 ----------- | |
27 | |
28 .. highlight:: text | |
29 | |
30 The procedure to compile these plugins is similar of that for the | |
31 :ref:`core of Orthanc <compiling>`. The following commands should work | |
32 for every UNIX-like distribution (including GNU/Linux):: | |
33 | |
34 $ mkdir Build | |
35 $ cd Build | |
36 $ cmake .. -DSTATIC_BUILD=ON | |
37 $ make | |
38 | |
39 The compilation will produce a shared library ``OrthancDicomWeb`` that | |
40 contains the DICOMweb plugin. Pre-compiled binaries for Microsoft | |
41 Windows `are also available | |
42 <http://www.orthanc-server.com/browse.php?path=/plugin-dicom-web>`__. | |
43 A package for `Apple's Mac OS X | |
44 <http://localhost/~jodogne/orthanc/static.php?page=download-mac>`__ is | |
45 available courtesy of `Osimis <http://osimis.io/>`__. | |
46 | |
47 | |
48 Usage | |
49 ----- | |
50 | |
51 .. highlight:: json | |
52 | |
53 You of course first have to :ref:`install Orthanc <compiling>`. Once | |
54 Orthanc is installed, you must change the :ref:`configuration file | |
55 <configuration>` to tell Orthanc where it can find the plugin: This is | |
56 done by properly modifying the ``Plugins`` option. You could for | |
57 instance use the following configuration file:: | |
58 | |
59 { | |
60 "Name" : "MyOrthanc", | |
61 [...] | |
62 "Plugins" : [ | |
63 "/home/user/OrthancDicomWeb/Build/libOrthancDicomWeb.so" | |
64 ] | |
65 } | |
66 | |
67 The root of the DICOMweb REST API is then accessible at ``http://localhost:8042/dicom-web/``. | |
68 | |
69 | |
70 Options | |
71 ------- | |
72 | |
73 .. highlight:: json | |
74 | |
75 Several configuration options are also available, and are listed in | |
76 the example below:: | |
77 | |
78 { | |
79 "DicomWeb" : { | |
80 "Enable" : true, // Whether DICOMweb support is enabled | |
81 "Root" : "/dicom-web/", // Root URI of the DICOMweb API (for QIDO-RS, STOW-RS and WADO-RS) | |
82 "EnableWado" : true, // Whether WADO-URI (aka. WADO) support is enabled | |
83 "WadoRoot" : "/wado", // Root URI of the WADO-URI (aka. WADO) API | |
84 "Host" : "localhost", // Hard-codes the name of the host for subsequent WADO-RS requests | |
85 "Ssl" : false // Whether HTTPS should be used for subsequent WADO-RS requests | |
86 } | |
87 } | |
88 |