orthanc-python: Sources/Autogenerated/orthanc.pyi annotate

annotate Sources/Autogenerated/orthanc.pyi @ 191:30ed49f2487f java-code-model

removed pointless function orthanc.CreateMemoryBuffer()

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 02 Jul 2024 18:00:52 +0200
parents	87e546600cbe
children	b0f096d2339e

rev	line source
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1 ##
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2 ## Python plugin for Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3 ## Copyright (C) 2020-2023 Osimis S.A., Belgium
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4 ## Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	5 ## Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	6 ##
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	7 ## This program is free software: you can redistribute it and/or
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	8 ## modify it under the terms of the GNU Affero General Public License
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	9 ## as published by the Free Software Foundation, either version 3 of
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	10 ## the License, or (at your option) any later version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	11 ##
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	12 ## This program is distributed in the hope that it will be useful, but
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	13 ## WITHOUT ANY WARRANTY; without even the implied warranty of
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	15 ## Affero General Public License for more details.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 ##
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	17 ## You should have received a copy of the GNU Affero General Public License
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	18 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	19 ##
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	20
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	21
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22 # WARNING: Auto-generated file. Do not modify it by hand.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	23
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	25 import enum
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	26
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	27
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	28 class ChangeType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	29 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	30 The supported types of changes that can be signaled to the change callback.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	31 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	32
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	33 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34 Series is now complete
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	35 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36 COMPLETED_SERIES: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	37
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	38 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	39 Deleted resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	40 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	41 DELETED: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	42
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	43 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	44 A new instance was added to this resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	45 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	46 NEW_CHILD_INSTANCE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	47
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	48 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	49 New instance received
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	50 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	51 NEW_INSTANCE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	52
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	53 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	54 New patient created
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	55 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	56 NEW_PATIENT: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	57
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	58 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	59 New series created
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	60 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	61 NEW_SERIES: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	62
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	63 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	64 New study created
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	65 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	66 NEW_STUDY: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	67
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	68 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69 Timeout: No new instance in this patient
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 STABLE_PATIENT: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 Timeout: No new instance in this series
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	76 STABLE_SERIES: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79 Timeout: No new instance in this study
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81 STABLE_STUDY: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	83 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84 Orthanc has started
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	85 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 ORTHANC_STARTED: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89 Orthanc is stopping
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	90 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	91 ORTHANC_STOPPED: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	92
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 Some user-defined attachment has changed for this resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	95 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96 UPDATED_ATTACHMENT: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	97
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	98 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99 Some user-defined metadata has changed for this resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	100 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	101 UPDATED_METADATA: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	102
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	103 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	104 The list of Orthanc peers has changed
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	105 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	106 UPDATED_PEERS: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	107
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	108 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109 The list of DICOM modalities has changed
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	110 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	111 UPDATED_MODALITIES: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	112
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	113 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	114 New Job submitted
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	115 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	116 JOB_SUBMITTED: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	117
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	118 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	119 A Job has completed successfully
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	120 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	121 JOB_SUCCESS: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	122
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	123 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	124 A Job has failed
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	125 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	126 JOB_FAILURE: int = 18,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	127
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	128 class CompressionType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	129 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	130 The compression algorithms that are supported by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	131 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	132
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	133 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	134 Standard zlib compression
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	135 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	136 ZLIB: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	137
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	138 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	139 zlib, prefixed with uncompressed size (uint64_t)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	140 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	141 ZLIB_WITH_SIZE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	142
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	143 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144 Standard gzip compression
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	145 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	146 GZIP: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	147
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	148 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	149 gzip, prefixed with uncompressed size (uint64_t)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	150 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	151 GZIP_WITH_SIZE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	152
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	153 class ConstraintType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	154 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	155 The constraints on the tags (main DICOM tags and identifier tags) that must be supported by the database plugins.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	156 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	157
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	158 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	159 Equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	160 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 EQUAL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	162
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	164 Less or equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	165 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	166 SMALLER_OR_EQUAL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	167
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	168 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	169 More or equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	170 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	171 GREATER_OR_EQUAL: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	173 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174 Wildcard matching
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	175 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	176 WILDCARD: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	177
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	178 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	179 List of values
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	180 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	181 LIST: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	182
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	183 class ContentType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	184 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	185 The content types that are supported by Orthanc plugins.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	186 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	187
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	188 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	189 Unknown content type
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	190 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	191 UNKNOWN: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	192
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	193 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	194 DICOM
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	195 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	196 DICOM: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	197
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	198 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199 JSON summary of a DICOM file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	200 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	201 DICOM_AS_JSON: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	202
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	203 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	204 DICOM Header till pixel data
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	205 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	206 DICOM_UNTIL_PIXEL_DATA: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	207
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	208 class CreateDicomFlags(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	209 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	210 Flags to the creation of a DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	211 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	212
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	213 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	214 Default mode
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	215 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	216 NONE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	217
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	218 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219 Decode fields encoded using data URI scheme
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	220 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	221 DECODE_DATA_URI_SCHEME: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	222
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	223 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	224 Automatically generate DICOM identifiers
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	225 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	226 GENERATE_IDENTIFIERS: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	227
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	228 class DicomToJsonFlags(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	229 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	230 Flags to customize a DICOM-to-JSON conversion. By default, binary tags are formatted using Data URI scheme.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	231 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	232
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	233 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	234 Default formatting
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	235 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	236 NONE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	237
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	238 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	239 Include the binary tags
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	240 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	241 INCLUDE_BINARY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	242
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	243 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	244 Include the private tags
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	245 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	246 INCLUDE_PRIVATE_TAGS: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	247
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	248 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	249 Include the tags unknown by the dictionary
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	250 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	251 INCLUDE_UNKNOWN_TAGS: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	252
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	253 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254 Include the pixel data
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	255 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	256 INCLUDE_PIXEL_DATA: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	257
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	258 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259 Output binary tags as-is, dropping non-ASCII
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	260 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	261 CONVERT_BINARY_TO_ASCII: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	262
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	263 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	264 Signal binary tags as null values
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	265 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	266 CONVERT_BINARY_TO_NULL: int = 32,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	267
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	268 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	269 Stop processing after pixel data (new in 1.9.1)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	270 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	271 STOP_AFTER_PIXEL_DATA: int = 64,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	272
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	273 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	274 Skip tags whose element is zero (new in 1.9.1)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	275 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	276 SKIP_GROUP_LENGTHS: int = 128,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	277
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278 class DicomToJsonFormat(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	279 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	280 The possible output formats for a DICOM-to-JSON conversion.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	281 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	282
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	283 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	284 Full output, with most details
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	285 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	286 FULL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	287
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	288 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	289 Tags output as hexadecimal numbers
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	290 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	291 SHORT: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	292
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	293 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294 Human-readable JSON
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	295 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	296 HUMAN: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	297
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	298 class DicomWebBinaryMode(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	299 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	300 The available modes to export a binary DICOM tag into a DICOMweb JSON or XML document.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	301 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	302
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	303 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 Don't include binary tags
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	305 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	306 IGNORE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	307
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	308 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 Inline encoding using Base64
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311 INLINE_BINARY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314 Use a bulk data URI field
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	316 BULK_DATA_URI: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	317
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318 class ErrorCode(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	320 The various error codes that can be returned by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	321 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	322
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	323 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	324 Internal error
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	325 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	326 INTERNAL_ERROR: int = -1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	327
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	328 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	329 Success
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	330 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	331 SUCCESS: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	332
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	333 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	334 Error encountered within the plugin engine
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	335 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	336 PLUGIN: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	337
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339 Not implemented yet
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	340 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	341 NOT_IMPLEMENTED: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	342
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	343 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	344 Parameter out of range
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	345 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	346 PARAMETER_OUT_OF_RANGE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	347
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	348 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	349 The server hosting Orthanc is running out of memory
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	350 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	351 NOT_ENOUGH_MEMORY: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	352
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	353 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	354 Bad type for a parameter
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	355 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	356 BAD_PARAMETER_TYPE: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	357
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	358 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	359 Bad sequence of calls
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	360 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	361 BAD_SEQUENCE_OF_CALLS: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	362
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	363 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	364 Accessing an inexistent item
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	365 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	366 INEXISTENT_ITEM: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	367
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	368 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	369 Bad request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	370 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	371 BAD_REQUEST: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	372
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	373 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	374 Error in the network protocol
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	375 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	376 NETWORK_PROTOCOL: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	377
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	378 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379 Error while calling a system command
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	380 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	381 SYSTEM_COMMAND: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	382
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	383 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	384 Error with the database engine
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	385 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	386 DATABASE: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	387
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	388 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	389 Badly formatted URI
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	390 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	391 URI_SYNTAX: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	392
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	393 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	394 Inexistent file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	395 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	396 INEXISTENT_FILE: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	397
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	398 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	399 Cannot write to file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	400 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	401 CANNOT_WRITE_FILE: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	402
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	403 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	404 Bad file format
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	405 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	406 BAD_FILE_FORMAT: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	407
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	408 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	409 Timeout
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	410 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	411 TIMEOUT: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	412
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	413 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	414 Unknown resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	415 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	416 UNKNOWN_RESOURCE: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	417
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	418 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	419 Incompatible version of the database
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	420 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	421 INCOMPATIBLE_DATABASE_VERSION: int = 18,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	422
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	423 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	424 The file storage is full
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	425 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	426 FULL_STORAGE: int = 19,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	427
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	428 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	429 Corrupted file (e.g. inconsistent MD5 hash)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	430 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	431 CORRUPTED_FILE: int = 20,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	432
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	433 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	434 Inexistent tag
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	435 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	436 INEXISTENT_TAG: int = 21,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	437
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	438 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	439 Cannot modify a read-only data structure
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	440 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	441 READ_ONLY: int = 22,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	442
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	443 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	444 Incompatible format of the images
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	445 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	446 INCOMPATIBLE_IMAGE_FORMAT: int = 23,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	447
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	448 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	449 Incompatible size of the images
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	450 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	451 INCOMPATIBLE_IMAGE_SIZE: int = 24,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	452
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	453 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	454 Error while using a shared library (plugin)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	455 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	456 SHARED_LIBRARY: int = 25,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	457
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	458 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	459 Plugin invoking an unknown service
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	460 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	461 UNKNOWN_PLUGIN_SERVICE: int = 26,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	462
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	463 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	464 Unknown DICOM tag
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	465 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	466 UNKNOWN_DICOM_TAG: int = 27,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	467
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	468 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	469 Cannot parse a JSON document
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	470 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	471 BAD_JSON: int = 28,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	472
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	473 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	474 Bad credentials were provided to an HTTP request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	475 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	476 UNAUTHORIZED: int = 29,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	477
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	478 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	479 Badly formatted font file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	480 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	481 BAD_FONT: int = 30,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	482
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	483 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	484 The plugin implementing a custom database back-end does not fulfill the proper interface
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	485 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	486 DATABASE_PLUGIN: int = 31,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	487
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	488 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	489 Error in the plugin implementing a custom storage area
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	490 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	491 STORAGE_AREA_PLUGIN: int = 32,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	492
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	493 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	494 The request is empty
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	495 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	496 EMPTY_REQUEST: int = 33,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	497
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	498 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	499 Cannot send a response which is acceptable according to the Accept HTTP header
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	500 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	501 NOT_ACCEPTABLE: int = 34,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	502
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	503 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	504 Cannot handle a NULL pointer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	505 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	506 NULL_POINTER: int = 35,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	507
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	508 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	509 The database is currently not available (probably a transient situation)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	510 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	511 DATABASE_UNAVAILABLE: int = 36,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	512
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	513 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	514 This job was canceled
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	515 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	516 CANCELED_JOB: int = 37,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	517
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	518 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	519 Geometry error encountered in Stone
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	520 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	521 BAD_GEOMETRY: int = 38,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	522
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	523 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	524 Cannot initialize SSL encryption, check out your certificates
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	525 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	526 SSL_INITIALIZATION: int = 39,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	527
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	528 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	529 Calling a function that has been removed from the Orthanc Framework
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	530 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	531 DISCONTINUED_ABI: int = 40,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	532
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	533 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	534 Incorrect range request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	535 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	536 BAD_RANGE: int = 41,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	537
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	538 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	539 Database could not serialize access due to concurrent update, the transaction should be retried
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	540 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	541 DATABASE_CANNOT_SERIALIZE: int = 42,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	542
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	543 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	544 A bad revision number was provided, which might indicate conflict between multiple writers
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	545 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	546 REVISION: int = 43,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	547
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	548 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	549 SQLite: The database is not opened
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	550 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	551 SQLITE_NOT_OPENED: int = 1000,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	552
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	553 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	554 SQLite: Connection is already open
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	555 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	556 SQLITE_ALREADY_OPENED: int = 1001,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	557
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	558 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	559 SQLite: Unable to open the database
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	560 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	561 SQLITE_CANNOT_OPEN: int = 1002,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	562
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	563 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	564 SQLite: This cached statement is already being referred to
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	565 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	566 SQLITE_STATEMENT_ALREADY_USED: int = 1003,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	567
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	568 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	569 SQLite: Cannot execute a command
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	570 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	571 SQLITE_EXECUTE: int = 1004,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	572
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	573 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	574 SQLite: Rolling back a nonexistent transaction (have you called Begin()?)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	575 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	576 SQLITE_ROLLBACK_WITHOUT_TRANSACTION: int = 1005,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	577
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	578 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	579 SQLite: Committing a nonexistent transaction
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	580 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	581 SQLITE_COMMIT_WITHOUT_TRANSACTION: int = 1006,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	582
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	583 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	584 SQLite: Unable to register a function
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	585 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	586 SQLITE_REGISTER_FUNCTION: int = 1007,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	587
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	588 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	589 SQLite: Unable to flush the database
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	590 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	591 SQLITE_FLUSH: int = 1008,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	592
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	593 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	594 SQLite: Cannot run a cached statement
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	595 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	596 SQLITE_CANNOT_RUN: int = 1009,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	597
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	598 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	599 SQLite: Cannot step over a cached statement
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	600 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	601 SQLITE_CANNOT_STEP: int = 1010,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	602
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	603 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	604 SQLite: Bing a value while out of range (serious error)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	605 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	606 SQLITE_BIND_OUT_OF_RANGE: int = 1011,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	607
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	608 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	609 SQLite: Cannot prepare a cached statement
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	610 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	611 SQLITE_PREPARE_STATEMENT: int = 1012,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	612
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	613 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	614 SQLite: Beginning the same transaction twice
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	615 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	616 SQLITE_TRANSACTION_ALREADY_STARTED: int = 1013,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	617
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	618 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	619 SQLite: Failure when committing the transaction
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	620 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	621 SQLITE_TRANSACTION_COMMIT: int = 1014,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	622
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	623 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	624 SQLite: Cannot start a transaction
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	625 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	626 SQLITE_TRANSACTION_BEGIN: int = 1015,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	627
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	628 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	629 The directory to be created is already occupied by a regular file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	630 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	631 DIRECTORY_OVER_FILE: int = 2000,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	632
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	633 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	634 Unable to create a subdirectory or a file in the file storage
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	635 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	636 FILE_STORAGE_CANNOT_WRITE: int = 2001,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	637
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	638 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	639 The specified path does not point to a directory
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	640 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	641 DIRECTORY_EXPECTED: int = 2002,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	642
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	643 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	644 The TCP port of the HTTP server is privileged or already in use
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	645 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	646 HTTP_PORT_IN_USE: int = 2003,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	647
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	648 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	649 The TCP port of the DICOM server is privileged or already in use
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	650 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	651 DICOM_PORT_IN_USE: int = 2004,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	652
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	653 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	654 This HTTP status is not allowed in a REST API
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	655 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	656 BAD_HTTP_STATUS_IN_REST: int = 2005,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	657
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	658 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	659 The specified path does not point to a regular file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	660 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	661 REGULAR_FILE_EXPECTED: int = 2006,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	662
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	663 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	664 Unable to get the path to the executable
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	665 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	666 PATH_TO_EXECUTABLE: int = 2007,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	667
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	668 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	669 Cannot create a directory
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	670 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	671 MAKE_DIRECTORY: int = 2008,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	672
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	673 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	674 An application entity title (AET) cannot be empty or be longer than 16 characters
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	675 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	676 BAD_APPLICATION_ENTITY_TITLE: int = 2009,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	677
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	678 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	679 No request handler factory for DICOM C-FIND SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	680 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	681 NO_CFIND_HANDLER: int = 2010,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	682
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	683 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	684 No request handler factory for DICOM C-MOVE SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	685 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	686 NO_CMOVE_HANDLER: int = 2011,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	687
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	688 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	689 No request handler factory for DICOM C-STORE SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	690 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	691 NO_CSTORE_HANDLER: int = 2012,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	692
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	693 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	694 No application entity filter
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	695 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	696 NO_APPLICATION_ENTITY_FILTER: int = 2013,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	697
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	698 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	699 DicomUserConnection: Unable to find the SOP class and instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	700 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	701 NO_SOP_CLASS_OR_INSTANCE: int = 2014,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	702
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	703 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	704 DicomUserConnection: No acceptable presentation context for modality
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	705 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	706 NO_PRESENTATION_CONTEXT: int = 2015,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	707
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	708 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	709 DicomUserConnection: The C-FIND command is not supported by the remote SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	710 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	711 DICOM_FIND_UNAVAILABLE: int = 2016,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	712
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	713 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	714 DicomUserConnection: The C-MOVE command is not supported by the remote SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	715 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	716 DICOM_MOVE_UNAVAILABLE: int = 2017,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	717
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	718 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	719 Cannot store an instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	720 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	721 CANNOT_STORE_INSTANCE: int = 2018,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	722
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	723 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	724 Only string values are supported when creating DICOM instances
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	725 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	726 CREATE_DICOM_NOT_STRING: int = 2019,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	727
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	728 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	729 Trying to override a value inherited from a parent module
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	730 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	731 CREATE_DICOM_OVERRIDE_TAG: int = 2020,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	732
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	733 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	734 Use \"Content\" to inject an image into a new DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	735 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	736 CREATE_DICOM_USE_CONTENT: int = 2021,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	737
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	738 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	739 No payload is present for one instance in the series
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	740 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	741 CREATE_DICOM_NO_PAYLOAD: int = 2022,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	742
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	743 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	744 The payload of the DICOM instance must be specified according to Data URI scheme
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	745 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	746 CREATE_DICOM_USE_DATA_URI_SCHEME: int = 2023,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	747
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	748 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	749 Trying to attach a new DICOM instance to an inexistent resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	750 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	751 CREATE_DICOM_BAD_PARENT: int = 2024,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	752
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	753 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	754 Trying to attach a new DICOM instance to an instance (must be a series, study or patient)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	755 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	756 CREATE_DICOM_PARENT_IS_INSTANCE: int = 2025,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	757
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	758 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	759 Unable to get the encoding of the parent resource
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	760 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	761 CREATE_DICOM_PARENT_ENCODING: int = 2026,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	762
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	763 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	764 Unknown modality
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	765 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	766 UNKNOWN_MODALITY: int = 2027,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	767
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	768 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	769 Bad ordering of filters in a job
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	770 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	771 BAD_JOB_ORDERING: int = 2028,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	772
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	773 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	774 Cannot convert the given JSON object to a Lua table
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	775 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	776 JSON_TO_LUA_TABLE: int = 2029,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	777
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	778 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	779 Cannot create the Lua context
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	780 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	781 CANNOT_CREATE_LUA: int = 2030,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	782
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	783 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	784 Cannot execute a Lua command
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	785 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	786 CANNOT_EXECUTE_LUA: int = 2031,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	787
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	788 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	789 Arguments cannot be pushed after the Lua function is executed
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	790 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	791 LUA_ALREADY_EXECUTED: int = 2032,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	792
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	793 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	794 The Lua function does not give the expected number of outputs
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	795 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	796 LUA_BAD_OUTPUT: int = 2033,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	797
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	798 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	799 The Lua function is not a predicate (only true/false outputs allowed)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	800 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	801 NOT_LUA_PREDICATE: int = 2034,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	802
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	803 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	804 The Lua function does not return a string
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	805 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	806 LUA_RETURNS_NO_STRING: int = 2035,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	807
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	808 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	809 Another plugin has already registered a custom storage area
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	810 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	811 STORAGE_AREA_ALREADY_REGISTERED: int = 2036,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	812
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	813 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	814 Another plugin has already registered a custom database back-end
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	815 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	816 DATABASE_BACKEND_ALREADY_REGISTERED: int = 2037,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	817
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	818 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	819 Plugin trying to call the database during its initialization
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	820 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	821 DATABASE_NOT_INITIALIZED: int = 2038,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	822
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	823 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	824 Orthanc has been built without SSL support
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	825 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	826 SSL_DISABLED: int = 2039,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	827
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	828 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	829 Unable to order the slices of the series
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	830 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	831 CANNOT_ORDER_SLICES: int = 2040,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	832
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	833 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	834 No request handler factory for DICOM C-Find Modality SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	835 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	836 NO_WORKLIST_HANDLER: int = 2041,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	837
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	838 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	839 Cannot override the value of a tag that already exists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	840 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	841 ALREADY_EXISTING_TAG: int = 2042,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	842
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	843 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	844 No request handler factory for DICOM N-ACTION SCP (storage commitment)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	845 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	846 NO_STORAGE_COMMITMENT_HANDLER: int = 2043,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	847
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	848 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	849 No request handler factory for DICOM C-GET SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	850 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	851 NO_CGET_HANDLER: int = 2044,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	852
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	853 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	854 Unsupported media type
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	855 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	856 UNSUPPORTED_MEDIA_TYPE: int = 3000,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	857
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	858 class HttpMethod(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	859 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	860 The various HTTP methods for a REST call.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	861 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	862
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	863 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	864 GET request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	865 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	866 GET: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	867
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	868 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	869 POST request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	870 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	871 POST: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	872
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	873 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	874 PUT request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	875 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	876 PUT: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	877
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	878 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	879 DELETE request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	880 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	881 DELETE: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	882
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	883 class IdentifierConstraint(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	884 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	885 The constraints on the DICOM identifiers that must be supported by the database plugins.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	886 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	887
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	888 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	889 Equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	890 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	891 EQUAL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	892
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	893 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	894 Less or equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	895 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	896 SMALLER_OR_EQUAL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	897
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	898 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	899 More or equal
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	900 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	901 GREATER_OR_EQUAL: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	902
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	903 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	904 Case-sensitive wildcard matching (with * and ?)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	905 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	906 WILDCARD: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	907
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	908 class ImageFormat(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	909 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	910 The image formats that are supported by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	911 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	912
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	913 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	914 Image compressed using PNG
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	915 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	916 PNG: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	917
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	918 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	919 Image compressed using JPEG
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	920 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	921 JPEG: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	922
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	923 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	924 Image compressed using DICOM
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	925 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	926 DICOM: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	927
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	928 class InstanceOrigin(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	929 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	930 The origin of a DICOM instance that has been received by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	931 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	932
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	933 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	934 Unknown origin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	935 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	936 UNKNOWN: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	937
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	938 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	939 Instance received through DICOM protocol
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	940 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	941 DICOM_PROTOCOL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	942
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	943 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	944 Instance received through REST API of Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	945 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	946 REST_API: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	947
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	948 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	949 Instance added to Orthanc by a plugin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	950 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	951 PLUGIN: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	952
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	953 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	954 Instance added to Orthanc by a Lua script
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	955 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	956 LUA: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	957
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	958 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	959 Instance received through WebDAV (new in 1.8.0)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	960 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	961 WEB_DAV: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	962
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	963 class JobStepStatus(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	964 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	965 The possible status for one single step of a job.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	966 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	967
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	968 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	969 The job has successfully executed all its steps
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	970 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	971 SUCCESS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	972
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	973 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	974 The job has failed while executing this step
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	975 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	976 FAILURE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	977
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	978 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	979 The job has still data to process after this step
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	980 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	981 CONTINUE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	982
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	983 class JobStopReason(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	984 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	985 Explains why the job should stop and release the resources it has allocated. This is especially important to disambiguate between the "paused" condition and the "final" conditions (success, failure, or canceled).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	986 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	987
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	988 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	989 The job has succeeded
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	990 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	991 SUCCESS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	992
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	993 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	994 The job was paused, and will be resumed later
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	995 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	996 PAUSED: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	997
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	998 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	999 The job has failed, and might be resubmitted later
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1000 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1001 FAILURE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1002
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1003 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1004 The job was canceled, and might be resubmitted later
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1005 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1006 CANCELED: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1007
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1008 class MetricsType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1009 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1010 The available types of metrics.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1011 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1012
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1013 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1014 Default metrics
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1015 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1016 DEFAULT: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1017
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1018 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1019 This metrics represents a time duration. Orthanc will keep the maximum value of the metrics over a sliding window of ten seconds, which is useful if the metrics is sampled frequently.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1020 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1021 TIMER: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1022
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1023 class PixelFormat(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1024 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1025 The memory layout of the pixels of an image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1026 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1027
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1028 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1029 Graylevel 8bpp image. The image is graylevel. Each pixel is unsigned and stored in one byte.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1030 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1031 GRAYSCALE8: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1032
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1033 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1034 Graylevel, unsigned 16bpp image. The image is graylevel. Each pixel is unsigned and stored in two bytes.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1035 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1036 GRAYSCALE16: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1037
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1038 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1039 Graylevel, signed 16bpp image. The image is graylevel. Each pixel is signed and stored in two bytes.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1040 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1041 SIGNED_GRAYSCALE16: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1042
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1043 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1044 Color image in RGB24 format. This format describes a color image. The pixels are stored in 3 consecutive bytes. The memory layout is RGB.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1045 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1046 RGB24: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1047
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1048 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1049 Color image in RGBA32 format. This format describes a color image. The pixels are stored in 4 consecutive bytes. The memory layout is RGBA.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1050 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1051 RGBA32: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1052
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1053 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1054 Unknown pixel format
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1055 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1056 UNKNOWN: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1057
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1058 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1059 Color image in RGB48 format. This format describes a color image. The pixels are stored in 6 consecutive bytes. The memory layout is RRGGBB.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1060 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1061 RGB48: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1062
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1063 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1064 Graylevel, unsigned 32bpp image. The image is graylevel. Each pixel is unsigned and stored in four bytes.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1065 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1066 GRAYSCALE32: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1067
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1068 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1069 Graylevel, floating-point 32bpp image. The image is graylevel. Each pixel is floating-point and stored in four bytes.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1070 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1071 FLOAT32: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1072
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1073 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1074 Color image in BGRA32 format. This format describes a color image. The pixels are stored in 4 consecutive bytes. The memory layout is BGRA.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1075 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1076 BGRA32: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1077
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1078 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1079 Graylevel, unsigned 64bpp image. The image is graylevel. Each pixel is unsigned and stored in eight bytes.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1080 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1081 GRAYSCALE64: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1082
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1083 class ReceivedInstanceAction(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1084 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1085 The action to be taken after ReceivedInstanceCallback is triggered
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1086 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1087
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1088 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1089 Keep the instance as is
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1090 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1091 KEEP_AS_IS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1092
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1093 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1094 Modify the instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1095 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1096 MODIFY: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1097
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1098 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1099 Discard the instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1100 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1101 DISCARD: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1102
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1103 class ResourceType(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1104 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1105 The supported types of DICOM resources.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1106 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1107
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1108 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1109 Patient
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1110 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1111 PATIENT: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1112
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1113 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1114 Study
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1115 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1116 STUDY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1117
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1118 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1119 Series
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1120 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1121 SERIES: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1122
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1123 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1124 Instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1125 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1126 INSTANCE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1127
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1128 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1129 Unavailable resource type
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1130 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1131 NONE: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1132
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1133 class StorageCommitmentFailureReason(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1134 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1135 The available values for the Failure Reason (0008,1197) during storage commitment. http://dicom.nema.org/medical/dicom/2019e/output/chtml/part03/sect_C.14.html#sect_C.14.1.1
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1136 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1137
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1138 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1139 Success: The DICOM instance is properly stored in the SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1140 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1141 SUCCESS: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1142
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1143 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1144 0110H: A general failure in processing the operation was encountered
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1145 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1146 PROCESSING_FAILURE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1147
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1148 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1149 0112H: One or more of the elements in the Referenced SOP Instance Sequence was not available
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1150 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1151 NO_SUCH_OBJECT_INSTANCE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1152
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1153 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1154 0213H: The SCP does not currently have enough resources to store the requested SOP Instance(s)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1155 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1156 RESOURCE_LIMITATION: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1157
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1158 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1159 0122H: Storage Commitment has been requested for a SOP Instance with a SOP Class that is not supported by the SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1160 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1161 REFERENCED_SOPCLASS_NOT_SUPPORTED: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1162
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1163 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1164 0119H: The SOP Class of an element in the Referenced SOP Instance Sequence did not correspond to the SOP class registered for this SOP Instance at the SCP
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1165 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1166 CLASS_INSTANCE_CONFLICT: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1167
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1168 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1169 0131H: The Transaction UID of the Storage Commitment Request is already in use
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1170 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1171 DUPLICATE_TRANSACTION_UID: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1172
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1173 class ValueRepresentation(enum.Enum):
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1174 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1175 The value representations present in the DICOM standard (version 2013).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1176 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1177
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1178 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1179 Application Entity
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1180 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1181 AE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1182
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1183 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1184 Age String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1185 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1186 AS: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1187
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1188 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1189 Attribute Tag
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1190 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1191 AT: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1192
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1193 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1194 Code String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1195 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1196 CS: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1197
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1198 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1199 Date
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1200 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1201 DA: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1202
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1203 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1204 Decimal String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1205 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1206 DS: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1207
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1208 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1209 Date Time
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1210 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1211 DT: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1212
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1213 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1214 Floating Point Double
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1215 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1216 FD: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1217
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1218 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1219 Floating Point Single
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1220 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1221 FL: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1222
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1223 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1224 Integer String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1225 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1226 IS: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1227
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1228 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1229 Long String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1230 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1231 LO: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1232
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1233 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1234 Long Text
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1235 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1236 LT: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1237
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1238 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1239 Other Byte String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1240 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1241 OB: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1242
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1243 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1244 Other Float String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1245 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1246 OF: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1247
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1248 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1249 Other Word String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1250 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1251 OW: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1252
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1253 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1254 Person Name
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1255 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1256 PN: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1257
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1258 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1259 Short String
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1260 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1261 SH: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1262
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1263 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1264 Signed Long
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1265 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1266 SL: int = 18,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1267
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1268 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1269 Sequence of Items
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1270 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1271 SQ: int = 19,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1272
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1273 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1274 Signed Short
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1275 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1276 SS: int = 20,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1277
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1278 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1279 Short Text
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1280 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1281 ST: int = 21,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1282
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1283 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1284 Time
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1285 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1286 TM: int = 22,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1287
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1288 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1289 Unique Identifier (UID)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1290 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1291 UI: int = 23,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1292
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1293 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1294 Unsigned Long
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1295 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1296 UL: int = 24,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1297
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1298 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1299 Unknown
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1300 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1301 UN: int = 25,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1302
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1303 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1304 Unsigned Short
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1305 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1306 US: int = 26,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1307
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1308 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1309 Unlimited Text
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1310 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1311 UT: int = 27,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1312
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1313
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1314 # This function returns the MIME type of a file by inspecting its extension
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1315 def AutodetectMimeType(path: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1316 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1317 This function returns the MIME type of a file by inspecting its extension.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1318
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1319 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1320 path (str): Path to the file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1321
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1322 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1323 str: The MIME type. This is a statically-allocated string, do not free it.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1324 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1325 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1326 # This function compresses or decompresses a buffer, using the version of the zlib library that is used by the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1327 def BufferCompression(source: bytes, compression: CompressionType, uncompress: int) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1328 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1329 This function compresses or decompresses a buffer, using the version of the zlib library that is used by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1330
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1331 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1332 source (bytes): The source buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1333 compression (CompressionType): The compression algorithm.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1334 uncompress (int): If set to "0", the buffer must be compressed. If set to "1", the buffer must be uncompressed.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1335
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1336 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1337 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1338 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1339 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1340 # This function checks whether the version of the Orthanc server running this plugin, is above the version of the current Orthanc SDK header
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1341 def CheckVersion() -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1342 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1343 This function checks whether the version of the Orthanc server running this plugin, is above the version of the current Orthanc SDK header. This guarantees that the plugin is compatible with the hosting Orthanc (i.e. it will not call unavailable services). The result of this function should always be checked in the OrthancPluginInitialize() entry point of the plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1344
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1345 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1346 int: 1 if and only if the versions are compatible. If the result is 0, the initialization of the plugin should fail.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1347 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1348 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1349 # This function checks whether the version of the Orthanc server running this plugin, is above the given version
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1350 def CheckVersionAdvanced(expected_major: int, expected_minor: int, expected_revision: int) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1351 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1352 This function checks whether the version of the Orthanc server running this plugin, is above the given version. Contrarily to OrthancPluginCheckVersion(), it is up to the developer of the plugin to make sure that all the Orthanc SDK services called by the plugin are actually implemented in the given version of Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1353
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1354 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1355 expected_major (int): Expected major version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1356 expected_minor (int): Expected minor version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1357 expected_revision (int): Expected revision.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1358
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1359 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1360 int: 1 if and only if the versions are compatible. If the result is 0, the initialization of the plugin should fail.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1361 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1362 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1363 # This function compresses the given memory buffer containing an image using the JPEG specification, and stores the result of the compression into a newly allocated memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1364 def CompressJpegImage(format: PixelFormat, width: int, height: int, pitch: int, buffer: bytes, quality: int) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1365 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1366 This function compresses the given memory buffer containing an image using the JPEG specification, and stores the result of the compression into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1367
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1368 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1369 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1370 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1371 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1372 pitch (int): The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1373 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1374 quality (int): The quality of the JPEG encoding, between 1 (worst quality, best compression) and 100 (best quality, worst compression).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1375
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1376 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1377 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1378 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1379 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1380 # This function compresses the given memory buffer containing an image using the PNG specification, and stores the result of the compression into a newly allocated memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1381 def CompressPngImage(format: PixelFormat, width: int, height: int, pitch: int, buffer: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1382 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1383 This function compresses the given memory buffer containing an image using the PNG specification, and stores the result of the compression into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1384
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1385 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1386 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1387 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1388 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1389 pitch (int): The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1390 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1391
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1392 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1393 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1394 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1395 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1396 # This functions computes the MD5 cryptographic hash of the given memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1397 def ComputeMd5(buffer: bytes) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1398 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1399 This functions computes the MD5 cryptographic hash of the given memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1400
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1401 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1402 buffer (bytes): The source memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1403
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1404 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1405 str: The NULL value in case of error, or a string containing the cryptographic hash. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1406 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1407 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1408 # This functions computes the SHA-1 cryptographic hash of the given memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1409 def ComputeSha1(buffer: bytes) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1410 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1411 This functions computes the SHA-1 cryptographic hash of the given memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1412
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1413 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1414 buffer (bytes): The source memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1415
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1416 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1417 str: The NULL value in case of error, or a string containing the cryptographic hash. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1418 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1419 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1420 # This function takes as input a string containing a JSON file describing the content of a DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1421 def CreateDicom(json: str, pixel_data: Image, flags: CreateDicomFlags) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1422 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1423 This function takes as input a string containing a JSON file describing the content of a DICOM instance. As an output, it writes the corresponding DICOM instance to a newly allocated memory buffer. Additionally, an image to be encoded within the DICOM instance can also be provided.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1424 Private tags will be associated with the private creator whose value is specified in the "DefaultPrivateCreator" configuration option of Orthanc. The function OrthancPluginCreateDicom2() can be used if another private creator must be used to create this instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1425
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1426 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1427 json (str): The input JSON file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1428 pixel_data (Image): The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1429 flags (CreateDicomFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1430
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1431 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1432 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1433 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1434 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1435 # This function takes as input a string containing a JSON file describing the content of a DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1436 def CreateDicom2(json: str, pixel_data: Image, flags: CreateDicomFlags, private_creator: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1437 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1438 This function takes as input a string containing a JSON file describing the content of a DICOM instance. As an output, it writes the corresponding DICOM instance to a newly allocated memory buffer. Additionally, an image to be encoded within the DICOM instance can also be provided.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1439 Contrarily to the function OrthancPluginCreateDicom(), this function can be explicitly provided with a private creator.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1440
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1441 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1442 json (str): The input JSON file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1443 pixel_data (Image): The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1444 flags (CreateDicomFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1445 private_creator (str): The private creator to be used for the private DICOM tags. Check out the global configuration option "Dictionary" of Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1446
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1447 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1448 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1449 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1450 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1451 # This function parses a memory buffer that contains a DICOM file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1452 def CreateDicomInstance(buffer: bytes) -> DicomInstance:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1453 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1454 This function parses a memory buffer that contains a DICOM file. The function returns a new pointer to a data structure that is managed by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1455
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1456 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1457 buffer (bytes): The memory buffer containing the DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1458
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1459 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1460 DicomInstance: The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1461 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1462 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1463 # This function creates a "matcher" object that can be used to check whether a DICOM instance matches a C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1464 def CreateFindMatcher(query: bytes) -> FindMatcher:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1465 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1466 This function creates a "matcher" object that can be used to check whether a DICOM instance matches a C-Find query. The C-Find query must be expressed as a DICOM buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1467
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1468 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1469 query (bytes): The C-Find DICOM query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1470
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1471 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1472 FindMatcher: The newly allocated matcher. It must be freed with OrthancPluginFreeFindMatcher().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1473 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1474 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1475 # This function creates an image of given size and format
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1476 def CreateImage(format: PixelFormat, width: int, height: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1477 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1478 This function creates an image of given size and format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1479
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1480 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1481 format (PixelFormat): The format of the pixels.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1482 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1483 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1484
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1485 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1486 Image: The newly allocated image. It must be freed with OrthancPluginFreeImage().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1487 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1488 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1489 # This function decodes one frame of a DICOM image that is stored in a memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1490 def DecodeDicomImage(buffer: bytes, frame_index: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1491 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1492 This function decodes one frame of a DICOM image that is stored in a memory buffer. This function will give the same result as OrthancPluginUncompressImage() for single-frame DICOM images.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1493
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1494 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1495 buffer (bytes): Pointer to a memory buffer containing the DICOM image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1496 frame_index (int): The index of the frame of interest in a multi-frame image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1497
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1498 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1499 Image: The uncompressed image. It must be freed with OrthancPluginFreeImage().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1500 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1501 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1502 # This function takes as input a memory buffer containing a DICOM file, and outputs a JSON string representing the tags of this DICOM file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1503 def DicomBufferToJson(buffer: bytes, format: DicomToJsonFormat, flags: DicomToJsonFlags, max_string_length: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1504 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1505 This function takes as input a memory buffer containing a DICOM file, and outputs a JSON string representing the tags of this DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1506
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1507 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1508 buffer (bytes): The memory buffer containing the DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1509 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1510 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1511 max_string_length (int): The maximum length of a field. Too long fields will be output as "null". The 0 value means no maximum length.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1512
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1513 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1514 str: The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1515 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1516 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1517 # This function formats a DICOM instance that is stored in Orthanc, and outputs a JSON string representing the tags of this DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1518 def DicomInstanceToJson(instance_id: str, format: DicomToJsonFormat, flags: DicomToJsonFlags, max_string_length: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1519 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1520 This function formats a DICOM instance that is stored in Orthanc, and outputs a JSON string representing the tags of this DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1521
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1522 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1523 instance_id (str): The Orthanc identifier of the instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1524 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1525 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1526 max_string_length (int): The maximum length of a field. Too long fields will be output as "null". The 0 value means no maximum length.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1527
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1528 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1529 str: The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1530 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1531 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1532 # Add JavaScript code to customize the default behavior of Orthanc Explorer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1533 def ExtendOrthancExplorer(javascript: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1534 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1535 Add JavaScript code to customize the default behavior of Orthanc Explorer. This can for instance be used to add new buttons.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1536
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1537 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1538 javascript (str): The custom JavaScript code.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1539 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1540 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1541 # This function generates a token that can be set in the HTTP header "Authorization" so as to grant full access to the REST API of Orthanc using an external HTTP client
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1542 def GenerateRestApiAuthorizationToken() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1543 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1544 This function generates a token that can be set in the HTTP header "Authorization" so as to grant full access to the REST API of Orthanc using an external HTTP client. Using this function avoids the need of adding a separate user in the "RegisteredUsers" configuration of Orthanc, which eases deployments.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1545 This feature is notably useful in multiprocess scenarios, where a subprocess created by a plugin has no access to the "OrthancPluginContext", and thus cannot call "OrthancPluginRestApi[Get\|Post\|Put\|Delete]()".
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1546 This situation is frequently encountered in Python plugins, where the "multiprocessing" package can be used to bypass the Global Interpreter Lock (GIL) and thus to improve performance and concurrency.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1547
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1548 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1549 str: The authorization token, or NULL value in the case of an error. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1550 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1551 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1552 # Generate a random GUID/UUID (globally unique identifier)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1553 def GenerateUuid() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1554 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1555 Generate a random GUID/UUID (globally unique identifier).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1556
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1557 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1558 str: NULL in the case of an error, or a newly allocated string containing the UUID. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1559 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1560 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1561 # Get the value of one of the command-line arguments that were used to launch Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1562 def GetCommandLineArgument(argument: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1563 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1564 Get the value of one of the command-line arguments that were used to launch Orthanc. The number of available arguments can be retrieved by OrthancPluginGetCommandLineArgumentsCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1565
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1566 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1567 argument (int): The index of the argument.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1568
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1569 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1570 str: The value of the argument, or NULL in the case of an error. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1571 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1572 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1573 # Retrieve the number of command-line arguments that were used to launch Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1574 def GetCommandLineArgumentsCount() -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1575 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1576 Retrieve the number of command-line arguments that were used to launch Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1577
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1578 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1579 int: The number of arguments.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1580 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1581 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1582 # This function returns the content of the configuration that is used by Orthanc, formatted as a JSON string
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1583 def GetConfiguration() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1584 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1585 This function returns the content of the configuration that is used by Orthanc, formatted as a JSON string.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1586
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1587 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1588 str: NULL in the case of an error, or a newly allocated string containing the configuration. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1589 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1590 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1591 # This function returns the path to the configuration file(s) that was specified when starting Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1592 def GetConfigurationPath() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1593 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1594 This function returns the path to the configuration file(s) that was specified when starting Orthanc. Since version 0.9.1, this path can refer to a folder that stores a set of configuration files. This function is deprecated in favor of OrthancPluginGetConfiguration().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1595
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1596 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1597 str: NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1598 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1599 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1600 # Retrieve a DICOM instance using its Orthanc identifier
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1601 def GetDicomForInstance(instance_id: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1602 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1603 Retrieve a DICOM instance using its Orthanc identifier. The DICOM file is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1604
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1605 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1606 instance_id (str): The Orthanc identifier of the DICOM instance of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1607
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1608 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1609 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1610 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1611 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1612 # This function returns the description of a given error code
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1613 def GetErrorDescription(error: ErrorCode) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1614 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1615 This function returns the description of a given error code.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1616
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1617 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1618 error (ErrorCode): The error code of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1619
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1620 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1621 str: The error description. This is a statically-allocated string, do not free it.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1622 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1623 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1624 # Retrieve the expected version of the database schema
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1625 def GetExpectedDatabaseVersion() -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1626 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1627 Retrieve the expected version of the database schema.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1628
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1629 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1630 int: The version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1631 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1632 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1633 # This function returns the name of a font that is built in the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1634 def GetFontName(font_index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1635 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1636 This function returns the name of a font that is built in the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1637
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1638 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1639 font_index (int): The index of the font. This value must be less than OrthancPluginGetFontsCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1640
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1641 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1642 str: The font name. This is a statically-allocated string, do not free it.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1643 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1644 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1645 # This function returns the size of a font that is built in the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1646 def GetFontSize(font_index: int) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1647 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1648 This function returns the size of a font that is built in the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1649
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1650 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1651 font_index (int): The index of the font. This value must be less than OrthancPluginGetFontsCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1652
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1653 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1654 int: The font size.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1655 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1656 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1657 # This function returns the number of fonts that are built in the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1658 def GetFontsCount() -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1659 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1660 This function returns the number of fonts that are built in the Orthanc core. These fonts can be used to draw texts on images through OrthancPluginDrawText().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1661
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1662 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1663 int: The number of fonts.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1664 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1665 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1666 # Get the value of a global property that is stored in the Orthanc database
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1667 def GetGlobalProperty(property: int, default_value: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1668 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1669 Get the value of a global property that is stored in the Orthanc database. Global properties whose index is below 1024 are reserved by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1670
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1671 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1672 property (int): The global property of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1673 default_value (str): The value to return, if the global property is unset.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1674
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1675 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1676 str: The value of the global property, or NULL in the case of an error. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1677 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1678 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1679 # This function returns the path to the directory containing the Orthanc executable
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1680 def GetOrthancDirectory() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1681 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1682 This function returns the path to the directory containing the Orthanc executable.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1683
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1684 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1685 str: NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1686 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1687 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1688 # This function returns the path to the Orthanc executable
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1689 def GetOrthancPath() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1690 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1691 This function returns the path to the Orthanc executable.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1692
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1693 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1694 str: NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1695 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1696 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1697 # This function returns the parameters of the Orthanc peers that are known to the Orthanc server hosting the plugin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1698 def GetPeers() -> Peers:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1699 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1700 This function returns the parameters of the Orthanc peers that are known to the Orthanc server hosting the plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1701
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1702 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1703 Peers: NULL if error, or a newly allocated opaque data structure containing the peers. This structure must be freed with OrthancPluginFreePeers().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1704 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1705 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1706 # This function makes a lookup to the dictionary of DICOM tags that are known to Orthanc, and returns the symbolic name of a DICOM tag
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1707 def GetTagName(group: int, element: int, private_creator: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1708 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1709 This function makes a lookup to the dictionary of DICOM tags that are known to Orthanc, and returns the symbolic name of a DICOM tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1710
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1711 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1712 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1713 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1714 private_creator (str): For private tags, the name of the private creator (can be NULL).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1715
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1716 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1717 str: NULL in the case of an error, or a newly allocated string containing the path. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1718 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1719 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1720 # Make a HTTP DELETE call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1721 def HttpDelete(url: str, username: str, password: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1722 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1723 Make a HTTP DELETE call to the given URL. Favor OrthancPluginRestApiDelete() if calling the built-in REST API of the Orthanc instance that hosts this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1724
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1725 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1726 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1727 username (str): The username (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1728 password (str): The password (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1729 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1730 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1731 # Make a HTTP GET call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1732 def HttpGet(url: str, username: str, password: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1733 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1734 Make a HTTP GET call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiGet() if calling the built-in REST API of the Orthanc instance that hosts this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1735
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1736 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1737 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1738 username (str): The username (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1739 password (str): The password (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1740
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1741 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1742 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1743 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1744 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1745 # Make a HTTP POST call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1746 def HttpPost(url: str, body: bytes, username: str, password: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1747 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1748 Make a HTTP POST call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiPost() if calling the built-in REST API of the Orthanc instance that hosts this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1749
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1750 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1751 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1752 body (bytes): The content of the body of the request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1753 username (str): The username (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1754 password (str): The password (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1755
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1756 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1757 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1758 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1759 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1760 # Make a HTTP PUT call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1761 def HttpPut(url: str, body: bytes, username: str, password: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1762 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1763 Make a HTTP PUT call to the given URL. The result to the query is stored into a newly allocated memory buffer. Favor OrthancPluginRestApiPut() if calling the built-in REST API of the Orthanc instance that hosts this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1764
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1765 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1766 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1767 body (bytes): The content of the body of the request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1768 username (str): The username (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1769 password (str): The password (can be "NULL" if no password protection).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1770
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1771 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1772 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1773 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1774 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1775 # Log an error message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1776 def LogError(message: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1777 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1778 Log an error message using the Orthanc logging system.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1779
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1780 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1781 message (str): The message to be logged.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1782 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1783 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1784 # Log an information message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1785 def LogInfo(message: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1786 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1787 Log an information message using the Orthanc logging system.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1788
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1789 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1790 message (str): The message to be logged.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1791 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1792 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1793 # Log a warning message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1794 def LogWarning(message: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1795 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1796 Log a warning message using the Orthanc logging system.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1797
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1798 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1799 message (str): The message to be logged.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1800 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1801 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1802 # Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1803 def LookupInstance(sop_instance_u_i_d: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1804 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1805 Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018). This function uses the database index to run as fast as possible (it does not loop over all the stored instances).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1806
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1807 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1808 sop_instance_u_i_d (str): The SOP Instance UID of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1809
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1810 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1811 str: The NULL value if the instance is non-existent, or a string containing the Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1812 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1813 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1814 # Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1815 def LookupPatient(patient_i_d: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1816 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1817 Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020). This function uses the database index to run as fast as possible (it does not loop over all the stored patients).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1818
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1819 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1820 patient_i_d (str): The Patient ID of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1821
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1822 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1823 str: The NULL value if the patient is non-existent, or a string containing the Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1824 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1825 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1826 # Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1827 def LookupSeries(series_u_i_d: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1828 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1829 Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e). This function uses the database index to run as fast as possible (it does not loop over all the stored series).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1830
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1831 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1832 series_u_i_d (str): The Series Instance UID of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1833
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1834 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1835 str: The NULL value if the series is non-existent, or a string containing the Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1836 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1837 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1838 # Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1839 def LookupStudy(study_u_i_d: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1840 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1841 Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d). This function uses the database index to run as fast as possible (it does not loop over all the stored studies).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1842
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1843 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1844 study_u_i_d (str): The Study Instance UID of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1845
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1846 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1847 str: The NULL value if the study is non-existent, or a string containing the Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1848 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1849 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1850 # Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1851 def LookupStudyWithAccessionNumber(accession_number: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1852 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1853 Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050). This function uses the database index to run as fast as possible (it does not loop over all the stored studies).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1854
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1855 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1856 accession_number (str): The Accession Number of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1857
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1858 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1859 str: The NULL value if the study is non-existent, or a string containing the Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1860 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1861 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1862 # Read the content of a file on the filesystem, and returns it into a newly allocated memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1863 def ReadFile(path: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1864 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1865 Read the content of a file on the filesystem, and returns it into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1866
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1867 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1868 path (str): The path of the file to be read.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1869
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1870 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1871 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1872 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1873 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1874 # This function declares a new public tag in the dictionary of DICOM tags that are known to Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1875 def RegisterDictionaryTag(group: int, element: int, vr: ValueRepresentation, name: str, min_multiplicity: int, max_multiplicity: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1876 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1877 This function declares a new public tag in the dictionary of DICOM tags that are known to Orthanc. This function should be used in the OrthancPluginInitialize() callback.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1879 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1880 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1881 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1882 vr (ValueRepresentation): The value representation of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1883 name (str): The nickname of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1884 min_multiplicity (int): The minimum multiplicity of the tag (must be above 0).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1885 max_multiplicity (int): The maximum multiplicity of the tag. A value of 0 means an arbitrary multiplicity (""n"").
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1886 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1887 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1888 # This function declares a custom error code that can be generated by this plugin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1889 def RegisterErrorCode(code: int, http_status: int, message: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1890 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1891 This function declares a custom error code that can be generated by this plugin. This declaration is used to enrich the body of the HTTP answer in the case of an error, and to set the proper HTTP status code.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1892
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1893 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1894 code (int): The error code that is internal to this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1895 http_status (int): The HTTP status corresponding to this error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1896 message (str): The description of the error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1897 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1898 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1899 # This function declares a new private tag in the dictionary of DICOM tags that are known to Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1900 def RegisterPrivateDictionaryTag(group: int, element: int, vr: ValueRepresentation, name: str, min_multiplicity: int, max_multiplicity: int, private_creator: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1901 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1902 This function declares a new private tag in the dictionary of DICOM tags that are known to Orthanc. This function should be used in the OrthancPluginInitialize() callback.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1903
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1904 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1905 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1906 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1907 vr (ValueRepresentation): The value representation of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1908 name (str): The nickname of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1909 min_multiplicity (int): The minimum multiplicity of the tag (must be above 0).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1910 max_multiplicity (int): The maximum multiplicity of the tag. A value of 0 means an arbitrary multiplicity (""n"").
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1911 private_creator (str): The private creator of this private tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1912 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1913 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1914 # Make a DELETE call to the built-in Orthanc REST API
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1915 def RestApiDelete(uri: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1916 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1917 Make a DELETE call to the built-in Orthanc REST API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1918 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1919
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1920 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1921 uri (str): The URI to delete in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1922 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1923 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1924 # Make a DELETE call to the Orthanc REST API, after all the plugins are applied
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1925 def RestApiDeleteAfterPlugins(uri: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1926 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1927 Make a DELETE call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1928 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1929
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1930 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1931 uri (str): The URI to delete in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1932 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1933 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1934 # Make a GET call to the built-in Orthanc REST API
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1935 def RestApiGet(uri: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1936 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1937 Make a GET call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1938 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1939
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1940 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1941 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1942
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1943 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1944 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1945 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1946 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1947 # Make a GET call to the Orthanc REST API, after all the plugins are applied
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1948 def RestApiGetAfterPlugins(uri: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1949 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1950 Make a GET call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1951 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1952
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1953 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1954 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1955
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1956 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1957 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1958 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1959 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1960 # Make a POST call to the built-in Orthanc REST API
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1961 def RestApiPost(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1962 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1963 Make a POST call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1964 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1965
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1966 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1967 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1968 body (bytes): The body of the POST request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1969
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1970 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1971 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1972 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1973 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1974 # Make a POST call to the Orthanc REST API, after all the plugins are applied
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1975 def RestApiPostAfterPlugins(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1976 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1977 Make a POST call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1978 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1979
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1980 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1981 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1982 body (bytes): The body of the POST request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1983
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1984 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1985 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1986 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1987 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1988 # Make a PUT call to the built-in Orthanc REST API
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1989 def RestApiPut(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1990 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1991 Make a PUT call to the built-in Orthanc REST API. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1992 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1993
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1994 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1995 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1996 body (bytes): The body of the PUT request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1997
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1998 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1999 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2000 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2001 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2002 # Make a PUT call to the Orthanc REST API, after all the plugins are applied
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2003 def RestApiPutAfterPlugins(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2004 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2005 Make a PUT call to the Orthanc REST API, after all the plugins are applied. In other words, if some plugin overrides or adds the called URI to the built-in Orthanc REST API, this call will return the result provided by this plugin. The result to the query is stored into a newly allocated memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2006 Remark: If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2007
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2008 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2009 uri (str): The URI in the built-in Orthanc API.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2010 body (bytes): The body of the PUT request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2011
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2012 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2013 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2014 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2015 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2016 # Set a description for this plugin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2017 def SetDescription(description: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2018 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2019 Set a description for this plugin. It is displayed in the "Plugins" page of Orthanc Explorer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2020
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2021 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2022 description (str): The description.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2023 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2024 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2025 # Set the value of a global property into the Orthanc database
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2026 def SetGlobalProperty(property: int, value: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2027 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2028 Set the value of a global property into the Orthanc database. Setting a global property can be used by plugins to save their internal parameters. Plugins are only allowed to set properties whose index are above or equal to 1024 (properties below 1024 are read-only and reserved by Orthanc).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2029
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2030 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2031 property (int): The global property of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2032 value (str): The value to be set in the global property.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2033 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2034 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2035 # This function sets the value of a metrics to monitor the behavior of the plugin through tools such as Prometheus
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2036 def SetMetricsValue(name: str, value: float, type: MetricsType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2037 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 This function sets the value of a metrics to monitor the behavior of the plugin through tools such as Prometheus. The values of all the metrics are stored within the Orthanc context.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2040 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2041 name (str): The name of the metrics to be set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2042 value (float): The value of the metrics.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2043 type (MetricsType): The type of the metrics. This parameter is only taken into consideration the first time this metrics is set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2044 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2045 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2046 # For plugins that come with a Web interface, this function declares the entry path where to find this interface
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2047 def SetRootUri(uri: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2048 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2049 For plugins that come with a Web interface, this function declares the entry path where to find this interface. This information is notably used in the "Plugins" page of Orthanc Explorer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2050
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2051 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2052 uri (str): The root URI for this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2054 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2055 # This function parses a memory buffer that contains a DICOM file, then transcodes it to the given transfer syntax
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2056 def TranscodeDicomInstance(buffer: bytes, transfer_syntax: str) -> DicomInstance:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2057 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2058 This function parses a memory buffer that contains a DICOM file, then transcodes it to the given transfer syntax. The function returns a new pointer to a data structure that is managed by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2059
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2060 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2061 buffer (bytes): The memory buffer containing the DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2062 transfer_syntax (str): The transfer syntax UID for the transcoding.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2063
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2064 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2065 DicomInstance: The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2066 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2067 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2068 # This function decodes a compressed image from a memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2069 def UncompressImage(data: bytes, format: ImageFormat) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2070 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2071 This function decodes a compressed image from a memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2072
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2073 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2074 data (bytes): Pointer to a memory buffer containing the compressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2075 format (ImageFormat): The file format of the compressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2076
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2077 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2078 Image: The uncompressed image. It must be freed with OrthancPluginFreeImage().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2079 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2080 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2081 # Write the content of a memory buffer to the filesystem
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2082 def WriteFile(path: str, data: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2083 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2084 Write the content of a memory buffer to the filesystem.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2085
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2086 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2087 path (str): The path of the file to be written.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2088 data (bytes): The content of the memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2089 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2090 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2091
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2092
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2093 class DicomInstance:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2094 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2095
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2096 # This function returns the Application Entity Title (AET) of the DICOM modality from which a DICOM instance originates
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2097 def GetInstanceRemoteAet(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2098 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2099 This function returns the Application Entity Title (AET) of the DICOM modality from which a DICOM instance originates.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2100
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2101 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2102 str: The AET if success, NULL if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2103 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2104 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2105 # This function returns the number of bytes of the given DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2106 def GetInstanceSize(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2107 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2108 This function returns the number of bytes of the given DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2109
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2110 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2111 int: The size of the file, -1 in case of error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2112 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2113 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2114 # This function returns a pointer to a newly created string containing a JSON file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2115 def GetInstanceJson(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2116 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2117 This function returns a pointer to a newly created string containing a JSON file. This JSON file encodes the tag hierarchy of the given DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2118
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2119 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2120 str: The NULL value in case of error, or a string containing the JSON file. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2121 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2122 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2123 # This function returns a pointer to a newly created string containing a JSON file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2124 def GetInstanceSimplifiedJson(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2125 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2126 This function returns a pointer to a newly created string containing a JSON file. This JSON file encodes the tag hierarchy of the given DICOM instance. In contrast with ::OrthancPluginGetInstanceJson(), the returned JSON file is in its simplified version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2127
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2128 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2129 str: The NULL value in case of error, or a string containing the JSON file. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2130 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2131 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2132 # This function checks whether the DICOM instance of interest is associated with some metadata
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2133 def HasInstanceMetadata(self, metadata: str) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2134 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2135 This function checks whether the DICOM instance of interest is associated with some metadata. As of Orthanc 0.8.1, in the callbacks registered by ::OrthancPluginRegisterOnStoredInstanceCallback(), the only possibly available metadata are "ReceptionDate", "RemoteAET" and "IndexInSeries".
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2136
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2137 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2138 metadata (str): The metadata of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2139
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2140 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2141 int: 1 if the metadata is present, 0 if it is absent, -1 in case of error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2142 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2143 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2144 # This functions returns the value of some metadata that is associated with the DICOM instance of interest
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2145 def GetInstanceMetadata(self, metadata: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2146 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2147 This functions returns the value of some metadata that is associated with the DICOM instance of interest. Before calling this function, the existence of the metadata must have been checked with ::OrthancPluginHasInstanceMetadata().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2148
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2149 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2150 metadata (str): The metadata of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2151
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2152 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2153 str: The metadata value if success, NULL if error. Please note that the returned string belongs to the instance object and must NOT be deallocated. Please make a copy of the string if you wish to access it later.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2154 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2155 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2156 # This function returns the origin of a DICOM instance that has been received by Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2157 def GetInstanceOrigin(self) -> InstanceOrigin:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2158 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2159 This function returns the origin of a DICOM instance that has been received by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2160
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2161 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2162 InstanceOrigin: The origin of the instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2163 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2164 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2165 # This function returns a pointer to a newly created string that contains the transfer syntax UID of the DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2166 def GetInstanceTransferSyntaxUid(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2167 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2168 This function returns a pointer to a newly created string that contains the transfer syntax UID of the DICOM instance. The empty string might be returned if this information is unknown.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2169
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2170 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2171 str: The NULL value in case of error, or a string containing the transfer syntax UID. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2172 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2173 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2174 # This function returns a Boolean value indicating whether the DICOM instance contains the pixel data (7FE0,0010) tag
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2175 def HasInstancePixelData(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2176 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2177 This function returns a Boolean value indicating whether the DICOM instance contains the pixel data (7FE0,0010) tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2178
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2179 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2180 int: "1" if the DICOM instance contains pixel data, or "0" if the tag is missing, or "-1" in the case of an error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2181 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2182 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2183 # This function returns the number of frames that are part of a DICOM image managed by the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2184 def GetInstanceFramesCount(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2185 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2186 This function returns the number of frames that are part of a DICOM image managed by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2187
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2188 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2189 int: The number of frames (will be zero in the case of an error).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2190 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2191 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2192 # This function returns a memory buffer containing the raw content of a frame in a DICOM instance that is managed by the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2193 def GetInstanceRawFrame(self, frame_index: int) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2194 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2195 This function returns a memory buffer containing the raw content of a frame in a DICOM instance that is managed by the Orthanc core. This is notably useful for compressed transfer syntaxes, as it gives access to the embedded files (such as JPEG, JPEG-LS or JPEG2k). The Orthanc core transparently reassembles the fragments to extract the raw frame.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2196
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2197 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2198 frame_index (int): The index of the frame of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2199
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2200 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2201 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2202 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2203 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2204 # This function decodes one frame of a DICOM image that is managed by the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2205 def GetInstanceDecodedFrame(self, frame_index: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2206 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2207 This function decodes one frame of a DICOM image that is managed by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2208
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2209 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2210 frame_index (int): The index of the frame of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2211
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2212 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2213 Image: The uncompressed image. It must be freed with OrthancPluginFreeImage().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2214 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2215 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2216 # This function returns a memory buffer containing the serialization of a DICOM instance that is managed by the Orthanc core
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2217 def SerializeDicomInstance(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2218 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2219 This function returns a memory buffer containing the serialization of a DICOM instance that is managed by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2220
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2221 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2222 bytes: 0 if success, or the error code if failure.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2223 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2224 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2225 # This function takes as DICOM instance managed by the Orthanc core, and outputs a JSON string representing the tags of this DICOM file
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2226 def GetInstanceAdvancedJson(self, format: DicomToJsonFormat, flags: DicomToJsonFlags, max_string_length: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2227 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2228 This function takes as DICOM instance managed by the Orthanc core, and outputs a JSON string representing the tags of this DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2229
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2230 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2231 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2232 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2233 max_string_length (int): The maximum length of a field. Too long fields will be output as "null". The 0 value means no maximum length.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2234
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2235 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2236 str: The NULL value if the case of an error, or the JSON string. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2237 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2238 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2239
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2240 # Get the content of the DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2241 def GetInstanceData(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2242 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2243 Get the content of the DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2244
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2245 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2246 bytes: The DICOM data.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2247 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2248 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2249 class DicomWebNode:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2250 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2251
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2252
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2253 class FindAnswers:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2254 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2255
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2256 # This function adds one answer (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request that is not related to modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2257 def FindAddAnswer(self, dicom: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2258 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2259 This function adds one answer (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request that is not related to modality worklists.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2260
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2261 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2262 dicom (bytes): The answer to be added, encoded as a DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2263 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2264 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2265 # This function marks as incomplete the set of answers corresponding to some C-Find SCP request that is not related to modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2266 def FindMarkIncomplete(self) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2267 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2268 This function marks as incomplete the set of answers corresponding to some C-Find SCP request that is not related to modality worklists. This must be used if canceling the handling of a request when too many answers are to be returned.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2269 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2270 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2271
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2272 class FindMatcher:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2273 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2274
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2275 # This function checks whether one DICOM instance matches C-Find matcher that was previously allocated using OrthancPluginCreateFindMatcher()
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2276 def FindMatcherIsMatch(self, dicom: bytes) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2278 This function checks whether one DICOM instance matches C-Find matcher that was previously allocated using OrthancPluginCreateFindMatcher().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2279
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2280 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2281 dicom (bytes): The DICOM instance to be matched.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2282
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2283 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2284 int: 1 if the DICOM instance matches the query, 0 otherwise.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2285 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2286 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2287
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288 class FindQuery:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2289 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2291 # This function returns the number of tags that are contained in the given C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2292 def GetFindQuerySize(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2293 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2294 This function returns the number of tags that are contained in the given C-Find query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2295
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2296 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2297 int: The number of tags.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2298 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2299 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2300 # This function returns the symbolic name of one DICOM tag in the given C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2301 def GetFindQueryTagName(self, index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2302 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2303 This function returns the symbolic name of one DICOM tag in the given C-Find query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2304
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 index (int): The index of the tag of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2307
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2308 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2309 str: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2310 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2311 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2312 # This function returns the value associated with one tag in the given C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2313 def GetFindQueryValue(self, index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2314 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2315 This function returns the value associated with one tag in the given C-Find query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2316
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2317 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2318 index (int): The index of the tag of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2319
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2320 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2321 str: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2322 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2323 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2324
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2325 # This function returns the group of one DICOM tag in the given C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2326 def GetFindQueryTagGroup(self, index: int) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2327 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2328 This function returns the group of one DICOM tag in the given C-Find query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2329
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2330 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2331 index (int): The index of the tag of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2332
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2333 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2334 int: The value of the group.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2335 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2336 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2337 # This function returns the element of one DICOM tag in the given C-Find query
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2338 def GetFindQueryTagElement(self, index: int) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2339 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2340 This function returns the element of one DICOM tag in the given C-Find query.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2341
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2342 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2343 index (int): The index of the tag of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2344
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2345 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2346 int: The value of the element.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2347 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2348 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2349 class Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2350 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2351
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2352 # This function returns the type of memory layout for the pixels of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2353 def GetImagePixelFormat(self) -> PixelFormat:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2354 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2355 This function returns the type of memory layout for the pixels of the given image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2356
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2357 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2358 PixelFormat: The pixel format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2359 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2360 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2361 # This function returns the width of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2362 def GetImageWidth(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2363 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2364 This function returns the width of the given image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2365
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2366 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2367 int: The width.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2368 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2369 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2370 # This function returns the height of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2371 def GetImageHeight(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2372 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2373 This function returns the height of the given image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2374
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2375 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2376 int: The height.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2377 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2378 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2379 # This function returns the pitch of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2380 def GetImagePitch(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2381 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2382 This function returns the pitch of the given image. The pitch is defined as the number of bytes between 2 successive lines of the image in the memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2383
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2384 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2385 int: The pitch.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2386 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2387 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2388 # This function creates a new image, changing the memory layout of the pixels
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2389 def ConvertPixelFormat(self, target_format: PixelFormat) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2390 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2391 This function creates a new image, changing the memory layout of the pixels.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2392
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2393 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2394 target_format (PixelFormat): The target pixel format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2395
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2396 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2397 Image: The resulting image. It must be freed with OrthancPluginFreeImage().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2398 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2399 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2400 # This function draws some text on some image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2401 def DrawText(self, font_index: int, utf8_text: str, x: int, y: int, r: int, g: int, b: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2402 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2403 This function draws some text on some image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2404
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2405 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2406 font_index (int): The index of the font. This value must be less than OrthancPluginGetFontsCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2407 utf8_text (str): The text to be drawn, encoded as an UTF-8 zero-terminated string.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2408 x (int): The X position of the text over the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2409 y (int): The Y position of the text over the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2410 r (int): The value of the red color channel of the text.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2411 g (int): The value of the green color channel of the text.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2412 b (int): The value of the blue color channel of the text.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2413 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2414 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2415
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2416 # This function returns a pointer to the memory buffer that contains the pixels of the image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2417 def GetImageBuffer(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2418 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2419 This function returns a pointer to the memory buffer that contains the pixels of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2420
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2421 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2422 bytes: The pixel data.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2423 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2424 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2425 class Job:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2426 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2427
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2428 # This function adds the given job to the pending jobs of Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2429 def SubmitJob(self, priority: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2430 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2431 This function adds the given job to the pending jobs of Orthanc. Orthanc will take take of freeing it by invoking the finalization callback provided to OrthancPluginCreateJob().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2432
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2433 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2434 priority (int): The priority of the job.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2435
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2436 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2437 str: ID of the newly-submitted job. This string must be freed by OrthancPluginFreeString().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2438 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2439 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2440
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2441 class Peers:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2442 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2443
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2444 # This function returns the number of Orthanc peers
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2445 def GetPeersCount(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2446 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2447 This function returns the number of Orthanc peers.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2448 This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2449
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2450 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2451 int: The number of peers.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2452 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2453 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2454 # This function returns the symbolic name of the Orthanc peer, which corresponds to the key of the "OrthancPeers" configuration option of Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2455 def GetPeerName(self, peer_index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2456 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2457 This function returns the symbolic name of the Orthanc peer, which corresponds to the key of the "OrthancPeers" configuration option of Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2458 This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2459
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2460 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2461 peer_index (int): The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2462
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2463 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2464 str: The symbolic name, or NULL in the case of an error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2465 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2466 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2467 # This function returns the base URL to the REST API of some Orthanc peer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2468 def GetPeerUrl(self, peer_index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2469 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2470 This function returns the base URL to the REST API of some Orthanc peer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2471 This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2472
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2473 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2474 peer_index (int): The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2475
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2476 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2477 str: The URL, or NULL in the case of an error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2478 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2479 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2480 # This function returns some user-defined property of some Orthanc peer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2481 def GetPeerUserProperty(self, peer_index: int, user_property: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2482 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2483 This function returns some user-defined property of some Orthanc peer. An user-defined property is a property that is associated with the peer in the Orthanc configuration file, but that is not recognized by the Orthanc core.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2484 This function is thread-safe: Several threads sharing the same OrthancPluginPeers object can simultaneously call this function.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2485
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2486 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2487 peer_index (int): The index of the peer of interest. This value must be lower than OrthancPluginGetPeersCount().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2488 user_property (str): The user property of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2489
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2490 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2491 str: The value of the user property, or NULL if it is not defined.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2492 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2493 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2494
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2495 class RestOutput:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2496 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2497
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2498 # This function answers to a REST request with the content of a memory buffer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2499 def AnswerBuffer(self, answer: bytes, mime_type: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2500 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2501 This function answers to a REST request with the content of a memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2502
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2503 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2504 answer (bytes): Pointer to the memory buffer containing the answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2505 mime_type (str): The MIME type of the answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2506 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2507 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2508 # This function answers to a REST request with a PNG image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2509 def CompressAndAnswerPngImage(self, format: PixelFormat, width: int, height: int, pitch: int, buffer: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2510 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2511 This function answers to a REST request with a PNG image. The parameters of this function describe a memory buffer that contains an uncompressed image. The image will be automatically compressed as a PNG image by the core system of Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2512
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2513 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2514 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2515 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2516 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2517 pitch (int): The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2518 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2519 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2520 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2521 # This function answers to a REST request by redirecting the user to another URI using HTTP status 301
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2522 def Redirect(self, redirection: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2523 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2524 This function answers to a REST request by redirecting the user to another URI using HTTP status 301.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2525
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2526 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2527 redirection (str): Where to redirect.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2528 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2529 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2530 # This function answers to a REST request by sending a HTTP status code (such as "400 - Bad Request")
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2531 def SendHttpStatusCode(self, status: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2532 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2533 This function answers to a REST request by sending a HTTP status code (such as "400 - Bad Request"). Note that: - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - Redirections (status 301) must use ::OrthancPluginRedirect(). - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2534
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2535 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2536 status (int): The HTTP status code to be sent.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2537 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2538 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2539 # This function answers to a REST request by signaling that it is not authorized
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2540 def SendUnauthorized(self, realm: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2541 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2542 This function answers to a REST request by signaling that it is not authorized.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2543
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2544 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2545 realm (str): The realm for the authorization process.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2546 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2547 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2548 # This function answers to a REST request by signaling that the queried URI does not support this method
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2549 def SendMethodNotAllowed(self, allowed_methods: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2550 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2551 This function answers to a REST request by signaling that the queried URI does not support this method.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2552
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2553 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2554 allowed_methods (str): The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2555 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2556 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2557 # This function sets a cookie in the HTTP client
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2558 def SetCookie(self, cookie: str, value: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2559 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2560 This function sets a cookie in the HTTP client.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2561
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2562 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2563 cookie (str): The cookie to be set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2564 value (str): The value of the cookie.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2565 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2566 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2567 # This function sets a HTTP header in the HTTP answer
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2568 def SetHttpHeader(self, key: str, value: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2569 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2570 This function sets a HTTP header in the HTTP answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2571
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2572 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2573 key (str): The HTTP header to be set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2574 value (str): The value of the HTTP header.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2575 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2576 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2577 # Initiates a HTTP multipart answer, as the result of a REST request
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2578 def StartMultipartAnswer(self, sub_type: str, content_type: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2579 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2580 Initiates a HTTP multipart answer, as the result of a REST request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2581
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2582 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2583 sub_type (str): The sub-type of the multipart answer ("mixed" or "related").
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2584 content_type (str): The MIME type of the items in the multipart answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2585 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2586 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2587 # This function sends an item as a part of some HTTP multipart answer that was initiated by OrthancPluginStartMultipartAnswer()
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2588 def SendMultipartItem(self, answer: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2589 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2590 This function sends an item as a part of some HTTP multipart answer that was initiated by OrthancPluginStartMultipartAnswer().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2591
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2592 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2593 answer (bytes): Pointer to the memory buffer containing the item.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2594 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2595 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2596 # This function answers to a HTTP request by sending a HTTP status code (such as "400 - Bad Request"), together with a body describing the error
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2597 def SendHttpStatus(self, status: int, body: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2598 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2599 This function answers to a HTTP request by sending a HTTP status code (such as "400 - Bad Request"), together with a body describing the error. The body will only be returned if the configuration option "HttpDescribeErrors" of Orthanc is set to "true".
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2600 Note that: - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). - Redirections (status 301) must use ::OrthancPluginRedirect(). - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2601
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2602 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2603 status (int): The HTTP status code to be sent.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2604 body (bytes): The body of the answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2605 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2606 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2607 # This function answers to a REST request with a JPEG image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2608 def CompressAndAnswerJpegImage(self, format: PixelFormat, width: int, height: int, pitch: int, buffer: bytes, quality: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2609 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2610 This function answers to a REST request with a JPEG image. The parameters of this function describe a memory buffer that contains an uncompressed image. The image will be automatically compressed as a JPEG image by the core system of Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2611
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2612 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2613 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2614 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2615 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2616 pitch (int): The pitch of the image (i.e. the number of bytes between 2 successive lines of the image in the memory buffer).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2617 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2618 quality (int): The quality of the JPEG encoding, between 1 (worst quality, best compression) and 100 (best quality, worst compression).
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2619 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2620 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2621 # This function sets the detailed description associated with an HTTP error
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2622 def SetHttpErrorDetails(self, details: str, log: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2623 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2624 This function sets the detailed description associated with an HTTP error. This description will be displayed in the "Details" field of the JSON body of the HTTP answer. It is only taken into consideration if the REST callback returns an error code that is different from "OrthancPluginErrorCode_Success", and if the "HttpDescribeErrors" configuration option of Orthanc is set to "true".
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2625
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2626 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2627 details (str): The details of the error message.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2628 log (int): Whether to also write the detailed error to the Orthanc logs.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2629 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2630 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2631
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2632 class ServerChunkedRequestReader:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2633 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2634
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2635
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2636 class StorageArea:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2637 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2638
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2639 # This function creates a new file inside the storage area that is currently used by Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2640 def StorageAreaCreate(self, uuid: str, content: bytes, size: int, type: ContentType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2641 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2642 This function creates a new file inside the storage area that is currently used by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2643
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2644 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2645 uuid (str): The identifier of the file to be created.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2646 content (bytes): The content to store in the newly created file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2647 size (int): The size of the content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2648 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2649 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2650 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2651 # This function reads the content of a given file from the storage area that is currently used by Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2652 def StorageAreaRead(self, uuid: str, type: ContentType) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2653 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2654 This function reads the content of a given file from the storage area that is currently used by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2655
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2656 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2657 uuid (str): The identifier of the file to be read.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2658 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2659
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2660 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2661 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2662 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2663 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2664 # This function removes a given file from the storage area that is currently used by Orthanc
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2665 def StorageAreaRemove(self, uuid: str, type: ContentType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2666 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2667 This function removes a given file from the storage area that is currently used by Orthanc.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2668
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2669 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2670 uuid (str): The identifier of the file to be removed.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2671 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2672 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2673 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2674 # This function requests the Orthanc core to reconstruct the main DICOM tags of all the resources of the given type
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2675 def ReconstructMainDicomTags(self, level: ResourceType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2676 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2677 This function requests the Orthanc core to reconstruct the main DICOM tags of all the resources of the given type. This function can only be used as a part of the upgrade of a custom database back-end. A database transaction will be automatically setup.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2678
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2679 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2680 level (ResourceType): The type of the resources of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2681 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2682 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2683
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2684 class WorklistAnswers:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2685 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2686
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2687 # This function adds one worklist (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request against modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2688 def WorklistAddAnswer(self, query: WorklistQuery, dicom: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2689 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2690 This function adds one worklist (encoded as a DICOM file) to the set of answers corresponding to some C-Find SCP request against modality worklists.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2691
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2692 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2693 query (WorklistQuery): The worklist query, as received by the callback.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2694 dicom (bytes): The worklist to answer, encoded as a DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2695 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2696 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2697 # This function marks as incomplete the set of answers corresponding to some C-Find SCP request against modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2698 def WorklistMarkIncomplete(self) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2699 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2700 This function marks as incomplete the set of answers corresponding to some C-Find SCP request against modality worklists. This must be used if canceling the handling of a request when too many answers are to be returned.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2701 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2702 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2703
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2704 class WorklistQuery:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2705 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2706
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2707 # This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2708 def WorklistIsMatch(self, dicom: bytes) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2709 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2710 This function checks whether one worklist (encoded as a DICOM file) matches the C-Find SCP query against modality worklists. This function must be called before adding the worklist as an answer through OrthancPluginWorklistAddAnswer().
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2711
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2712 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2713 dicom (bytes): The worklist to answer, encoded as a DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2714
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2715 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2716 int: 1 if the worklist matches the query, 0 otherwise.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2717 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2718 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2719 # This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2720 def WorklistGetDicomQuery(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2721 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2722 This function retrieves the DICOM file that underlies a C-Find SCP query against modality worklists.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2723
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2724 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2725 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2726 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2727 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2728

Mercurial > hg > orthanc-python

annotate Sources/Autogenerated/orthanc.pyi @ 191:30ed49f2487f java-code-model