Mercurial > hg > orthanc-book
annotate Sphinx/source/faq/features.rst @ 672:8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 03 May 2021 14:31:42 +0200 |
parents | 36bf58dfb7f7 |
children | 9c23356b9464 |
rev | line source |
---|---|
0 | 1 Terminology of advanced features |
2 ================================ | |
3 | |
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
4 .. contents:: |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
5 :depth: 3 |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
6 |
0 | 7 .. _peers: |
8 | |
9 Peers | |
10 ----- | |
11 | |
12 An "Orthanc peer" is another instance of Orthanc, possibly running on | |
13 a remote computer. | |
14 | |
15 Contrarily to a "modality", it is possible to communicate with a peer | |
16 through the **HTTP/HTTPS protocol** (i.e. through the REST API of | |
17 Orthanc), and not through the DICOM protocol. This implies a much | |
18 easier configuration: It is only required to know the URL, the | |
19 username and the password to communicate with an Orthanc peer. This | |
20 contrasts with DICOM query/retrieve, that is quite complex and that | |
21 involves a lot of pitfalls (cf. the FAQ entry about :ref:`troubleshooting | |
22 DICOM communications <dicom>`) that can be bypassed if using HTTP. | |
23 | |
24 Furthermore, as HTTP(S) communications are generally not blocked by | |
25 firewalls (contrarily to the DICOM protocol that is inherently an | |
26 Intranet protocol and that often requires the setup of VPN tunnels), | |
27 it is much easier to setup communications of medical images through | |
218 | 28 the Internet with :ref:`Orthanc peers <peering>`. |
0 | 29 |
30 | |
31 .. _recycling: | |
32 | |
33 Recycling/Protection | |
34 -------------------- | |
35 | |
36 Because of its focus on low-end computers, Orthanc implements **disk | |
37 space recycling**: The patient that has been stored for the longest | |
38 time inside Orthanc can be automatically deleted when the disk space | |
39 used by Orthanc grows above a threshold, or when the number of stored | |
40 patients grows above a threshold. This feature enables the automated | |
278 | 41 control of the disk space dedicated to Orthanc. Note that each time |
42 a new instance is received for an existing patient, the patient will | |
43 be marked as the most recent one in the recycling order. | |
0 | 44 |
45 Recycling is controlled by the ``MaximumStorageSize`` and the | |
46 ``MaximumPatientCount`` options in the :ref:`Orthanc configuration | |
106 | 47 file <configuration>`. Setting both these values to 0 will disable |
48 recycling. | |
0 | 49 |
50 It is possible to prevent important data from being automatically | |
51 recycled. This mechanism is called **protection**. Each patient can be | |
52 individually protected against recycling by using the | |
53 ``Unprotected/Protected`` switch that is available from Orthanc | |
54 Explorer. | |
55 | |
56 Note that protection is only available at the patient level. It | |
57 protects all the studies/series/instances of the patient against | |
58 recycling. The rationale is that we think it is important to keep | |
59 available all the data related to one patient. Unwillingly losing a | |
60 study/series that is part of the same patient might lead to a loss in | |
61 consistency with respect to the medical history of this patient. | |
62 | |
63 .. _compression: | |
64 | |
65 Compression | |
66 ----------- | |
67 | |
68 If your disk space is limited, besides :ref:`recycling`, you should | |
69 also consider using **disk space compression**. When compression is | |
70 enabled, Orthanc compresses the incoming DICOM instances on-the-fly | |
71 before writing them to the filesystem, using `zlib | |
25 | 72 <https://en.wikipedia.org/wiki/Zlib>`_. This is useful, because the |
0 | 73 images are often stored as raw, uncompressed arrays in DICOM |
74 instances: The size of a typical DICOM instance can hopefully be | |
75 divided by a factor 2 through lossless compression. This compression | |
76 process is transparent to the user, as Orthanc automatically | |
77 decompresses the file before sending it back to the external world. | |
78 | |
79 Compression is controlled by the ``StorageCompression`` option in the | |
80 :ref:`Orthanc configuration file <configuration>`. | |
78 | 81 |
82 | |
83 .. _metadata: | |
84 | |
92 | 85 Metadata & attachments |
86 ---------------------- | |
78 | 87 |
88 Metadata consists in an **associative key-value array** (mapping a | |
89 integer key in the range [0,65535] to a string value) that is | |
90 associated with each :ref:`DICOM resource <orthanc-ids>` stored inside | |
91 Orthanc (may it be a patient, a study, a series or a DICOM | |
92 instance). Metadata can be either referred to using the integer key, | |
93 or using a symbolic name (if configured). Metadata records | |
94 information that is not readily available in the DICOM tags. | |
95 | |
96 In spirit, the metadata mechanism is similar to the :ref:`attachment | |
97 mechanism <orthanc-storage>`. However, metadata is stored directly | |
98 inside the database, whereas attachments are stored as separate files | |
99 on the filesystem (the database only stores a reference to the | |
632
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
100 attachments). Choosing between metadata and attachments is most often |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
101 a matter of trade-off: Metadata must be kept small (as a rule of |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
102 thumb, under 1KB) and used if fast access is needed, whereas |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
103 attachments can be used to store arbitrarily large piece of data. |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
104 |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
105 However, pay attention to the fact that metadata must be UTF-8 strings |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
106 terminated by the ``\0`` character. If you need to store arbitrary |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
107 binary objects, use an attachment or use `Base64 encoding |
38face2a84a4
metadata are utf-8 strings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
622
diff
changeset
|
108 <https://en.wikipedia.org/wiki/Base64>`__. |
78 | 109 |
79 | 110 Also note that metadata and attachments are only available for |
111 resources stored inside Orthanc. Once one DICOM instance leaves the | |
112 Orthanc ecosystem, its associated metadata and attachments are lost. | |
113 | |
78 | 114 |
115 Core metadata | |
116 ^^^^^^^^^^^^^ | |
117 | |
118 Here are the main metadata handled by the Orthanc core: | |
119 | |
120 * ``ReceptionDate`` records when a DICOM instance was received by | |
121 Orthanc. Similarly, ``LastUpdate`` records, for each | |
122 patient/study/series, the last time a DICOM instance was added to | |
123 this resource. | |
661
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
124 * ``RemoteAET`` records the AET of the modality that has sent some |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
125 DICOM instance to Orthanc using the DICOM protocol. |
78 | 126 * ``ModifiedFrom`` and ``AnonymizedFrom`` hold from which original |
127 resource, a resource was modified or anonymized. The presence of | |
128 this metadata indicates that the resource is the result of a | |
129 modification or anonymization that was carried on by Orthanc. | |
130 * ``Origin`` records through which mechanism the instance was received | |
131 by Orthanc (may be ``Unknown``, ``DicomProtocol``, ``RestApi``, | |
132 ``Plugins``, or ``Lua``). | |
133 * ``IndexInSeries`` records the expected index of a DICOM instance | |
134 inside its parent series. Conversely, ``ExpectedNumberOfInstances`` | |
135 associates to each series, the number of DICOM instances this series | |
661
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
136 is expected to contain. This information is :ref:`not always |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
137 available <series-completion>`. |
78 | 138 * Starting with Orthanc 1.2.0, ``TransferSyntax`` and ``SopClassUid`` |
139 respectively stores the transfer syntax UID and the SOP class UID of | |
140 DICOM instances, in order to speed up the access to this | |
141 information. | |
661
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
142 * ``RemoteIP`` (new in Orthanc 1.4.0): The IP address of the remote |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
143 SCU (for REST API and DICOM protocol). |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
144 * ``CalledAET`` (new in Orthanc 1.4.0): The AET that was called by the |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
145 SCU, which normally matches the AET of Orthanc (for DICOM protocol). |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
146 * ``HttpUsername`` (new in Orthanc 1.4.0): The username that created |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
147 the instance (for REST API). |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
148 * ``PixelDataOffset`` (new in Orthanc 1.9.1): Offset (in bytes) of the |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
149 Pixel Data DICOM tag in the DICOM file, if available. |
36bf58dfb7f7
added core metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
660
diff
changeset
|
150 |
78 | 151 |
152 Metadata listed above are set privately by the Orthanc core. They are | |
153 **read-only** from the perspective of the end user, as Orthanc | |
154 internally relies on them. | |
155 | |
156 | |
157 User-defined metadata | |
158 ^^^^^^^^^^^^^^^^^^^^^ | |
159 | |
160 The metadata described above where handled by the core of Orthanc. | |
161 Orthanc users are however allowed to define their own **user-defined | |
162 metadata**. Such metadata are associated with an integer key that is | |
163 greater or equal to 1024 (whereas keys below 1023 are reserved for | |
164 core metadata). | |
165 | |
166 You can associate a symbolic name to user-defined metadata using the | |
167 ``UserMetadata`` option inside the :ref:`configuration of Orthanc | |
92 | 168 <configuration>`:: |
169 | |
170 "UserMetadata" : { | |
171 "SampleMetaData1" : 1024, | |
172 "SampleMetaData2" : 1025 | |
173 } | |
78 | 174 |
175 | |
176 Accessing metadata | |
177 ^^^^^^^^^^^^^^^^^^ | |
178 | |
179 .. highlight:: bash | |
180 | |
181 Metadata associated with one DICOM resource can be accessed through | |
80 | 182 the :ref:`REST API <rest>`, for instance:: |
78 | 183 |
184 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata | |
185 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/RemoteAet | |
92 | 186 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/SampleMetaData1 |
78 | 187 |
188 User-defined metadata can be modified by issuing a HTTP PUT against | |
189 the REST API:: | |
190 | |
191 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/1024 -X PUT -d 'hello' | |
192 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/metadata/1024 | |
193 hello | |
194 | |
195 | |
196 | |
92 | 197 .. _attachments: |
198 | |
199 User-defined attachments | |
200 ^^^^^^^^^^^^^^^^^^^^^^^^ | |
201 | |
202 Orthanc users are allowed to define their own **user-defined attachments**. | |
203 Such attachments are associated with an integer key that is | |
204 greater or equal to 1024 (whereas keys below 1023 are reserved for | |
205 core attachments). | |
206 | |
207 You can associate a symbolic name to user-defined attachments using the | |
208 ``UserContentType`` option inside the :ref:`configuration of Orthanc | |
209 <configuration>`. Optionally, the user may specify a MIME content type | |
210 for the attachment:: | |
211 | |
212 "UserContentType" : { | |
213 "samplePdf" : [1024, "application/pdf"], | |
214 "sampleJson" : [1025, "application/json"], | |
215 "sampleRaw" : 1026 | |
216 } | |
217 | |
218 Accessing attachments | |
219 ^^^^^^^^^^^^^^^^^^^^^ | |
220 | |
221 .. highlight:: bash | |
222 | |
223 Attachments associated with one DICOM resource can be accessed through | |
224 the :ref:`REST API <rest>`, for instance:: | |
225 | |
226 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/attachments/samplePdf/data | |
227 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/attachments/sampleJson/data | |
228 | |
229 User-defined attachments can be modified by issuing a HTTP PUT against | |
230 the REST API:: | |
231 | |
232 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/attachments/samplePdf -X PUT --data-binary @sample.pdf | |
233 $ curl http://localhost:8042/instances/cb855110-5f4da420-ec9dc9cb-2af6a9bb-dcbd180e/attachments/sampleRaw -X PUT -d 'raw data' | |
660 | 234 |
235 | |
236 DICOM-as-JSON attachments | |
237 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
238 | |
239 In the version of Orthanc <= 1.9.0, whenever Orthanc receives a DICOM | |
240 file, it pre-computes a JSON summary of its DICOM tags, and caches | |
241 this JSON file as an attachment to the DICOM instance (accessible at | |
242 the ``/instances/{...}/attachments/dicom-as-json/`` URI). This | |
243 attachment is used as a cache to seep up future accesses to | |
244 ``/instances/.../tags``, lookups using ``/tools/find`` or C-FIND | |
245 queries. | |
246 | |
247 This caching might cause issues if the dictionary of DICOM tags is | |
248 subsequently modified, which implies that the cached JSON file does | |
249 not perfectly match the new dictionary. | |
250 | |
251 .. highlight:: bash | |
252 | |
253 Since Orthanc 1.2.0, you can force the re-generation of the cached | |
254 JSON file by DELETE-ing it, for instance:: | |
255 | |
256 $ curl -X DELETE http://localhost:8042/instances/301896f2-1416807b-3e05dcce-ff4ce9bb-a6138832/attachments/dicom-as-json | |
257 | |
258 .. highlight:: text | |
259 | |
260 The next time you open this particular instance with Orthanc Explorer, | |
261 you will see messages in the Orthanc logs (in verbose mode) stating | |
262 that the Orthanc server has reconstructed the JSON summary, which will | |
263 match the new content of the dictionary:: | |
264 | |
265 I0222 08:56:00.923070 FilesystemStorage.cpp:155] Reading attachment "2309c47b-1cbd-4601-89b5-1be1ad80382c" of "DICOM" content type | |
266 I0222 08:56:00.923394 ServerContext.cpp:401] Reconstructing the missing DICOM-as-JSON summary for instance: 301896f2-1416807b-3e05dcce-ff4ce9bb-a6138832 | |
267 I0222 08:56:00.929117 ServerContext.cpp:540] Adding attachment dicom-as-json to resource 301896f2-1416807b-3e05dcce-ff4ce9bb-a6138832 | |
268 I0222 08:56:00.929425 FilesystemStorage.cpp:118] Creating attachment "3c830b66-8a00-42f0-aa3a-5e37b4a8b5a4" of "JSON summary of DICOM" type (size: 1MB) | |
269 | |
270 These DICOM-as-JSON attachments are not automatically generated | |
271 anymore starting with Orthanc 1.9.1. | |
272 | |
92 | 273 |
78 | 274 .. _registry: |
275 | |
276 Central registry of metadata and attachments | |
277 -------------------------------------------- | |
278 | |
279 Obviously, one must pay attention to the fact that different | |
280 applications might use the same key to store different user-defined | |
281 :ref:`metadata <metadata>`, which might result in incompatibilities | |
282 between such applications. Similarly, incompatibilities might show up | |
283 for user-defined :ref:`attachments <orthanc-storage>`. | |
284 | |
601
4c19a897803e
global property 5467
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
595
diff
changeset
|
285 Developers of applications/plugins that use user-defined metadata, |
4c19a897803e
global property 5467
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
595
diff
changeset
|
286 attachments or global properties (using |
4c19a897803e
global property 5467
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
595
diff
changeset
|
287 ``OrthancPluginSetGlobalProperty()``) are therefore kindly invited to |
4c19a897803e
global property 5467
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
595
diff
changeset
|
288 complete the **central registry** below: |
78 | 289 |
622
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
290 * ``Attachment 1`` is used by the core of Orthanc to store the DICOM |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
291 file associated with one instance. |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
292 * ``Attachment 2`` was used by Orthanc <= 1.9.0 to cache the so-called |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
293 ``DICOM-as-JSON`` information (as returned by the |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
294 ``/instances/.../tags`` URI in the :ref:`REST API <rest>`) in order |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
295 to speed up subsequent requests to the same URI. This attachment is |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
296 not automatically generated anymore starting with Orthanc 1.9.1, in |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
297 order to improve performance (creating two files for each DICOM |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
298 instance has a cost) and consistency (if the DICOM dictionary gets |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
299 modified in the future). |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
300 * ``Attachment 3`` is used since Orthanc 1.9.1 to store the DICOM |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
301 instance until the ``Pixel Data (7fe0,0010)`` tag, if the global |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
302 configuration option ``StorageCompression`` is ``true``, or if the |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
303 storage area plugin doesn't support range reads. This allows to |
debcf6b6d070
dicom-as-json is now deprecated
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
621
diff
changeset
|
304 avoid downloading the full DICOM instance if not necessary. |
359 | 305 * ``Attachment 9997`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store series information. |
306 * ``Attachment 9998`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store instance information. | |
307 * ``Attachment 9999`` is used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store annotations. | |
308 * ``Attachments 10000-13999`` are used by the :ref:`Osimis WebViewer plugin <osimis_webviewer>` to store reduced quality images. | |
601
4c19a897803e
global property 5467
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
595
diff
changeset
|
309 * ``Global property 5467`` is used by the Osimis Cloud plugin. |
602
6e7d3f20227b
index global property 5468
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
601
diff
changeset
|
310 * ``Global property 5468`` is used by the :ref:`DICOMweb plugin <dicomweb>` to store the DICOMweb servers into the Orthanc database. |
6e7d3f20227b
index global property 5468
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
601
diff
changeset
|
311 * ``Metadata 4200`` is used by the plugin for :ref:`whole-slide imaging <wsi>` with version <= 0.7. |
6e7d3f20227b
index global property 5468
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
601
diff
changeset
|
312 * ``Metadata 4201`` is used by the plugin for :ref:`whole-slide imaging <wsi>` with version >= 1.0. |
224
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
313 |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
314 |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
315 Jobs |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
316 ---- |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
317 |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
318 Check out the :ref:`advanced features of the REST API <jobs>`. |
02399e86f046
starting documentation of jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
218
diff
changeset
|
319 |
642
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
320 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
321 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
322 .. _stable-resources: |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
323 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
324 Stable resources |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
325 ---------------- |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
326 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
327 A DICOM resource (patient, study or series) is referred to as |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
328 **stable** if it has not received any new instance for a certain |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
329 amount of time. |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
330 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
331 This amount of time is configured by the the option ``StableAge`` in |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
332 the :ref:`configuration file <configuration>`. |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
333 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
334 When some resource becomes stable, an event is generated as a log |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
335 entry in the ``/changes`` :ref:`URI in the REST API <changes>`, a |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
336 :ref:`Lua callback <lua-callbacks>` is invoked, the callback function |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
337 registered by ``OrthancPluginRegisterOnChangeCallback()`` in |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
338 :ref:`C/C++ plugins <creating-plugins>` is executed, as well as the |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
339 :ref:`Python callback <python-changes>` registered by |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
340 ``orthanc.RegisterOnChangeCallback()``. |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
341 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
342 The ``IsStable`` field is also available to get the status of an |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
343 individual patient/study/series using the REST API of Orthanc. |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
344 |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
345 In the multiple readers/writers scenario enabled since Orthanc 1.9.2, |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
346 each Orthanc server is considered separately: The "stable" information |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
347 is monitored by threads inside the Orthanc process, and is **not** |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
348 shared in the database. In other words, the "stable" information is |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
349 local to the Orthanc server that is queried. Synchronization between |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
350 multiple readers/writers must be implemented at a higher level |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
351 (e.g. using a distributed `message-broker system |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
352 <https://en.wikipedia.org/wiki/Message_broker>`__ such as RabbitMQ |
a76d83a00c68
definition of stable resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
632
diff
changeset
|
353 that is fed by an Orthanc plugin). |
643
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
354 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
355 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
356 .. _revisions: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
357 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
358 Revisions |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
359 --------- |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
360 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
361 .. highlight:: bash |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
362 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
363 Higher-level applications built on the top of Orthanc might have to |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
364 modify metadata and/or attachments. This can cause concurrency |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
365 problems if multiple clients modify the same metadata/attachment |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
366 simultaneously. To avoid such problems, Orthanc implements a so-called |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
367 **revision mechanism** to protect from concurrent modifications. |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
368 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
369 The revision mechanism is optional, was introduced in **Orthanc |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
370 1.9.2** and must be enabled by setting :ref:`configuration option |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
371 <configuration>` ``CheckRevision`` to ``true``. It is strongly |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
372 inspired by the `CouchDB API |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
373 <https://docs.couchdb.org/en/stable/api/document/common.html>`__. |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
374 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
375 When the revision mechanism is enabled, each metadata and attachment |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
376 is associated with a **revision number**. Whenever one sets a metadata |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
377 for the first time using a ``PUT`` query, this revision number can be |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
378 found in the HTTP header ``ETag`` that is reported by Orthanc:: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
379 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
380 $ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024 -X PUT -d 'Hello' |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
381 [...] |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
382 < ETag: "0" |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
383 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
384 Any ``GET`` query will also return the current value of ``ETag``:: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
385 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
386 $ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
387 [...] |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
388 < ETag: "0" |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
389 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
390 If one needs to subsequently modify or delete this metadata, the HTTP |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
391 client must set this value of ``ETag`` into the ``If-Match`` HTTP |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
392 header:: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
393 |
645 | 394 $ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024 -X PUT -d 'Hello 2' -H 'If-Match: "0"' |
643
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
395 [...] |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
396 < ETag: "1" |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
397 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
398 Note how this second call has incremented the value of ``ETag``: This |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
399 is the new revision number to be used in future updates. If a bad |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
400 revision number is provided, the HTTP error ``409 Conflict`` is |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
401 generated:: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
402 |
645 | 403 $ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024 -X PUT -d 'Hello 3' -H 'If-Match: "0"' |
643
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
404 [...] |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
405 < HTTP/1.1 409 Conflict |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
406 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
407 Such a ``409`` error must be handled by the higher-level |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
408 application. The revision number must similarly be given if deleting a |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
409 metadata/attachment:: |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
410 |
645 | 411 $ curl -v http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata/1024 -X DELETE -H 'If-Match: "1"' |
643
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
412 [...] |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
413 < HTTP/1.1 200 OK |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
414 |
645 | 415 Check out the `OpenAPI reference <https://api.orthanc-server.com/>`__ |
416 of the REST API of Orthanc for more information. | |
643
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
417 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
418 **Warning:** The database index back-end must support revisions. As of |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
419 writing, only the **PostgreSQL plugin** in versions above 4.0 |
411e82bb3a9f
documenting revisions and multiple writers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
642
diff
changeset
|
420 implement support for revisions. |
672
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
421 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
422 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
423 Synchronous vs. asynchronous C-MOVE SCP |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
424 --------------------------------------- |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
425 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
426 The :ref:`C-MOVE SCP <dicom-move>` of Orthanc (i.e. the component of |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
427 the Orthanc server that is responsible for routing DICOM instances |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
428 from Orthanc to other modalities) can be configured to run either in |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
429 synchronous or in asynchronous mode, depending on the value of the |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
430 ``SynchronousCMove`` :ref:`configuration option <configuration>`: |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
431 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
432 * In **synchronous mode** (if ``SynchronousCMove`` is ``true``), |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
433 Orthanc will interleave its C-STORE SCU commands with the C-MOVE |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
434 instructions received from the remote modality. In other words, |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
435 Orthanc immediately sends the DICOM instances while it handles the |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
436 C-MOVE command from the remote modality. This mode is for |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
437 compatibility with simple DICOM client software that considers that |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
438 when its C-MOVE SCU is over, it should have received all the |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
439 instructed DICOM instances. This is the default behavior of Orthanc. |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
440 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
441 * In **asynchronous mode** (if ``SynchronousCMove`` is ``false``), |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
442 Orthanc will queue the C-MOVE instructions and :ref:`creates a job |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
443 <jobs-synchronicity>` that will issue the C-STORE SCU commands |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
444 afterward. This behavior is typically encountered in hospital-wide |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
445 PACS systems, but requires the client software to be more complex as |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
446 it must be handle the delay between its C-MOVE queries and the |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
447 actual reception of the DICOM instances through C-STORE. |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
448 |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
449 As a consequence, by setting ``SynchronousCMove`` to ``true``, Orthanc |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
450 can be used as a buffer that enables communications between a simple |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
451 C-MOVE client and a hospital-wide PACS. This can be interesting to |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
452 introduce compatibility with specialized image processing |
8bda16db46cf
SynchronousCMove: Synchronous vs. asynchronous C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
661
diff
changeset
|
453 applications. |