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

annotate Sources/Autogenerated/orthanc.pyi @ 203:28531e615104

documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback()

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Wed, 03 Jul 2024 12:03:09 +0200
parents	d7a6e75558ee
children	234681297600

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
192 b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	26 import typing
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	27
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	28
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 class ChangeType(enum.Enum):
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 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	33 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34
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 Series is now complete
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 COMPLETED_SERIES: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	39
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 resource
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 DELETED: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	44
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 A new instance was added to this resource
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 NEW_CHILD_INSTANCE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	49
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 received
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 NEW_INSTANCE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	54
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 created
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 NEW_PATIENT: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	59
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 created
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 NEW_SERIES: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	64
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 created
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 NEW_STUDY: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69
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 Timeout: No new instance in this patient
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 STABLE_PATIENT: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74
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 Timeout: No new instance in this series
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 STABLE_SERIES: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79
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 Timeout: No new instance in this study
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 STABLE_STUDY: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84
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 has started
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 ORTHANC_STARTED: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89
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 is stopping
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 ORTHANC_STOPPED: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94
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 Some user-defined attachment has changed for this resource
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 UPDATED_ATTACHMENT: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99
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 Some user-defined metadata has changed for this resource
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 UPDATED_METADATA: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	104
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 The list of Orthanc peers has changed
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 UPDATED_PEERS: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109
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 The list of DICOM modalities has changed
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 UPDATED_MODALITIES: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	114
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 New Job submitted
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 JOB_SUBMITTED: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	119
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 A Job has completed successfully
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 JOB_SUCCESS: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	124
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 A Job has failed
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 JOB_FAILURE: int = 18,
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 class CompressionType(enum.Enum):
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 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	133 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	134
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 Standard zlib compression
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 ZLIB: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	139
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, prefixed with uncompressed size (uint64_t)
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 ZLIB_WITH_SIZE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144
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 Standard gzip compression
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 GZIP: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	149
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, prefixed with uncompressed size (uint64_t)
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 GZIP_WITH_SIZE: int = 3,
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 class ConstraintType(enum.Enum):
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 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	158 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	159
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
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 EQUAL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	164
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 Less or equal
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 SMALLER_OR_EQUAL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	169
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 More or equal
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 GREATER_OR_EQUAL: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174
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 matching
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 WILDCARD: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	179
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 of values
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 LIST: int = 5,
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 class ContentType(enum.Enum):
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 The content types that are supported by Orthanc plugins.
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
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 content type
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 UNKNOWN: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	194
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
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 DICOM: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	199
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 JSON summary of a DICOM file
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 DICOM_AS_JSON: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	204
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 Header till pixel data
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 DICOM_UNTIL_PIXEL_DATA: int = 3,
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 class CreateDicomFlags(enum.Enum):
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 Flags to the creation of a DICOM file.
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
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 Default mode
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 NONE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	219
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 fields encoded using data URI scheme
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 DECODE_DATA_URI_SCHEME: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	224
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 Automatically generate DICOM identifiers
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 GENERATE_IDENTIFIERS: int = 2,
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 class DicomToJsonFlags(enum.Enum):
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 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	233 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	234
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 Default formatting
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 NONE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	239
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 the binary tags
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 INCLUDE_BINARY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	244
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 the private tags
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 INCLUDE_PRIVATE_TAGS: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	249
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 the tags unknown by the dictionary
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 INCLUDE_UNKNOWN_TAGS: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	254
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 the pixel data
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 INCLUDE_PIXEL_DATA: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	259
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 Output binary tags as-is, dropping non-ASCII
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 CONVERT_BINARY_TO_ASCII: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	264
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 Signal binary tags as null values
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 CONVERT_BINARY_TO_NULL: int = 32,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	269
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 processing after pixel data (new in 1.9.1)
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 STOP_AFTER_PIXEL_DATA: int = 64,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	274
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 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	277 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	278 SKIP_GROUP_LENGTHS: int = 128,
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 class DicomToJsonFormat(enum.Enum):
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 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	283 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	284
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 output, with most details
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 FULL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	289
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 Tags output as hexadecimal numbers
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 SHORT: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294
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-readable JSON
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 HUMAN: int = 3,
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 class DicomWebBinaryMode(enum.Enum):
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 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	303 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304
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 Don't include binary tags
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 IGNORE: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309
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 encoding using Base64
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 INLINE_BINARY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314
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 Use a bulk data URI field
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 BULK_DATA_URI: int = 2,
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 class ErrorCode(enum.Enum):
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 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	323 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	324
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
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 INTERNAL_ERROR: int = -1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	329
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
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 SUCCESS: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	334
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 Error encountered within the plugin engine
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 PLUGIN: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	339
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 yet
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 NOT_IMPLEMENTED: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	344
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
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 PARAMETER_OUT_OF_RANGE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	349
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 The server hosting Orthanc is running out of memory
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 NOT_ENOUGH_MEMORY: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	354
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 type for a parameter
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 BAD_PARAMETER_TYPE: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	359
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
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 BAD_SEQUENCE_OF_CALLS: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	364
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 Accessing an inexistent item
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 INEXISTENT_ITEM: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	369
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
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 BAD_REQUEST: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	374
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 Error in the network protocol
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 NETWORK_PROTOCOL: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	379
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 Error while calling a system command
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 SYSTEM_COMMAND: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	384
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 Error with the database engine
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 DATABASE: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	389
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 Badly formatted URI
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 URI_SYNTAX: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	394
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
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 INEXISTENT_FILE: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	399
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 to file
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 CANNOT_WRITE_FILE: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	404
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
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 BAD_FILE_FORMAT: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	409
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
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 TIMEOUT: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	414
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
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 UNKNOWN_RESOURCE: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	419
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 version of the database
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 INCOMPATIBLE_DATABASE_VERSION: int = 18,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	424
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 The file storage is full
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 FULL_STORAGE: int = 19,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	429
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 (e.g. inconsistent MD5 hash)
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 CORRUPTED_FILE: int = 20,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	434
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
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 INEXISTENT_TAG: int = 21,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	439
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 Cannot modify a read-only data structure
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 READ_ONLY: int = 22,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	444
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 format of the images
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 INCOMPATIBLE_IMAGE_FORMAT: int = 23,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	449
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 size of the images
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 INCOMPATIBLE_IMAGE_SIZE: int = 24,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	454
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 Error while using a shared library (plugin)
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 SHARED_LIBRARY: int = 25,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	459
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 Plugin invoking an unknown service
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 UNKNOWN_PLUGIN_SERVICE: int = 26,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	464
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
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 UNKNOWN_DICOM_TAG: int = 27,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	469
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 Cannot parse a JSON document
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 BAD_JSON: int = 28,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	474
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 Bad credentials were provided to an HTTP request
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 UNAUTHORIZED: int = 29,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	479
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 Badly formatted font file
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 BAD_FONT: int = 30,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	484
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 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	487 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	488 DATABASE_PLUGIN: int = 31,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	489
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 Error in the plugin implementing a custom storage area
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 STORAGE_AREA_PLUGIN: int = 32,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	494
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 The request is empty
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 EMPTY_REQUEST: int = 33,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	499
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 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	502 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	503 NOT_ACCEPTABLE: int = 34,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	504
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 Cannot handle a NULL pointer
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 NULL_POINTER: int = 35,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	509
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 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	512 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	513 DATABASE_UNAVAILABLE: int = 36,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	514
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 This job was canceled
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 CANCELED_JOB: int = 37,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	519
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 Geometry error encountered in Stone
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 BAD_GEOMETRY: int = 38,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	524
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 Cannot initialize SSL encryption, check out your certificates
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 SSL_INITIALIZATION: int = 39,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	529
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 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	532 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	533 DISCONTINUED_ABI: int = 40,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	534
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 Incorrect range request
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 BAD_RANGE: int = 41,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	539
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 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	542 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	543 DATABASE_CANNOT_SERIALIZE: int = 42,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	544
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 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	547 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	548 REVISION: int = 43,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	549
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: The database is not opened
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 SQLITE_NOT_OPENED: int = 1000,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	554
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: Connection is already open
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 SQLITE_ALREADY_OPENED: int = 1001,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	559
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: Unable to open the database
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 SQLITE_CANNOT_OPEN: int = 1002,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	564
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: This cached statement is already being referred to
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 SQLITE_STATEMENT_ALREADY_USED: int = 1003,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	569
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: Cannot execute a command
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 SQLITE_EXECUTE: int = 1004,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	574
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: Rolling back a nonexistent transaction (have you called Begin()?)
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 SQLITE_ROLLBACK_WITHOUT_TRANSACTION: int = 1005,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	579
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: Committing a nonexistent transaction
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 SQLITE_COMMIT_WITHOUT_TRANSACTION: int = 1006,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	584
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: Unable to register a function
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 SQLITE_REGISTER_FUNCTION: int = 1007,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	589
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: Unable to flush the database
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 SQLITE_FLUSH: int = 1008,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	594
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 a cached statement
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 SQLITE_CANNOT_RUN: int = 1009,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	599
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 over a cached statement
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 SQLITE_CANNOT_STEP: int = 1010,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	604
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: Bing a value while out of range (serious error)
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 SQLITE_BIND_OUT_OF_RANGE: int = 1011,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	609
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: Cannot prepare a cached statement
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 SQLITE_PREPARE_STATEMENT: int = 1012,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	614
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: Beginning the same transaction twice
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 SQLITE_TRANSACTION_ALREADY_STARTED: int = 1013,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	619
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: Failure when committing the transaction
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 SQLITE_TRANSACTION_COMMIT: int = 1014,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	624
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: Cannot start a transaction
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 SQLITE_TRANSACTION_BEGIN: int = 1015,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	629
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 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	632 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	633 DIRECTORY_OVER_FILE: int = 2000,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	634
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 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	637 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	638 FILE_STORAGE_CANNOT_WRITE: int = 2001,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	639
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 The specified path does not point to a directory
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 DIRECTORY_EXPECTED: int = 2002,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	644
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 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	647 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	648 HTTP_PORT_IN_USE: int = 2003,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	649
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 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	652 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	653 DICOM_PORT_IN_USE: int = 2004,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	654
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 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	657 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	658 BAD_HTTP_STATUS_IN_REST: int = 2005,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	659
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 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	662 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	663 REGULAR_FILE_EXPECTED: int = 2006,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	664
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 Unable to get the path to the executable
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 PATH_TO_EXECUTABLE: int = 2007,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	669
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 Cannot create a directory
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 MAKE_DIRECTORY: int = 2008,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	674
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 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	677 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	678 BAD_APPLICATION_ENTITY_TITLE: int = 2009,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	679
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 request handler factory for DICOM C-FIND SCP
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 NO_CFIND_HANDLER: int = 2010,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	684
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 request handler factory for DICOM C-MOVE SCP
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 NO_CMOVE_HANDLER: int = 2011,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	689
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 request handler factory for DICOM C-STORE SCP
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 NO_CSTORE_HANDLER: int = 2012,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	694
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
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 NO_APPLICATION_ENTITY_FILTER: int = 2013,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	699
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 DicomUserConnection: Unable to find the SOP class and instance
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 NO_SOP_CLASS_OR_INSTANCE: int = 2014,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	704
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 DicomUserConnection: No acceptable presentation context for modality
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 NO_PRESENTATION_CONTEXT: int = 2015,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	709
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 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	712 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	713 DICOM_FIND_UNAVAILABLE: int = 2016,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	714
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 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	717 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	718 DICOM_MOVE_UNAVAILABLE: int = 2017,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	719
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 an instance
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 CANNOT_STORE_INSTANCE: int = 2018,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	724
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 Only string values are supported when creating DICOM instances
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 CREATE_DICOM_NOT_STRING: int = 2019,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	729
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 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	732 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	733 CREATE_DICOM_OVERRIDE_TAG: int = 2020,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	734
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 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	737 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	738 CREATE_DICOM_USE_CONTENT: int = 2021,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	739
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 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	742 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	743 CREATE_DICOM_NO_PAYLOAD: int = 2022,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	744
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 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	747 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	748 CREATE_DICOM_USE_DATA_URI_SCHEME: int = 2023,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	749
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 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	752 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	753 CREATE_DICOM_BAD_PARENT: int = 2024,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	754
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 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	757 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	758 CREATE_DICOM_PARENT_IS_INSTANCE: int = 2025,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	759
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 Unable to get the encoding of the parent resource
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 CREATE_DICOM_PARENT_ENCODING: int = 2026,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	764
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
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 UNKNOWN_MODALITY: int = 2027,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	769
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 ordering of filters in a job
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 BAD_JOB_ORDERING: int = 2028,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	774
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 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	777 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	778 JSON_TO_LUA_TABLE: int = 2029,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	779
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 the Lua context
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 CANNOT_CREATE_LUA: int = 2030,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	784
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 a Lua command
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 CANNOT_EXECUTE_LUA: int = 2031,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	789
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 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	792 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	793 LUA_ALREADY_EXECUTED: int = 2032,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	794
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 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	797 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	798 LUA_BAD_OUTPUT: int = 2033,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	799
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 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	802 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	803 NOT_LUA_PREDICATE: int = 2034,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	804
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 The Lua function does not return a string
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 LUA_RETURNS_NO_STRING: int = 2035,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	809
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 Another plugin has already registered a custom storage area
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 STORAGE_AREA_ALREADY_REGISTERED: int = 2036,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	814
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 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	817 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	818 DATABASE_BACKEND_ALREADY_REGISTERED: int = 2037,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	819
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 Plugin trying to call the database during its initialization
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 DATABASE_NOT_INITIALIZED: int = 2038,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	824
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 Orthanc has been built without SSL support
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 SSL_DISABLED: int = 2039,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	829
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 Unable to order the slices of the series
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 CANNOT_ORDER_SLICES: int = 2040,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	834
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 request handler factory for DICOM C-Find Modality SCP
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 NO_WORKLIST_HANDLER: int = 2041,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	839
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 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	842 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	843 ALREADY_EXISTING_TAG: int = 2042,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	844
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 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	847 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	848 NO_STORAGE_COMMITMENT_HANDLER: int = 2043,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	849
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 request handler factory for DICOM C-GET SCP
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 NO_CGET_HANDLER: int = 2044,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	854
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
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 UNSUPPORTED_MEDIA_TYPE: int = 3000,
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 class HttpMethod(enum.Enum):
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 The various HTTP methods for a REST call.
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
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 request
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 GET: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	869
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 request
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 POST: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	874
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 request
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 PUT: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	879
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 request
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 DELETE: int = 4,
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 class IdentifierConstraint(enum.Enum):
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 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	888 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	889
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
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 EQUAL: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	894
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 Less or equal
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 SMALLER_OR_EQUAL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	899
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 More or equal
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 GREATER_OR_EQUAL: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	904
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 Case-sensitive wildcard matching (with * and ?)
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 WILDCARD: int = 4,
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 class ImageFormat(enum.Enum):
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 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	913 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	914
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 Image compressed using PNG
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 PNG: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	919
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 Image compressed using JPEG
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 JPEG: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	924
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 Image compressed using DICOM
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 DICOM: int = 2,
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 class InstanceOrigin(enum.Enum):
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 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	933 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	934
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 origin
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 UNKNOWN: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	939
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 Instance received through DICOM protocol
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 DICOM_PROTOCOL: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	944
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 Instance received through REST API of Orthanc
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 REST_API: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	949
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 Instance added to Orthanc by a plugin
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 PLUGIN: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	954
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 Instance added to Orthanc by a Lua script
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 LUA: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	959
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 Instance received through WebDAV (new in 1.8.0)
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 WEB_DAV: int = 6,
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 class JobStepStatus(enum.Enum):
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 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	968 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	969
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 The job has successfully executed all its steps
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 SUCCESS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	974
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 The job has failed while executing this step
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 FAILURE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	979
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 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	982 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	983 CONTINUE: int = 3,
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 class JobStopReason(enum.Enum):
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 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	988 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	989
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 The job has succeeded
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 SUCCESS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	994
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 The job was paused, and will be resumed later
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 PAUSED: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	999
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 The job has failed, and might be resubmitted later
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 FAILURE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1004
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 The job was canceled, and might be resubmitted later
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 CANCELED: int = 4,
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 class MetricsType(enum.Enum):
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 The available types of metrics.
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
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 metrics
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 DEFAULT: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1019
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 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	1022 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1023 TIMER: int = 1,
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 class PixelFormat(enum.Enum):
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 The memory layout of the pixels of an image.
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
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 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	1032 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1033 GRAYSCALE8: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1034
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 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	1037 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1038 GRAYSCALE16: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1039
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 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	1042 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1043 SIGNED_GRAYSCALE16: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1044
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 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	1047 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1048 RGB24: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1049
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 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	1052 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1053 RGBA32: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1054
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 pixel format
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 UNKNOWN: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1059
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 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	1062 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1063 RGB48: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1064
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 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	1067 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1068 GRAYSCALE32: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1069
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 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	1072 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1073 FLOAT32: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1074
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 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	1077 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1078 BGRA32: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1079
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 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	1082 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1083 GRAYSCALE64: int = 11,
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 class ReceivedInstanceAction(enum.Enum):
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 The action to be taken after ReceivedInstanceCallback is triggered
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
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 the instance as is
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 KEEP_AS_IS: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1094
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 the instance
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 MODIFY: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1099
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 the instance
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 DISCARD: int = 3,
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 class ResourceType(enum.Enum):
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 The supported types of DICOM resources.
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
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
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 PATIENT: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1114
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
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 STUDY: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1119
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
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 SERIES: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1124
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
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 INSTANCE: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1129
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 Unavailable resource type
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 NONE: int = 4,
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 class StorageCommitmentFailureReason(enum.Enum):
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 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	1138 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1139
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: The DICOM instance is properly stored in the SCP
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 SUCCESS: int = 0,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1144
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 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	1147 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1148 PROCESSING_FAILURE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1149
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 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	1152 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1153 NO_SUCH_OBJECT_INSTANCE: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1154
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 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	1157 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1158 RESOURCE_LIMITATION: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1159
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 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	1162 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1163 REFERENCED_SOPCLASS_NOT_SUPPORTED: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1164
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 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	1167 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1168 CLASS_INSTANCE_CONFLICT: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1169
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 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	1172 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1173 DUPLICATE_TRANSACTION_UID: int = 6,
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 class ValueRepresentation(enum.Enum):
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 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	1178 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1179
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 Application Entity
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 AE: int = 1,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1184
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 Age String
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 AS: int = 2,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1189
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 Attribute Tag
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 AT: int = 3,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1194
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 Code String
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 CS: int = 4,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1199
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 Date
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 DA: int = 5,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1204
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 Decimal String
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 DS: int = 6,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1209
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 Date Time
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 DT: int = 7,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1214
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 Floating Point Double
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 FD: int = 8,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1219
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 Floating Point Single
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 FL: int = 9,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1224
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 Integer String
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 IS: int = 10,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1229
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 Long String
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 LO: int = 11,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1234
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 Long Text
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 LT: int = 12,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1239
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 Other Byte String
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 OB: int = 13,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1244
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 Other Float String
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 OF: int = 14,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1249
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 Other Word String
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 OW: int = 15,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1254
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 Person Name
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 PN: int = 16,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1259
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 Short String
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 SH: int = 17,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1264
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 Signed Long
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 SL: int = 18,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1269
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 Sequence of Items
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 SQ: int = 19,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1274
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 Signed Short
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 SS: int = 20,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1279
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 Short Text
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 ST: int = 21,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1284
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 Time
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 TM: int = 22,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1289
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 Unique Identifier (UID)
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 UI: int = 23,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1294
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 Unsigned Long
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 UL: int = 24,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1299
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 Unknown
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 UN: int = 25,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1304
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 Unsigned Short
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 US: int = 26,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1309
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 Unlimited Text
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 UT: int = 27,
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1314
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1315
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1316
188 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 def AutodetectMimeType(path: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1319 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1320 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	1321
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1322 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1323 path (str): Path to the file.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1326 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	1327 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1328 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1329
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1330 # 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	1331 def BufferCompression(source: bytes, compression: CompressionType, uncompress: int) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1332 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1333 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	1334
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1335 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1336 source (bytes): The source buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1337 compression (CompressionType): The compression algorithm.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1338 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	1339
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1340 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1341 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	1342 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1343 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1344
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1345 # 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	1346 def CheckVersion() -> int:
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 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	1349
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1350 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1351 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	1352 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1353 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1354
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1355 # 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	1356 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	1357 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1358 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	1359
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1360 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1361 expected_major (int): Expected major version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1362 expected_minor (int): Expected minor version.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1363 expected_revision (int): Expected revision.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1364
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1365 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1366 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	1367 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1368 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1369
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1370 # 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	1371 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	1372 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1373 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	1374
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1375 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1376 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1377 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1378 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1379 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	1380 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1381 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	1382
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1383 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1384 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	1385 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1386 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1387
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1388 # 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	1389 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	1390 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1391 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	1392
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1393 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1394 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1395 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1396 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1397 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	1398 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1399
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1400 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1401 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	1402 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1403 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1404
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1405 # 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	1406 def ComputeMd5(buffer: bytes) -> str:
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 MD5 cryptographic hash of the given memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1409
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1410 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1411 buffer (bytes): The source 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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1414 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	1415 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1416 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1417
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1418 # 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	1419 def ComputeSha1(buffer: bytes) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1420 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1421 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	1422
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1423 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1424 buffer (bytes): The source memory buffer.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1427 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	1428 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1429 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1430
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1431 # 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	1432 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	1433 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1434 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	1435 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	1436
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1437 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1438 json (str): The input JSON file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1439 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	1440 flags (CreateDicomFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1441
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1442 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1443 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1444 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1445 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1446
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1447 # 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	1448 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	1449 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1450 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	1451 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	1452
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1453 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1454 json (str): The input JSON file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1455 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	1456 flags (CreateDicomFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1457 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	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 bytes: 0 if success, other value if error.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1463
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1464 # 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	1465 def CreateDicomInstance(buffer: bytes) -> DicomInstance:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1466 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1467 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	1468
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1469 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1470 buffer (bytes): The memory buffer containing the DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1471
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1472 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1473 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	1474 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1475 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1476
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1477 # 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	1478 def CreateFindMatcher(query: bytes) -> FindMatcher:
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 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	1481
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1482 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1483 query (bytes): The C-Find DICOM query.
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 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	1487 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1488 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1489
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1490 # 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	1491 def CreateImage(format: PixelFormat, width: int, height: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1492 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1493 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	1494
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1495 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1496 format (PixelFormat): The format of the pixels.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1497 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1498 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1499
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1500 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1501 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	1502 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1503 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1504
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1505 # 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	1506 def DecodeDicomImage(buffer: bytes, frame_index: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1507 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1508 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	1509
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1510 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1511 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	1512 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	1513
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1514 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1515 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	1516 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1517 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1518
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1519 # 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	1520 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	1521 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1522 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	1523
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1524 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1525 buffer (bytes): The memory buffer containing the DICOM file.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1526 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1527 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1528 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	1529
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1530 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1531 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	1532 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1533 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1534
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1535 # 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	1536 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	1537 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1538 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	1539
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1540 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1541 instance_id (str): The Orthanc identifier of the instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1542 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1543 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1544 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	1545
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1546 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1547 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	1548 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1549 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1550
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1551 # 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	1552 def ExtendOrthancExplorer(javascript: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1553 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1554 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	1555
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1556 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1557 javascript (str): The custom JavaScript code.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1558 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1559 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1560
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1561 # 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	1562 def GenerateRestApiAuthorizationToken() -> 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 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	1565 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	1566 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	1567
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1568 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1569 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	1570 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1571 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1572
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1573 # Generate a random GUID/UUID (globally unique identifier)
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1574 def GenerateUuid() -> str:
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 Generate a random GUID/UUID (globally unique identifier).
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 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	1580 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1581 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1582
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1583 # 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	1584 def GetCommandLineArgument(argument: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1585 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1586 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	1587
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1588 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1589 argument (int): The index of the argument.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1592 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	1593 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1594 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1595
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1596 # 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	1597 def GetCommandLineArgumentsCount() -> int:
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 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	1600
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1601 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1602 int: The number of arguments.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1603 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1604 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1605
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1606 # 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	1607 def GetConfiguration() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1608 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1609 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	1610
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1611 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1612 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	1613 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1614 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1615
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1616 # 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	1617 def GetConfigurationPath() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1618 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1619 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	1620
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1621 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1622 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	1623 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1624 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1625
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1626 # Retrieve a DICOM instance using its Orthanc identifier
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1627 def GetDicomForInstance(instance_id: str) -> bytes:
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 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	1630
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1631 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1632 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	1633
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1634 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1635 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	1636 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1637 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1638
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1639 # 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	1640 def GetErrorDescription(error: ErrorCode) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1641 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1642 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	1643
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1644 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1645 error (ErrorCode): The error code of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1646
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1647 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1648 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	1649 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1650 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1651
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1652 # Retrieve the expected version of the database schema
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1653 def GetExpectedDatabaseVersion() -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1654 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1655 Retrieve the expected version of the database schema.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1658 int: The version.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1661
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1662 # 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	1663 def GetFontName(font_index: int) -> str:
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 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	1666
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1667 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1668 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	1669
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1670 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1671 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	1672 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1673 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1674
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1675 # 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	1676 def GetFontSize(font_index: int) -> int:
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 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	1679
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1680 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1681 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	1682
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1683 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1684 int: The font size.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1685 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1686 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1687
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1688 # 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	1689 def GetFontsCount() -> int:
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 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	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 int: The number of fonts.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1697
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1698 # 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	1699 def GetGlobalProperty(property: int, default_value: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1700 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1701 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	1702
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1703 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1704 property (int): The global property of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1705 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	1706
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1707 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1708 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	1709 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1710 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1711
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1712 # 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	1713 def GetOrthancDirectory() -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1714 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1715 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	1716
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1717 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1718 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	1719 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1720 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1721
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1722 # This function returns the path to the Orthanc executable
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1723 def GetOrthancPath() -> str:
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 This function returns the path to the Orthanc executable.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1726
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1727 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1728 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	1729 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1730 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1731
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1732 # 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	1733 def GetPeers() -> Peers:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1734 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1735 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	1736
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1737 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1738 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	1739 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1740 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1741
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1742 # 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	1743 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	1744 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1745 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	1746
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1747 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1748 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1749 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1750 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	1751
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1752 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1753 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	1754 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1755 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1756
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1757 # Make a HTTP DELETE call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1758 def HttpDelete(url: str, username: str, password: str) -> None:
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 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	1761
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1762 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1763 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1764 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	1765 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	1766 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1767 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1768
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1769 # Make a HTTP GET call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1770 def HttpGet(url: str, username: str, password: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1771 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1772 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	1773
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1774 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1775 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1776 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	1777 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	1778
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1779 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1780 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	1781 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1782 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1783
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1784 # Make a HTTP POST call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1785 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	1786 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1787 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	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 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1791 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	1792 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	1793 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	1794
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1795 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1796 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	1797 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1798 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1799
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1800 # Make a HTTP PUT call to the given URL
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1801 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	1802 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1803 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	1804
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1805 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1806 url (str): The URL of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1807 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	1808 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	1809 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	1810
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1811 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1812 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	1813 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1814 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1815
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1816 # Log an error message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1817 def LogError(message: str) -> None:
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 Log an error message using the Orthanc logging system.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1820
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1821 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1822 message (str): The message to be logged.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1823 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1824 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1825
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1826 # Log an information message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1827 def LogInfo(message: str) -> None:
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 Log an information message using the Orthanc logging system.
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 message (str): The message to be logged.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1835
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1836 # Log a warning message using the Orthanc logging system
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1837 def LogWarning(message: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1838 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1839 Log a warning message using the Orthanc logging system.
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 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1842 message (str): The message to be logged.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1843 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1844 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1845
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1846 # 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	1847 def LookupInstance(sop_instance_u_i_d: str) -> str:
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 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	1850
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1851 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1852 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	1853
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1854 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1855 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	1856 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1857 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1858
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1859 # 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	1860 def LookupPatient(patient_i_d: str) -> str:
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 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	1863
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1864 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1865 patient_i_d (str): The Patient ID of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1868 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	1869 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1870 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1871
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1872 # 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	1873 def LookupSeries(series_u_i_d: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1874 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1875 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	1876
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1877 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1878 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	1879
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1880 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1881 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	1882 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1883 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1884
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1885 # 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	1886 def LookupStudy(study_u_i_d: str) -> str:
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 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	1889
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1890 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1891 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	1892
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1893 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1894 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	1895 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1896 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1897
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1898 # 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	1899 def LookupStudyWithAccessionNumber(accession_number: str) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1900 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1901 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	1902
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1903 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1904 accession_number (str): The Accession Number of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1905
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1906 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1907 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	1908 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1909 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1910
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1911 # 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	1912 def ReadFile(path: str) -> bytes:
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 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	1915
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1916 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1917 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	1918
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1919 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1920 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	1921 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1922 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1923
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1924 # 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	1925 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	1926 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1927 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	1928
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1929 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1930 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1931 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1932 vr (ValueRepresentation): The value representation of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1933 name (str): The nickname of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1934 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	1935 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	1936 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1937 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1938
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1939 # 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	1940 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	1941 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1942 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	1943
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1944 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1945 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	1946 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	1947 message (str): The description of the error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1948 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1949 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1950
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1951 # 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	1952 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	1953 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1954 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	1955
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1956 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1957 group (int): The group of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1958 element (int): The element of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1959 vr (ValueRepresentation): The value representation of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1960 name (str): The nickname of the tag.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1961 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	1962 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	1963 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	1964 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1965 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1966
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1967 # 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	1968 def RestApiDelete(uri: str) -> None:
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 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	1971 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	1972
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1973 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1974 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	1975 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1976 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1977
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1978 # 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	1979 def RestApiDeleteAfterPlugins(uri: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1980 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1981 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	1982 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	1983
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1984 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1985 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	1986 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1987 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	1988
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1989 # 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	1990 def RestApiGet(uri: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1991 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1992 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	1993 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	1994
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1995 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1996 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	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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2002
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2003 # 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	2004 def RestApiGetAfterPlugins(uri: str) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2005 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2006 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	2007 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	2008
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2009 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2010 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	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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2016
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2017 # 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	2018 def RestApiPost(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2019 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2020 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	2021 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	2022
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2023 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2024 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	2025 body (bytes): The body of the POST request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2026
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2027 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2028 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	2029 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2030 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2031
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2032 # 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	2033 def RestApiPostAfterPlugins(uri: str, body: bytes) -> bytes:
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 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	2036 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	2037
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2038 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2039 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	2040 body (bytes): The body of the POST request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2041
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2042 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2043 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	2044 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2045 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2046
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2047 # 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	2048 def RestApiPut(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2049 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2050 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	2051 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	2052
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2053 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2054 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	2055 body (bytes): The body of the PUT request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2056
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2057 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2058 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	2059 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2060 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2061
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2062 # 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	2063 def RestApiPutAfterPlugins(uri: str, body: bytes) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2064 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2065 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	2066 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	2067
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2068 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2069 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	2070 body (bytes): The body of the PUT request.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2071
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2072 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2073 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	2074 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2075 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2076
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2077 # Set a description for this plugin
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2078 def SetDescription(description: str) -> None:
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 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	2081
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2082 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2083 description (str): The description.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2084 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2085 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2086
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2087 # 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	2088 def SetGlobalProperty(property: int, value: str) -> None:
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 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	2091
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2092 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2093 property (int): The global property of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2094 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	2095 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2096 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2097
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2098 # 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	2099 def SetMetricsValue(name: str, value: float, type: MetricsType) -> None:
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 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	2102
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2103 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2104 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	2105 value (float): The value of the metrics.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2106 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	2107 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2108 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2109
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2110 # 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	2111 def SetRootUri(uri: str) -> None:
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 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	2114
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2115 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2116 uri (str): The root URI for this plugin.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2117 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2118 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2119
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2120 # 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	2121 def TranscodeDicomInstance(buffer: bytes, transfer_syntax: str) -> DicomInstance:
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 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	2124
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2125 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2126 buffer (bytes): The memory buffer containing the DICOM instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2127 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	2128
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2129 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2130 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	2131 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2132 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2133
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2134 # 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	2135 def UncompressImage(data: bytes, format: ImageFormat) -> Image:
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 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	2138
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2139 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2140 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	2141 format (ImageFormat): The file format of the compressed image.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2144 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	2145 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2146 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2147
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2148 # 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	2149 def WriteFile(path: str, data: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2150 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2151 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	2152
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2153 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2154 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	2155 data (bytes): The content of the memory buffer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2156 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2157 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2158
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2159 class IncomingHttpRequestFilter(typing.Protocol):
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2160 def __call__(self, uri: str, method: HttpMethod, ip: str, headers: dict, get: dict) -> bool:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2161 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2162
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2163 # Callback to filter incoming HTTP requests received by Orthanc
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2164 def RegisterIncomingHttpRequestFilter(callback: IncomingHttpRequestFilter) -> None:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2165 """
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2166 Callback to filter incoming HTTP requests received by Orthanc.
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2167
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2168 Args:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2169 callback (IncomingHttpRequestFilter): The callback function.
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2170 """
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2171 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2172
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2173 class OnChangeCallback(typing.Protocol):
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2174 def __call__(self, change_type: ChangeType, resource_type: ResourceType, resource_id: str) -> None:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2175 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2176
195 d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2177 # Register a callback to monitor changes
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2178 def RegisterOnChangeCallback(callback: OnChangeCallback) -> None:
195 d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2179 """
d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2180 Register a callback to monitor changes.
d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2181
d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2182 Args:
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2183 callback (OnChangeCallback): The callback function.
195 d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2184 """
d7a6e75558ee documented orthanc.RegisterOnChangeCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 194 diff changeset	2185 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2186
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2187 class OnStoredInstanceCallback(typing.Protocol):
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2188 def __call__(self, instance: DicomInstance, instance_id: str) -> None:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2189 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2190
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2191 # Register a callback for received DICOM instances
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2192 def RegisterOnStoredInstanceCallback(callback: OnStoredInstanceCallback) -> None:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2193 """
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2194 Register a callback for received DICOM instances.
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2195
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2196 Args:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2197 callback (OnStoredInstanceCallback): The callback function.
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2198 """
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2199 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2200
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2201 class RestCallback(typing.Protocol):
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2202 def __call__(self, output: RestOutput, url: str, method: HttpMethod, groups: dict, get: dict, headers: dict, body: bytes=None) -> None:
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2203 ...
28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2204
192 b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2205 # Register a REST callback
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2206 def RegisterRestCallback(path_regular_expression: str, callback: RestCallback) -> None:
192 b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2207 """
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2208 Register a REST callback.
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2209
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2210 Args:
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2211 path_regular_expression (str): Regular expression for the URI. May contain groups.
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2212 callback (RestCallback): The callback function to handle the REST call.
192 b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2213 """
b0f096d2339e documentation of orthanc.RegisterRestCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 191 diff changeset	2214 ...
188 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
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2217 class DicomInstance:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2218 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2219 DICOM instance managed by the Orthanc core
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2220 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2221 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2222
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2223
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2224 # 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	2225 def GetInstanceRemoteAet(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2226 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2227 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	2228
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2229 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2230 str: The AET if success, NULL if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2231 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2232 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2233
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2234 # 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	2235 def GetInstanceSize(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2236 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2237 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	2238
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2239 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2240 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	2241 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2242 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2243
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2244 # 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	2245 def GetInstanceJson(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2246 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2247 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	2248
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2249 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2250 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	2251 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2252 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2253
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2254 # 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	2255 def GetInstanceSimplifiedJson(self) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2256 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2257 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	2258
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2259 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2260 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	2261 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2262 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2263
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2264 # 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	2265 def HasInstanceMetadata(self, metadata: str) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2266 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2267 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	2268
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2269 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2270 metadata (str): The metadata of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2273 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	2274 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2275 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2276
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2277 # 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	2278 def GetInstanceMetadata(self, metadata: str) -> str:
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 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	2281
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2282 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2283 metadata (str): The metadata of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2284
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2285 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2286 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	2287 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2288 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2289
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2290 # 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	2291 def GetInstanceOrigin(self) -> InstanceOrigin:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2292 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2293 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	2294
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2295 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2296 InstanceOrigin: The origin of the instance.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2297 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2298 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2299
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2300 # 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	2301 def GetInstanceTransferSyntaxUid(self) -> 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 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	2304
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2305 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2306 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	2307 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2308 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2309
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2310 # 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	2311 def HasInstancePixelData(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2312 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2313 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	2314
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2315 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2316 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	2317 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2318 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2319
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2320 # 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	2321 def GetInstanceFramesCount(self) -> int:
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 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	2324
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2325 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2326 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	2327 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2328 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2329
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2330 # 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	2331 def GetInstanceRawFrame(self, frame_index: int) -> bytes:
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 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	2334
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2335 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2336 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	2337
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2338 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2339 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	2340 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2341 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2342
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2343 # 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	2344 def GetInstanceDecodedFrame(self, frame_index: int) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2345 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2346 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	2347
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2348 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2349 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	2350
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2351 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2352 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	2353 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2354 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2355
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2356 # 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	2357 def SerializeDicomInstance(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2358 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2359 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	2360
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2361 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2362 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	2363 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2364 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2365
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2366 # 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	2367 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	2368 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2369 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	2370
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2371 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2372 format (DicomToJsonFormat): The output format.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2373 flags (DicomToJsonFlags): Flags governing the output.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2374 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	2375
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2376 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2377 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	2378 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2379 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2380
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2381
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2382 # Get the content of the DICOM instance
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2383 def GetInstanceData(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2384 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2385 Get the content of the DICOM instance.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2388 bytes: The DICOM data.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2389 """
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 class DicomWebNode:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2392 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2393 Node visited by DICOMweb conversion
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2394 """
188 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
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2397
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2398 class FindAnswers:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2399 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2400 Answers to a DICOM C-FIND query
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2401 """
188 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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2404
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2405 # 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	2406 def FindAddAnswer(self, dicom: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2407 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2408 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	2409
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2410 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2411 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	2412 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2413 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2414
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2415 # 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	2416 def FindMarkIncomplete(self) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2417 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2418 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	2419 """
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
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2422 class FindMatcher:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2423 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2424 Matcher for DICOM C-FIND query
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2425 """
188 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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2428
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2429 # 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	2430 def FindMatcherIsMatch(self, dicom: bytes) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2431 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2432 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	2433
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2434 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2435 dicom (bytes): The DICOM instance to be matched.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2436
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2437 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2438 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	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
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2442 class FindQuery:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2443 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2444 DICOM C-FIND query
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2445 """
188 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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2448
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2449 # 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	2450 def GetFindQuerySize(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2451 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2452 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	2453
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2454 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2455 int: The number of tags.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2458
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2459 # 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	2460 def GetFindQueryTagName(self, index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2461 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2462 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	2463
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2464 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2465 index (int): The index of the tag of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2468 str: 0 if success, other value if error.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2471
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2472 # 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	2473 def GetFindQueryValue(self, index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2474 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2475 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	2476
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2477 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2478 index (int): The index of the tag of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2481 str: 0 if success, other value if error.
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 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2484
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2485
193 66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2486 # This function returns the element of one DICOM tag in the given C-Find query
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2487 def GetFindQueryTagElement(self, index: int) -> int:
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2488 """
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2489 This function returns the element of one DICOM tag in the given C-Find query.
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2490
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2491 Args:
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2492 index (int): The index of the tag of interest.
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2493
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2494 Returns:
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2495 int: The value of the element.
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2496 """
66cd20e970d8 simplification for custom methods Sebastien Jodogne <s.jodogne@gmail.com> parents: 192 diff changeset	2497 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2498
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2499 # 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	2500 def GetFindQueryTagGroup(self, index: int) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2501 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2502 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	2503
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2504 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2505 index (int): The index of the tag of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2508 int: The value of the group.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2509 """
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 class Image:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2512 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2513 2D image managed by the Orthanc core
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2514 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2515 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2516
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2517
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2518 # 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	2519 def GetImagePixelFormat(self) -> PixelFormat:
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 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	2522
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2523 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2524 PixelFormat: The pixel format.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2527
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2528 # This function returns the width of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2529 def GetImageWidth(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2530 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2531 This function returns the width of the given image.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2534 int: The width.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2535 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2536 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2537
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2538 # This function returns the height of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2539 def GetImageHeight(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2540 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2541 This function returns the height of the given image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2542
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2543 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2544 int: The height.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2545 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2546 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2547
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2548 # This function returns the pitch of the given image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2549 def GetImagePitch(self) -> int:
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 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	2552
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2553 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2554 int: The pitch.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2557
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2558 # 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	2559 def ConvertPixelFormat(self, target_format: PixelFormat) -> Image:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2560 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2561 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	2562
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2563 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2564 target_format (PixelFormat): The target pixel format.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2567 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	2568 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2569 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2570
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2571 # This function draws some text on some image
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2572 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	2573 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2574 This function draws some text on some image.
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 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2577 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	2578 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	2579 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	2580 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	2581 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	2582 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	2583 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	2584 """
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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2587
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2588 # 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	2589 def GetImageBuffer(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2590 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2591 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	2592
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2593 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2594 bytes: The pixel data.
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 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2597 class Job:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2598 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2599 Orthanc job
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2600 """
188 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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2603
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2604 # 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	2605 def SubmitJob(self, priority: int) -> str:
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 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	2608
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2609 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2610 priority (int): The priority of the job.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2613 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	2614 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2615 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2616
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2617 class Peers:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2618 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2619 Orthanc peer
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2620 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2621 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2622
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2623
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2624 # This function returns the number of Orthanc peers
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2625 def GetPeersCount(self) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2626 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2627 This function returns the number of Orthanc peers.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2628 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	2629
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2630 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2631 int: The number of peers.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2632 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2633 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2634
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2635 # 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	2636 def GetPeerName(self, peer_index: int) -> str:
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 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	2639 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	2640
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2641 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2642 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	2643
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2644 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2645 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	2646 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2647 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2648
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2649 # 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	2650 def GetPeerUrl(self, peer_index: int) -> str:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2651 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2652 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	2653 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	2654
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2655 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2656 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	2657
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2658 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2659 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	2660 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2661 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2662
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2663 # 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	2664 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	2665 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2666 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	2667 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	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 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	2671 user_property (str): The user property of interest.
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 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2674 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	2675 """
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
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2678 class RestOutput:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2679 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2680 Output for a call to the REST API of Orthanc
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2681 """
188 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
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2684
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2685 # 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	2686 def AnswerBuffer(self, answer: bytes, mime_type: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2687 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2688 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	2689
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2690 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2691 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	2692 mime_type (str): The MIME type of the answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2693 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2694 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2695
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2696 # 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	2697 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	2698 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2699 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	2700
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2701 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2702 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2703 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2704 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2705 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	2706 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2707 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2708 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2709
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2710 # 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	2711 def Redirect(self, redirection: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2712 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2713 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	2714
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2715 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2716 redirection (str): Where to redirect.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2719
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2720 # 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	2721 def SendHttpStatusCode(self, status: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2722 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2723 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	2724
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2725 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2726 status (int): The HTTP status code to be sent.
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 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2729
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2730 # 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	2731 def SendUnauthorized(self, realm: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2732 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2733 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	2734
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2735 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2736 realm (str): The realm for the authorization process.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2737 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2738 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2739
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2740 # 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	2741 def SendMethodNotAllowed(self, allowed_methods: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2742 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2743 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	2744
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2745 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2746 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	2747 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2748 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2749
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2750 # This function sets a cookie in the HTTP client
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2751 def SetCookie(self, cookie: str, value: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2752 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2753 This function sets a cookie in the HTTP client.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2754
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2755 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2756 cookie (str): The cookie to be set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2757 value (str): The value of the cookie.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2758 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2759 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2760
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2761 # 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	2762 def SetHttpHeader(self, key: str, value: str) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2763 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2764 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	2765
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2766 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2767 key (str): The HTTP header to be set.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2768 value (str): The value of the HTTP header.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2769 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2770 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2771
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2772 # 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	2773 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	2774 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2775 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	2776
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2777 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2778 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	2779 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	2780 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2781 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2782
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2783 # 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	2784 def SendMultipartItem(self, answer: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2785 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2786 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	2787
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2788 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2789 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	2790 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2791 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2792
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2793 # 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	2794 def SendHttpStatus(self, status: int, body: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2795 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2796 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	2797 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	2798
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2799 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2800 status (int): The HTTP status code to be sent.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2801 body (bytes): The body of the answer.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2802 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2803 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2804
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2805 # 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	2806 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	2807 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2808 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	2809
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2810 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2811 format (PixelFormat): The memory layout of the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2812 width (int): The width of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2813 height (int): The height of the image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2814 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	2815 buffer (bytes): The memory buffer containing the uncompressed image.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2816 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	2817 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2818 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2819
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2820 # 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	2821 def SetHttpErrorDetails(self, details: str, log: int) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2822 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2823 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	2824
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2825 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2826 details (str): The details of the error message.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2827 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	2828 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2829 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2830
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2831 class ServerChunkedRequestReader:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2832 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2833 Read for a chunked HTTP request
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2834 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2835 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2836
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2837
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2838 class StorageArea:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2839 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2840 Storage area plugin
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2841 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2842 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2843
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2844
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2845 # 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	2846 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	2847 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2848 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	2849
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2850 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2851 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	2852 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	2853 size (int): The size of the content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2854 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2855 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2856 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2857
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2858 # 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	2859 def StorageAreaRead(self, uuid: str, type: ContentType) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2860 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2861 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	2862
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2863 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2864 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	2865 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2866
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2867 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2868 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2869 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2870 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2871
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2872 # 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	2873 def StorageAreaRemove(self, uuid: str, type: ContentType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2874 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2875 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	2876
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2877 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2878 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	2879 type (ContentType): The type of the file content.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2880 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2881 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2882
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2883 # 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	2884 def ReconstructMainDicomTags(self, level: ResourceType) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2885 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2886 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	2887
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2888 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2889 level (ResourceType): The type of the resources of interest.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2890 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2891 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2892
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2893 class WorklistAnswers:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2894 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2895 Answers to a DICOM C-FIND worklist query
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2896 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2897 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2898
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2899
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2900 # 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	2901 def WorklistAddAnswer(self, query: WorklistQuery, dicom: bytes) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2902 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2903 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	2904
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2905 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2906 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	2907 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	2908 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2909 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2910
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2911 # 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	2912 def WorklistMarkIncomplete(self) -> None:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2913 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2914 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	2915 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2916 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2917
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2918 class WorklistQuery:
194 0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2919 """
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2920 DICOM C-FIND worklist query
0c5da632f34d added description of classes Sebastien Jodogne <s.jodogne@gmail.com> parents: 193 diff changeset	2921 """
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2922 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2923
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2924
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2925 # 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	2926 def WorklistIsMatch(self, dicom: bytes) -> int:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2927 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2928 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	2929
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2930 Args:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2931 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	2932
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2933 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2934 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	2935 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2936 ...
203 28531e615104 documented orthanc.RegisterIncomingHttpRequestFilter() and orthanc.RegisterOnStoredInstanceCallback() Sebastien Jodogne <s.jodogne@gmail.com> parents: 195 diff changeset	2937
188 87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2938 # 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	2939 def WorklistGetDicomQuery(self) -> bytes:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2940 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2941 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	2942
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2943 Returns:
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2944 bytes: 0 if success, other value if error.
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2945 """
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2946 ...
87e546600cbe added Sources/Autogenerated/orthanc.pyi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2947

Mercurial > hg > orthanc-python

annotate Sources/Autogenerated/orthanc.pyi @ 203:28531e615104