annotate CodeAnalysis/CustomFunctions.json @ 226:329a7b9ef091 default tip

integration OrthancPython-4.3->mainline
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 31 Aug 2024 10:18:11 +0200
parents d74ed3e6423e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
183
d31f216c9462 extracted custom functions/methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 [
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
2 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
3 "short_name" : "RegisterRestCallback",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
4 "implementation" : "RegisterRestCallback",
193
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
5 "documentation" : {
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
6 "description" : [ "Register a REST callback." ],
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
7 "args" : {
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
8 "pathRegularExpression" : "Regular expression for the URI. May contain groups.",
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
9 "callback" : "The callback function to handle the REST call."
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
10 }
66cd20e970d8 simplification for custom methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 192
diff changeset
11 },
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
12 "args" : [
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
13 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
14 "sdk_name" : "pathRegularExpression",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
15 "sdk_type" : "const char *"
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
16 },
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
17 {
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
18 "sdk_name" : "callback",
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
19 "sdk_type" : "Callable",
203
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
20 "callable_type" : "RestCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
21 "callable_protocol_args" : "output: RestOutput, url: str, method: HttpMethod, groups: dict, get: dict, headers: dict, body: bytes=None",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
22 "callable_protocol_return" : "None"
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
23 }
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
24 ],
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
25 "return_sdk_type" : "void"
195
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
26 },
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
27
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
28 {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
29 "short_name" : "RegisterOnChangeCallback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
30 "implementation" : "RegisterOnChangeCallback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
31 "documentation" : {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
32 "description" : [ "Register a callback to monitor changes." ],
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
33 "args" : {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
34 "callback" : "The callback function."
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
35 }
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
36 },
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
37 "args" : [
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
38 {
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
39 "sdk_name" : "callback",
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
40 "sdk_type" : "Callable",
203
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
41 "callable_type" : "OnChangeCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
42 "callable_protocol_args" : "change_type: ChangeType, resource_type: ResourceType, resource_id: str",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
43 "callable_protocol_return" : "None"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
44 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
45 ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
46 "return_sdk_type" : "void"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
47 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
48
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
49 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
50 "short_name" : "RegisterOnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
51 "implementation" : "RegisterOnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
52 "documentation" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
53 "description" : [ "Register a callback for received DICOM instances." ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
54 "args" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
55 "callback" : "The callback function."
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
56 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
57 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
58 "args" : [
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
59 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
60 "sdk_name" : "callback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
61 "sdk_type" : "Callable",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
62 "callable_type" : "OnStoredInstanceCallback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
63 "callable_protocol_args" : "instance: DicomInstance, instance_id: str",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
64 "callable_protocol_return" : "None"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
65 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
66 ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
67 "return_sdk_type" : "void"
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
68 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
69
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
70 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
71 "comment" : "New in release 3.0",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
72 "short_name" : "RegisterIncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
73 "implementation" : "RegisterIncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
74 "documentation" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
75 "description" : [ "Callback to filter incoming HTTP requests received by Orthanc." ],
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
76 "args" : {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
77 "callback" : "The callback function."
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
78 }
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
79 },
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
80 "args" : [
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
81 {
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
82 "sdk_name" : "callback",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
83 "sdk_type" : "Callable",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
84 "callable_type" : "IncomingHttpRequestFilter",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
85 "callable_protocol_args" : "uri: str, method: HttpMethod, ip: str, headers: dict, get: dict",
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 195
diff changeset
86 "callable_protocol_return" : "bool"
195
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
87 }
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
88 ],
d7a6e75558ee documented orthanc.RegisterOnChangeCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 193
diff changeset
89 "return_sdk_type" : "void"
205
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
90 },
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
91
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
92 {
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
93 "comment" : "New in release 3.2",
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
94 "short_name" : "LookupDictionary",
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
95 "implementation" : "LookupDictionary",
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
96 "documentation" : {
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
97 "description" : [ "Get information about the given DICOM tag." ],
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
98 "args" : {
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
99 "name" : "The name of the DICOM tag."
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
100 },
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
101 "return" : "Dictionary containing the requested information."
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
102 },
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
103 "args" : [
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
104 {
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
105 "sdk_name" : "name",
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
106 "sdk_type" : "const char *"
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
107 }
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
108 ],
234681297600 documented orthanc.LookupDictionary()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
109 "return_sdk_type" : "Dictionary"
208
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
110 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
111
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
112 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
113 "comment" : "New in release 3.2",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
114 "short_name" : "CreateImageFromBuffer",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
115 "implementation" : "CreateImageFromBuffer",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
116 "documentation" : {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
117 "description" : [ "This function creates an image of given size and format, and initializes its pixel data from a memory buffer." ],
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
118 "args" : {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
119 "format" : "The format of the pixels.",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
120 "width" : "The width of the image.",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
121 "height" : "The height of the image.",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
122 "pitch" : "The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
123 "buffer" : "The memory buffer."
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
124 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
125 "return" : "The newly allocated image."
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
126 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
127 "args" : [
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
128 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
129 "sdk_name" : "format",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
130 "sdk_type" : "enumeration",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
131 "sdk_enumeration" : "OrthancPluginPixelFormat"
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
132 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
133 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
134 "sdk_name" : "width",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
135 "sdk_type" : "uint32_t"
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
136 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
137 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
138 "sdk_name" : "height",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
139 "sdk_type" : "uint32_t"
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
140 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
141 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
142 "sdk_name" : "pitch",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
143 "sdk_type" : "uint32_t"
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
144 },
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
145 {
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
146 "sdk_name" : "buffer",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
147 "sdk_type" : "const void *"
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
148 }
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
149 ],
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
150 "return_sdk_type" : "object",
315e1720a35f documented orthanc.CreateImageFromBuffer()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 205
diff changeset
151 "return_sdk_class" : "OrthancPluginImage"
211
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
152 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
153
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
154 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
155 "comment" : "New in release 3.2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
156 "short_name" : "RegisterFindCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
157 "implementation" : "RegisterFindCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
158 "documentation" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
159 "description" : [ "Register a callback to handle C-Find requests." ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
160 "args" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
161 "callback" : "The callback function."
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
162 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
163 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
164 "args" : [
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
165 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
166 "sdk_name" : "callback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
167 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
168 "callable_type" : "FindCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
169 "callable_protocol_args" : "answers: FindAnswers, query: FindQuery, issuer_aet: str, called_aet: str",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
170 "callable_protocol_return" : "None"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
171 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
172 ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
173 "return_sdk_type" : "void"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
174 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
175
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
176 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
177 "comment" : "New in release 3.2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
178 "short_name" : "RegisterMoveCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
179 "implementation" : "RegisterMoveCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
180 "documentation" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
181 "description" : [ "Register a callback to handle C-Move requests (simple version, with 1 suboperation)." ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
182 "args" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
183 "callback" : "The callback function."
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
184 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
185 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
186 "args" : [
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
187 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
188 "sdk_name" : "callback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
189 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
190 "callable_type" : "MoveCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
191 "callable_protocol_args" : "Level: str, PatientID: str, AccessionNumber: str, StudyInstanceUID: str, SeriesInstanceUID: str, SOPInstanceUID: str, OriginatorAET: str, SourceAET: str, TargetAET: str, OriginatorID: int",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
192 "callable_protocol_return" : "None"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
193 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
194 ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
195 "return_sdk_type" : "void"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
196 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
197
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
198 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
199 "comment" : "New in release 3.2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
200 "short_name" : "RegisterMoveCallback2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
201 "implementation" : "RegisterMoveCallback2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
202 "documentation" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
203 "description" : [ "Register a callback to handle C-Move requests (full version, with multiple suboperations)." ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
204 "args" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
205 "callback" : "Main callback that creates the C-Move driver.",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
206 "get_move_size" : "Callback to read the number of C-Move suboperations.",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
207 "apply_move" : "Callback to apply one C-Move suboperation.",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
208 "free_move" : "Callback to free the C-Move driver."
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
209 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
210 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
211 "args" : [
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
212 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
213 "sdk_name" : "callback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
214 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
215 "callable_type" : "MoveCallback2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
216 "callable_protocol_args" : "Level: str, PatientID: str, AccessionNumber: str, StudyInstanceUID: str, SeriesInstanceUID: str, SOPInstanceUID: str, OriginatorAET: str, SourceAET: str, TargetAET: str, OriginatorID: int",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
217 "callable_protocol_return" : "object", "comment" : "This is the newly created C-Move driver."
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
218 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
219 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
220 "sdk_name" : "get_move_size",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
221 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
222 "callable_type" : "GetMoveSizeCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
223 "callable_protocol_args" : "driver: object",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
224 "callable_protocol_return" : "int"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
225 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
226 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
227 "sdk_name" : "apply_move",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
228 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
229 "callable_type" : "ApplyMoveCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
230 "callable_protocol_args" : "driver: object",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
231 "callable_protocol_return" : "None"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
232 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
233 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
234 "sdk_name" : "free_move",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
235 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
236 "callable_type" : "FreeMoveCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
237 "callable_protocol_args" : "driver: object",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
238 "callable_protocol_return" : "None"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
239 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
240 ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
241 "return_sdk_type" : "void"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
242 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
243
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
244 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
245 "comment" : "New in release 3.2",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
246 "short_name" : "RegisterWorklistCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
247 "implementation" : "RegisterWorklistCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
248 "documentation" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
249 "description" : [ "Register a callback to handle modality worklists requests." ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
250 "args" : {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
251 "callback" : "The callback function."
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
252 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
253 },
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
254 "args" : [
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
255 {
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
256 "sdk_name" : "callback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
257 "sdk_type" : "Callable",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
258 "callable_type" : "WorklistCallback",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
259 "callable_protocol_args" : "answers: WorklistAnswers, query: WorklistQuery, issuer_aet: str, called_aet: str",
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
260 "callable_protocol_return" : "None"
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
261 }
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
262 ],
d7acfccc0d0b documented RegisterFindCallback(), RegisterMoveCallback(), RegisterMoveCallback2(), and RegisterWorklistCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 208
diff changeset
263 "return_sdk_type" : "void"
212
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
264 },
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
265
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
266 {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
267 "comment" : "New in release 3.3",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
268 "short_name" : "RegisterStorageArea",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
269 "implementation" : "RegisterStorageArea",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
270 "documentation" : {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
271 "description" : [ "Register a custom storage area." ],
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
272 "args" : {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
273 "create" : "The callback function to store a file on the custom storage area.",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
274 "read" : "The callback function to read a file from the custom storage area.",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
275 "remove" : "The callback function to remove a file from the custom storage area."
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
276 }
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
277 },
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
278 "args" : [
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
279 {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
280 "sdk_name" : "create",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
281 "sdk_type" : "Callable",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
282 "callable_type" : "StorageCreateCallback",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
283 "callable_protocol_args" : "uuid: str, content_type: ContentType, data: bytes",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
284 "callable_protocol_return" : "None"
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
285 },
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
286 {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
287 "sdk_name" : "read",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
288 "sdk_type" : "Callable",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
289 "callable_type" : "StorageReadCallback",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
290 "callable_protocol_args" : "uuid: str, content_type: ContentType",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
291 "callable_protocol_return" : "bytes"
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
292 },
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
293 {
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
294 "sdk_name" : "remove",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
295 "sdk_type" : "Callable",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
296 "callable_type" : "StorageRemoveCallback",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
297 "callable_protocol_args" : "uuid: str, content_type: ContentType",
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
298 "callable_protocol_return" : "None"
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
299 }
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
300 ],
2db6c1f6417f documented orthanc.RegisterStorageArea()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 211
diff changeset
301 "return_sdk_type" : "void"
213
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
302 },
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
303
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
304 {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
305 "comment" : "New in release 4.0",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
306 "short_name" : "RegisterIncomingCStoreInstanceFilter",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
307 "implementation" : "RegisterIncomingCStoreInstanceFilter",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
308 "documentation" : {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
309 "description" : [ "Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE." ],
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
310 "args" : {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
311 "callback" : "The callback function."
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
312 }
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
313 },
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
314 "args" : [
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
315 {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
316 "sdk_name" : "callback",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
317 "sdk_type" : "Callable",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
318 "callable_type" : "IncomingCStoreInstanceFilter",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
319 "callable_protocol_args" : "received_dicom: DicomInstance",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
320 "callable_protocol_return" : "int"
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
321 }
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
322 ],
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
323 "return_sdk_type" : "void"
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
324 },
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
325
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
326 {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
327 "comment" : "New in release 4.0",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
328 "short_name" : "RegisterReceivedInstanceCallback",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
329 "implementation" : "RegisterReceivedInstanceCallback",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
330 "documentation" : {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
331 "description" : [ "Register a callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-STORE or REST API)." ],
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
332 "args" : {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
333 "callback" : "The callback function."
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
334 }
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
335 },
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
336 "args" : [
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
337 {
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
338 "sdk_name" : "callback",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
339 "sdk_type" : "Callable",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
340 "callable_type" : "ReceivedInstanceCallback",
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
341 "callable_protocol_args" : "received_dicom: bytes, origin: InstanceOrigin",
214
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
342 "callable_protocol_return" : "tuple[ReceivedInstanceAction, bytes]"
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
343 }
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
344 ],
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
345 "return_sdk_type" : "void"
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
346 },
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
347
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
348 {
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
349 "comment" : "New in release 4.1",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
350 "short_name" : "RegisterStorageCommitmentScpCallback",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
351 "implementation" : "RegisterStorageCommitmentScpCallback",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
352 "documentation" : {
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
353 "description" : [ "Register a callback to handle incoming requests to the storage commitment SCP." ],
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
354 "args" : {
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
355 "callback" : "Main callback that creates the a driver to handle an incoming storage commitment request.",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
356 "lookup" : "Callback function to get the status of one DICOM instance."
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
357 }
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
358 },
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
359 "args" : [
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
360 {
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
361 "sdk_name" : "callback",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
362 "sdk_type" : "Callable",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
363 "callable_type" : "StorageCommitmentScpCallback",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
364 "callable_protocol_args" : "job_id: str, transaction_uid: str, sop_class_uids: list[str], sop_instance_uids: list[str], remote_aet: str, called_aet: str",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
365 "callable_protocol_return" : "object", "comment" : "This is the newly created storage commitment driver."
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
366 },
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
367 {
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
368 "sdk_name" : "lookup",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
369 "sdk_type" : "Callable",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
370 "callable_type" : "StorageCommitmentLookup",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
371 "callable_protocol_args" : "sop_class_uid: str, sop_instance_uid: str, driver: object",
d74ed3e6423e documented orthanc.RegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 213
diff changeset
372 "callable_protocol_return" : "StorageCommitmentFailureReason"
213
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
373 }
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
374 ],
f8dc8dd2da76 documented orthanc.RegisterIncomingCStoreInstanceFilter() and orthanc.RegisterReceivedInstanceCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 212
diff changeset
375 "return_sdk_type" : "void"
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
376 }
183
d31f216c9462 extracted custom functions/methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
377 ]