Mercurial > hg > orthanc-book
annotate Sphinx/source/users/lua.rst @ 355:e4e9cca89c64 David-Wikler/clarified-mutual-exclusion-of-callback-1585511553371
clarified mutual exclusion of Lua scripts callbacks.
author | David Wikler <david.wikler@ulb.ac.be> |
---|---|
date | Sun, 29 Mar 2020 19:54:02 +0000 |
parents | be69f8c86f56 |
children | 6b432ce3a56e |
rev | line source |
---|---|
0 | 1 .. _lua: |
2 | |
3 Server-side scripting with Lua | |
4 ============================== | |
5 | |
6 .. contents:: | |
7 | |
8 Since release 0.5.2, Orthanc supports server-side scripting through | |
25 | 9 the `Lua <https://en.wikipedia.org/wiki/Lua_(programming_language)>`__ |
0 | 10 scripting language. Thanks to this major feature, Orthanc can be tuned |
11 to specific medical workflows without being driven by an external | |
12 script. This page summarizes the possibilities of Orthanc server-side | |
13 scripting. | |
14 | |
15 Many other examples are `available in the source distribution | |
16 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/>`__. | |
17 | |
18 | |
75 | 19 Installing a Lua script |
0 | 20 ----------------------- |
21 | |
22 .. highlight:: bash | |
23 | |
24 A custom Lua script can be installed either by the :ref:`configuration | |
25 file <configuration>`, or by uploading it | |
26 through the :ref:`REST API <rest-samples>`. | |
27 | |
28 To install it by the **configuration file** method, you just have to | |
29 specify the path to the file containing the Lua script in the | |
355
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
30 ``LuaScripts`` variable. A comma seprated list of paths can be specified |
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
31 to install multiple scripts. |
0 | 32 |
33 To upload a script stored in the file "``script.lua``" through the | |
34 **REST API**, use the following command:: | |
35 | |
36 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary @script.lua | |
37 | |
38 Pay attention to the fact that, contrarily to the scripts installed | |
39 from the configuration file, the scripts installed through the REST | |
40 API are non-persistent: They are discarded after a restart of Orthanc, | |
41 which makes them useful for script prototyping. You can also interpret | |
42 a single Lua command through the REST API:: | |
43 | |
44 $ curl -X POST http://localhost:8042/tools/execute-script --data-binary "print(42)" | |
45 | |
46 *Note:* The ``--data-binary`` cURL option is used instead of | |
47 ``--data`` to prevent the interpretation of newlines by cURL, which is | |
48 `mandatory for the proper evaluation | |
25 | 49 <http://stackoverflow.com/questions/3872427/how-to-send-line-break-with-curl>`__ of the possible |
0 | 50 comments inside the Lua script. |
51 | |
52 Lua API | |
53 ------- | |
54 | |
55 | |
56 .. _lua-callbacks: | |
57 | |
58 Callbacks to react to events | |
59 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
60 | |
355
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
61 The Lua engine of Orthanc invokes the following callbacks that |
0 | 62 are triggered on various events. Here are the **generic events**: |
63 | |
64 * ``function Initialize()``: Invoked as soon as the Orthanc server is started. | |
65 * ``function Finalize()``: Invoked just before the Orthanc server is stopped. | |
66 | |
67 Some **permission-related events** allow to filter incoming requests: | |
68 | |
69 * ``function ReceivedInstanceFilter(dicom, origin)``: | |
70 Invoked to known whether an incoming DICOM instance should be | |
71 accepted. :ref:`See this section <lua-filter-dicom>`. The ``origin`` | |
72 parameter is :ref:`documented separately <lua-origin>`. | |
73 * ``function IncomingHttpRequestFilter(method, uri, ip, username, | |
74 httpHeaders)``: Invoked to known whether a REST request should be | |
75 accepted. :ref:`See this section <lua-filter-rest>`. | |
76 | |
232 | 77 Some **job-related events** allow to react to :ref:`job <jobs>` completion/failure: |
78 | |
79 * ``function OnJobSubmitted(jobId)``: | |
80 Invoked when a new job has been submitted. Note that this does not | |
81 mean the the job execution has started. | |
82 * ``function OnJobFailure(jobId)``: | |
83 Invoked when a job has failed. | |
84 * ``function OnJobSuccess(jobId)``: | |
85 Invoked when a job has completed successfully. | |
86 | |
0 | 87 Some **DICOM-related events** allow to react to the reception of |
88 new medical images: | |
89 | |
90 * ``function OnStoredInstance(instanceId, tags, metadata, origin)``: | |
91 Invoked whenever a new instance has been stored into Orthanc. | |
92 This is especially useful for :ref:`lua-auto-routing`. The ``origin`` | |
93 parameter is :ref:`documented separately <lua-origin>`. | |
94 * ``function OnStablePatient(patientId, tags, metadata)``: Invoked | |
95 whenever a patient has not received any new instance for a certain | |
96 amount of time (cf. the option ``StableAge`` in the | |
97 :ref:`configuration file <configuration>`). The :ref:`identifier | |
98 <orthanc-ids>` of the patient is provided, together with her DICOM | |
78 | 99 tags and her :ref:`metadata <metadata>`. |
0 | 100 * ``function OnStableSeries(seriesId, tags, metadata)``: Invoked |
101 whenever a series has not received any new instance for a certain | |
102 amount of time. | |
103 * ``function OnStableStudy(studyId, tags, metadata)``: Invoked | |
104 whenever a study has not received any new instance for a certain | |
105 amount of time. | |
106 * ``function IncomingFindRequestFilter(source, origin)``: Invoked | |
107 whenever Orthanc receives an incoming C-Find query through the DICOM | |
108 protocol. This allows to inspect the content of the C-Find query, | |
109 and possibly modify it if a patch is needed for some manufacturer. A | |
110 `sample script is available | |
111 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/IncomingFindRequestFilter.lua>`__. | |
112 | |
319
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
113 Some other **resource-related events** are available: |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
114 |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
115 * ``function OnDeletedPatient(patientId)``: Invoked when a patient has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
116 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
117 * ``function OnDeletedStudy(studyId)``: Invoked when a study has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
118 removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
119 * ``function OnDeletedSeries(seriesId)``: Invoked when a series has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
120 been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
121 * ``function OnDeletedInstance(instanceId)``: Invoked when a instance |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
122 has been removed from the Orthanc database (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
123 * ``function OnUpdatedPatient(patientId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
124 or some attachment associated with the given patient has been |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
125 updated (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
126 * ``function OnUpdatedStudy(studyId)``: Invoked when some metadata or |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
127 some attachment associated with the given study has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
128 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
129 * ``function OnUpdatedSeries(seriesId)``: Invoked when some metadata |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
130 or some attachment associated with the given series has been updated |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
131 (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
132 * ``function OnUpdatedInstance(instanceId)``: Invoked when some |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
133 metadata or some attachment associated with the given instance has |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
134 been updated (new in Orthanc 1.6.0). |
be69f8c86f56
Lua events for deleted/updated resources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
283
diff
changeset
|
135 |
64
a3df3c2b68cf
import the documentation of the Worklists sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
136 Furthermore, whenever a DICOM association is negotiated for C-Store |
0 | 137 SCP, several callbacks are successively invoked to specify which |
138 **transfer syntaxes** are accepted for the association. These | |
139 callbacks are listed in `this sample script | |
140 <https://bitbucket.org/sjodogne/orthanc/src/default/Resources/Samples/Lua/TransferSyntaxEnable.lua>`__. | |
141 | |
142 *Note:* All of these callbacks are guaranteed to be **invoked in | |
143 mutual exclusion**. This implies that Lua scripting in Orthanc does | |
355
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
144 not support any kind of concurrency. If a callback is specified |
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
145 multiple times in separate scripts, the event handler of the latest |
e4e9cca89c64
clarified mutual exclusion of Lua scripts callbacks.
David Wikler <david.wikler@ulb.ac.be>
parents:
319
diff
changeset
|
146 loaded script is used. |
0 | 147 |
148 | |
149 .. _lua-rest: | |
150 | |
151 Calling the REST API of Orthanc | |
152 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
153 | |
154 Lua scripts have :ref:`full access to the REST API <rest>` of Orthanc | |
155 through the following functions: | |
156 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
157 * ``RestApiGet(uri, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
158 * ``RestApiPost(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
159 * ``RestApiPut(uri, body, builtin, headers)`` |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
160 * ``RestApiDelete(uri, builtin, headers)`` |
0 | 161 |
237 | 162 Here is a description of the parameters: |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
163 |
237 | 164 * ``uri`` specifies the resource being accessed |
165 (e.g. ``/instances``). It must not include the URL schema | |
166 (protocol), hostname or port. | |
0 | 167 |
237 | 168 * In the context of a POST or PUT request, ``body`` is a string |
169 containing the body of the request | |
170 (e.g. ``{"Keep":"StudyDate"}``). This string will often correspond | |
171 to a JSON-formatted version of a `Lua table | |
172 <http://lua-users.org/wiki/TablesTutorial>`__. The ``DumpJson()`` | |
173 function (see below) is very useful to achieve this conversion from | |
174 a Lua table to a plain string. | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
175 |
237 | 176 * ``builtin`` is an optional Boolean that specifies whether the |
177 request targets only the built-in REST API of Orthanc (if set to | |
178 ``true``), or the full the REST API after being tainted by plugins | |
179 (if set to ``false``). | |
235
17f8eda5fccb
Documented some parameter types, expected string formatting and added samples.
Tomas Zubiri <me@tomaszubiri.com>
parents:
191
diff
changeset
|
180 |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
181 * ``headers`` is an optional argument and was added in release |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
182 1.5.7. It allows to provide the REST API endpoint with HTTP headers. |
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
183 |
237 | 184 .. highlight:: bash |
185 | |
186 For instance:: | |
187 | |
188 RestApiPost('/instances/5af318ac-78fb-47ff-b0b0-0df18b0588e0/anonymize', '{}') | |
189 | |
0 | 190 |
191 General-purpose functions | |
192 ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
193 | |
194 The Lua engine of Orthanc contain several general-purpose ancillary | |
195 functions: | |
196 | |
197 * ``PrintRecursive(v)`` recursively prints the content of a `Lua table | |
198 <http://www.lua.org/pil/2.5.html>`__ to the log file of Orthanc. | |
199 * ``ParseJson(s)`` converts a string encoded in the `JSON format | |
200 <https://en.wikipedia.org/wiki/JSON>`__ to a Lua table. | |
201 * ``DumpJson(v, keepStrings)`` encodes a Lua table as a JSON string. | |
202 Setting the optional argument ``keepStrings`` (available from | |
203 release 0.9.5) to ``true`` prevents the automatic conversion of | |
204 strings to integers. | |
205 * ``GetOrthancConfiguration()`` returns a Lua table containing the | |
206 content of the :ref:`configuration files <configuration>` of | |
207 Orthanc. | |
208 | |
209 | |
210 Similarly to the functions to :ref:`call the REST API of Orthanc | |
211 <lua-rest>`, several functions are available to make generic HTTP | |
212 requests to Web services: | |
213 | |
90 | 214 * ``HttpGet(url, headers)`` |
215 * ``HttpPost(url, body, headers)`` | |
216 * ``HttpPut(url, body, headers)`` | |
217 * ``HttpDelete(url, headers)`` | |
0 | 218 * ``SetHttpCredentials(username, password)`` can be used to setup the |
219 HTTP credentials. | |
220 | |
252
eaad8233e474
HTTP headers available for the RestApiXXX Lua function
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
221 The ``headers`` argument is optional and was added in release |
91 | 222 1.2.1. It allows to set the HTTP headers for the HTTP client request. |
0 | 223 |
283 | 224 Example:: |
225 | |
226 local preview = RestApiGet('/instances/' .. instanceId .. '/preview') | |
227 local headers = { | |
228 ["content-type"] = "image/png", | |
229 } | |
230 HttpPost("http://localhost/my-web-service/instance-preview", preview, headers) | |
231 | |
0 | 232 .. _lua-origin: |
233 | |
234 Origin of the instances | |
235 ^^^^^^^^^^^^^^^^^^^^^^^ | |
236 | |
237 Whenever Orthanc decides whether it should should store a new instance | |
238 (cf. the ``ReceivedInstanceFilter()`` callback), or whenever it has | |
239 actually stored a new instance (cf. the ``OnStoredInstance`` | |
240 callback), an ``origin`` parameter is provided. This parameter is a | |
241 `Lua table <http://www.lua.org/pil/2.5.html>`__ that describes from | |
242 which Orthanc subsystem the new instance comes from. | |
243 | |
244 There are 4 possible subsystems, that can be distinguished according | |
245 to the value of ``origin["RequestOrigin"]``: | |
246 | |
247 * ``RestApi``: The instance originates from some HTTP request to the REST | |
248 API. In this case, the ``RemoteIp`` and ``Username`` fields are | |
249 available in ``origin``. They respectively describe the IP address | |
250 of the HTTP client, and the username that was used for HTTP | |
251 authentication (as defined in the ``RegisteredUsers`` | |
252 :ref:`configuration variable <configuration>`). | |
253 * ``DicomProtocol``: The instance originates from a DICOM C-Store. | |
254 The fields ``RemoteIp``, ``RemoteAet`` and ``CalledAet`` | |
255 respectively provide the IP address of the DICOM SCU (client), the | |
256 application entity title of the DICOM SCU client, and the | |
257 application entity title of the Orthanc SCP server. The | |
258 ``CalledAet`` can be used for :ref:`advanced auto-routing scenarios | |
259 <lua-auto-routing>`, when a single instance of Orthanc acts as a | |
260 proxy for several DICOM SCU clients. | |
261 * ``Lua``: The instance originates from a Lua script. | |
262 * ``Plugins``: The instance originates from a plugin. | |
263 | |
264 | |
265 .. _lua-filter-dicom: | |
266 | |
75 | 267 Filtering incoming DICOM instances |
0 | 268 ---------------------------------- |
269 | |
270 .. highlight:: lua | |
271 | |
272 Each time a DICOM instance is received by Orthanc (either through the | |
273 DICOM protocol or through the REST API), the | |
274 ``ReceivedInstanceFilter()`` Lua function is invoked. If this callback | |
275 returns ``true``, the instance is accepted for storage. If it returns | |
276 ``false``, the instance is discarded. This mechanism can be used to | |
277 filter the incoming DICOM instances. Here is an example of a Lua | |
278 filter that only allows incoming instances of MR modality:: | |
279 | |
280 function ReceivedInstanceFilter(dicom, origin) | |
281 -- Only allow incoming MR images | |
282 if dicom.Modality == 'MR' then | |
283 return true | |
284 else | |
285 return false | |
286 end | |
287 end | |
288 | |
289 The argument dicom corresponds to a `Lua table | |
290 <http://www.lua.org/pil/2.5.html>`__ (i.e. an associative array) that | |
291 contains the DICOM tags of the incoming instance. For debugging | |
292 purpose, you can print this structure as follows:: | |
293 | |
294 function ReceivedInstanceFilter(dicom, origin) | |
295 PrintRecursive(dicom) | |
296 -- Accept all incoming instances (default behavior) | |
297 return true | |
298 end | |
299 | |
300 The argument ``origin`` is :ref:`documented separately <lua-origin>`. | |
301 | |
302 | |
303 .. _lua-filter-rest: | |
304 | |
75 | 305 Filtering incoming REST requests |
0 | 306 -------------------------------- |
307 | |
308 .. highlight:: lua | |
309 | |
310 Lua scripting can be used to control the access to the various URI of | |
311 the REST API. Each time an incoming HTTP request is received, the | |
312 ``IncomingHttpRequestFilter()`` Lua function is called. The access to | |
313 the resource is granted if and only if this callback script returns | |
314 ``true``. | |
315 | |
316 This mechanism can be used to implement fine-grained `access control | |
25 | 317 lists <https://en.wikipedia.org/wiki/Access_control_list>`__. Here is |
0 | 318 an example of a Lua script that limits POST, PUT and DELETE requests |
319 to an user that is called "admin":: | |
320 | |
321 function IncomingHttpRequestFilter(method, uri, ip, username, httpHeaders) | |
322 -- Only allow GET requests for non-admin users | |
323 | |
324 if method == 'GET' then | |
325 return true | |
326 elseif username == 'admin' then | |
327 return true | |
328 else | |
329 return false | |
330 end | |
331 end | |
332 | |
333 Here is a description of the arguments of this Lua callback: | |
334 | |
335 * ``method``: The HTTP method (GET, POST, PUT or DELETE). | |
336 * ``uri``: The path to the resource (e.g. ``/tools/generate-uid``). | |
337 * ``ip``: The IP address of the host that has issued the HTTP request (e.g. ``127.0.0.1``). | |
338 * ``username``: If HTTP Basic Authentication is enabled in the | |
339 :ref:`configuration file <configuration>`, the name of the user that | |
340 has issued the HTTP request (as defined in the ``RegisteredUsers`` | |
341 configuration variable). If the authentication is disabled, this | |
342 argument is set to the empty string. | |
343 * ``httpHeaders``: The HTTP headers of the incoming request. This | |
344 argument is available since Orthanc 1.0.1. It is useful if the | |
345 authentication should be achieved through tokens, for instance | |
346 against a `LDAP | |
347 <https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol>`__ | |
348 or `OAuth2 <https://en.wikipedia.org/wiki/OAuth>`__ server. | |
349 | |
350 | |
351 .. _lua-auto-routing: | |
352 | |
75 | 353 Auto-routing of DICOM images |
0 | 354 ---------------------------- |
355 | |
356 .. highlight:: lua | |
357 | |
358 Since release 0.8.0, the routing of DICOM flows can be very easily | |
359 automated with Orthanc. All you have to do is to declare your | |
360 destination modality in the :ref:`configuration file <configuration>` | |
361 (section ``DicomModalities``), then to create and install a Lua | |
362 script. For instance, here is a sample script:: | |
363 | |
364 function OnStoredInstance(instanceId, tags, metadata) | |
365 Delete(SendToModality(instanceId, 'sample')) | |
366 end | |
367 | |
368 If this script is loaded into Orthanc, whenever a new DICOM instance | |
369 is received by Orthanc, it will be routed to the modality whose | |
370 symbolic name is ``sample`` (through a Store-SCU command), then it | |
371 will be removed from Orthanc. In other words, this is a **one-liner | |
372 script to implement DICOM auto-routing**. | |
373 | |
374 Very importantly, thanks to this feature, you do not have to use the | |
375 REST API or to create external scripts in order to automate simple | |
376 imaging flows. The scripting engine is entirely contained inside the | |
377 Orthanc core system. | |
378 | |
379 Thanks to Lua expressiveness, you can also implement conditional | |
380 auto-routing. For instance, if you wish to route only patients whose | |
381 name contains "David", you would simply write:: | |
382 | |
383 function OnStoredInstance(instanceId, tags, metadata) | |
384 -- Extract the value of the "PatientName" DICOM tag | |
385 local patientName = string.lower(tags['PatientName']) | |
386 | |
387 if string.find(patientName, 'david') ~= nil then | |
388 -- Only route patients whose name contains "David" | |
389 Delete(SendToModality(instanceId, 'sample')) | |
390 | |
391 else | |
392 -- Delete the patients that are not called "David" | |
393 Delete(instanceId) | |
394 end | |
395 end | |
396 | |
397 Besides ``SendToModality()``, a mostly identical function with the | |
398 same arguments called ``SendToPeer()`` can be used to route instances | |
399 to :ref:`Orthanc peers <peers>`. It is also possible to modify the | |
400 received instances before routing them. For instance, here is how you | |
401 would replace the ``StationName`` DICOM tag:: | |
402 | |
403 function OnStoredInstance(instanceId, tags, metadata) | |
404 -- Ignore the instances that result from a modification to avoid | |
405 -- infinite loops | |
406 if (metadata['ModifiedFrom'] == nil and | |
407 metadata['AnonymizedFrom'] == nil) then | |
408 | |
409 -- The tags to be replaced | |
410 local replace = {} | |
411 replace['StationName'] = 'My Medical Device' | |
412 | |
413 -- The tags to be removed | |
414 local remove = { 'MilitaryRank' } | |
415 | |
416 -- Modify the instance, send it, then delete the modified instance | |
417 Delete(SendToModality(ModifyInstance(instanceId, replace, remove, true), 'sample')) | |
418 | |
419 -- Delete the original instance | |
420 Delete(instanceId) | |
421 end | |
422 end | |
423 | |
424 | |
75 | 425 Important remarks about auto-routing |
426 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
427 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
428 The ``SendToModality()``, ``SendToPeer()``, ``ModifyInstance()`` and |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
429 ``Delete()`` functions are for the most basic cases of auto-routing |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
430 (implying a single DICOM instance, and possibly a basic modification |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
431 of this instance). The ``ModifyInstance()`` function `could also lead |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
432 to problems |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
433 <https://groups.google.com/d/msg/orthanc-users/hmv2y-LgKm8/oMAuGJWMBgAJ>`__ |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
434 if it deals with tags wrongly interpreted as numbers by Lua. |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
435 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
436 For more evolved auto-routing scenarios, remember that Lua scripts |
191 | 437 :ref:`have full access to the REST API of Orthanc <lua-rest>`. This is |
19
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
438 illustrated by the ``AutoroutingModification.lua`` sample available in |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
439 the source distribution of Orthanc:: |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
440 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
441 function OnStoredInstance(instanceId, tags, metadata, origin) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
442 -- Ignore the instances that result from the present Lua script to |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
443 -- avoid infinite loops |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
444 if origin['RequestOrigin'] ~= 'Lua' then |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
445 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
446 -- The tags to be replaced |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
447 local replace = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
448 replace['StationName'] = 'My Medical Device' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
449 replace['0031-1020'] = 'Some private tag' |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
450 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
451 -- The tags to be removed |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
452 local remove = { 'MilitaryRank' } |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
453 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
454 -- Modify the instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
455 local command = {} |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
456 command['Replace'] = replace |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
457 command['Remove'] = remove |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
458 local modifiedFile = RestApiPost('/instances/' .. instanceId .. '/modify', DumpJson(command, true)) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
459 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
460 -- Upload the modified instance to the Orthanc database so that |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
461 -- it can be sent by Orthanc to other modalities |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
462 local modifiedId = ParseJson(RestApiPost('/instances/', modifiedFile)) ['ID'] |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
463 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
464 -- Send the modified instance to another modality |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
465 RestApiPost('/modalities/sample/store', modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
466 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
467 -- Delete the original and the modified instances |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
468 RestApiDelete('/instances/' .. instanceId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
469 RestApiDelete('/instances/' .. modifiedId) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
470 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
471 end |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
472 |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
473 Also note that :ref:`other callbacks are available <lua-callbacks>` |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
474 (``OnStablePatient()``, ``OnStableStudy()`` and ``OnStableSeries()``) |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
475 to react to other events than the reception of a single instance |
c98317fedf87
note about autorouting
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
476 with ``OnStoredInstance()``. |
75 | 477 |
99
e83da2f99e45
added 'troubleshooting C-Find queries' in the worklist section
amazy
parents:
91
diff
changeset
|
478 .. _lua-fix-cfind: |
75 | 479 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
480 Fixing C-Find requests |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
481 ---------------------- |
75 | 482 |
483 :ref:`C-Find requests <dicom-find>` are sometimes interpreted | |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
484 differently by different DICOM servers (e.g. the ``*`` wildcard, as |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
485 `reported by users |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
486 <https://groups.google.com/d/msg/orthanc-users/3g7V7kqr3g0/IREL88RWAwAJ>`__), |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
487 and sometimes a querying modality might set unexpected DICOM tags |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
488 (cf. `this real-world example |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
489 <https://groups.google.com/d/msg/orthanc-users/PLWKqVVaXLs/n_0x4vKhAgAJ>`__). In |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
490 such situations, it is possible to dynamically fix incoming or |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
491 outgoing C-Find queries using a Lua script. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
492 |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
493 Sanitizing incoming C-Find requests can be done by implementing the |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
494 ``IncomingFindRequestFilter(query, origin)`` callback that is called |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
495 whenever the Orthanc C-Find SCP is queried by a remote modality. For |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
496 instance, here is Lua script to remove a private tag that is specified |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
497 by some manufacturer:: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
498 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
499 function IncomingFindRequestFilter(query, origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
500 -- First display the content of the C-Find query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
501 PrintRecursive(query) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
502 PrintRecursive(origin) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
503 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
504 -- Remove the "PrivateCreator" tag from the query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
505 local v = query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
506 v['5555,0010'] = nil |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
507 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
508 return v |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
509 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
510 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
511 The ``origin`` argument contains information about which modality has |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
512 issued the request. |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
513 |
165
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
514 Note that the ``IncomingFindRequestFilter`` callback is not applied to |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
515 C-Find requests targeting :ref:`modality worklists |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
516 <worklists-plugin>`. Since Orthanc 1.4.2, the corresponding |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
517 ``IncomingWorklistRequestFilter`` callback can be used to sanitize |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
518 C-FIND requests against worklists:: |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
519 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
520 function IncomingWorklistRequestFilter(query, origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
521 PrintRecursive(query) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
522 PrintRecursive(origin) |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
523 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
524 -- Implements the same behavior as the "FilterIssuerAet" |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
525 -- option of the sample worklist plugin |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
526 query['0040,0100'][1]['0040,0001'] = origin['RemoteAet'] |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
527 |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
528 return query |
b879a6274065
IncomingWorklistRequestFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
105
diff
changeset
|
529 end |
105
268ec482f051
IncomingFindRequestFilter not applied to worklist plugin
amazy
parents:
99
diff
changeset
|
530 |
77
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
531 Similarly, the callback ``OutgoingFindRequestFilter(query, modality)`` |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
532 is invoked whenever Orthanc acts as a C-Find SCU, which gives the |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
533 opportunity to dynamically fix outgoing C-Find requests before they |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
534 are actually sent to the queried modality. For instance, here is a |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
535 sample Lua callback that would replace asterisk wildcards (i.e. ``*``) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
536 by an empty string for any query/retrieve issued by Orthanc (including |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
537 from Orthanc Explorer):: |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
538 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
539 function OutgoingFindRequestFilter(query, modality) |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
540 for key, value in pairs(query) do |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
541 if value == '*' then |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
542 query[key] = '' |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
543 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
544 end |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
545 |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
546 return query |
48c7d2eb98da
Fixing C-Find requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
75
diff
changeset
|
547 end |