Mercurial > hg > orthanc-python

annotate CodeAnalysis/CustomFunctions.json @ 208:315e1720a35f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documented orthanc.CreateImageFromBuffer()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 12:56:18 +0200
parents 234681297600
children d7acfccc0d0b
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"
192
b0f096d2339e documentation of orthanc.RegisterRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 191
diff changeset
152 }
183
d31f216c9462 extracted custom functions/methods
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
153 ]