Mercurial > hg > orthanc-java
annotate JavaSDK/be/uclouvain/orthanc/DicomInstance.java @ 18:15dc698243ac
update year to 2024
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 05 Jan 2024 16:32:33 +0100 |
| parents | 26c08ff926a3 |
| children |
| rev | line source |
|---|---|
| 0 | 1 package be.uclouvain.orthanc; |
| 2 | |
| 3 /** | |
| 18 | 4 * SPDX-FileCopyrightText: 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 0 | 5 * SPDX-License-Identifier: GPL-3.0-or-later |
| 6 */ | |
| 7 | |
| 8 /** | |
| 9 * Java plugin for Orthanc | |
| 18 | 10 * Copyright (C) 2023-2024 Sebastien Jodogne, UCLouvain, Belgium |
| 0 | 11 * |
| 12 * This program is free software: you can redistribute it and/or | |
| 13 * modify it under the terms of the GNU General Public License as | |
| 14 * published by the Free Software Foundation, either version 3 of the | |
| 15 * License, or (at your option) any later version. | |
| 16 * | |
| 17 * This program is distributed in the hope that it will be useful, but | |
| 18 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 20 * General Public License for more details. | |
| 21 * | |
| 22 * You should have received a copy of the GNU General Public License | |
| 23 * along with this program. If not, see http://www.gnu.org/licenses/. | |
| 24 **/ | |
| 25 | |
| 26 | |
|
8
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
27 // WARNING: Auto-generated file. Do not modify it by hand. |
|
26c08ff926a3
added warning about auto-generated files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
28 |
| 0 | 29 /** |
| 30 * DICOM instance managed by the Orthanc core | |
| 31 **/ | |
| 32 public class DicomInstance { | |
| 33 private long self; | |
| 34 | |
| 35 /** | |
| 36 * Construct a Java object wrapping a C object that is managed by Orthanc. | |
| 37 * @param self Pointer to the C object. | |
| 38 **/ | |
| 39 protected DicomInstance(long self) { | |
| 40 if (self == 0) { | |
| 41 throw new IllegalArgumentException("Null pointer"); | |
| 42 } else { | |
| 43 this.self = self; | |
| 44 } | |
| 45 } | |
| 46 | |
| 47 /** | |
| 48 * Return the C object that is associated with this Java wrapper. | |
| 49 * @return Pointer to the C object. | |
| 50 **/ | |
| 51 protected long getSelf() { | |
| 52 return self; | |
| 53 } | |
| 54 | |
| 55 @Override | |
| 56 protected void finalize() throws Throwable { | |
| 57 dispose(); | |
| 58 super.finalize(); | |
| 59 } | |
| 60 | |
| 61 /** | |
| 62 * Manually deallocate the C object that is associated with this Java wrapper. | |
| 63 * | |
| 64 * This method can be used to immediately deallocate the C object, | |
| 65 * instead of waiting for the garbage collector to dispose the Java wrapper. | |
| 66 **/ | |
| 67 public void dispose() { | |
| 68 if (self != 0) { | |
| 69 NativeSDK.OrthancPluginFreeDicomInstance(self); | |
| 70 self = 0; | |
| 71 } | |
| 72 } | |
| 73 | |
| 74 /** | |
| 75 * Parse a DICOM instance. | |
| 76 * | |
| 77 * This function parses a memory buffer that contains a DICOM file. The function | |
| 78 * returns a new pointer to a data structure that is managed by the Orthanc core. | |
| 79 * | |
| 80 * @param buffer The memory buffer containing the DICOM instance. | |
| 81 * @return The newly constructed object. | |
| 82 **/ | |
| 83 public static DicomInstance createDicomInstance( | |
| 84 byte[] buffer) { | |
| 85 return new DicomInstance(NativeSDK.OrthancPluginCreateDicomInstance(buffer)); | |
| 86 } | |
| 87 | |
| 88 /** | |
| 89 * Parse and transcode a DICOM instance. | |
| 90 * | |
| 91 * This function parses a memory buffer that contains a DICOM file, then transcodes | |
| 92 * it to the given transfer syntax. The function returns a new pointer to a data | |
| 93 * structure that is managed by the Orthanc core. | |
| 94 * | |
| 95 * @param buffer The memory buffer containing the DICOM instance. | |
| 96 * @param transferSyntax The transfer syntax UID for the transcoding. | |
| 97 * @return The newly constructed object. | |
| 98 **/ | |
| 99 public static DicomInstance transcodeDicomInstance( | |
| 100 byte[] buffer, | |
| 101 String transferSyntax) { | |
| 102 return new DicomInstance(NativeSDK.OrthancPluginTranscodeDicomInstance(buffer, transferSyntax)); | |
| 103 } | |
| 104 | |
| 105 | |
| 106 /** | |
| 107 * Get the AET of a DICOM instance. | |
| 108 * | |
| 109 * This function returns the Application Entity Title (AET) of the DICOM modality | |
| 110 * from which a DICOM instance originates. | |
| 111 * | |
| 112 * @return The resulting string. | |
| 113 **/ | |
| 114 public String getInstanceRemoteAet() { | |
| 115 return NativeSDK.OrthancPluginGetInstanceRemoteAet(self); | |
| 116 } | |
| 117 | |
| 118 /** | |
| 119 * Get the size of a DICOM file. | |
| 120 * | |
| 121 * This function returns the number of bytes of the given DICOM instance. | |
| 122 * | |
| 123 * @return The size of the file, -1 in case of error. | |
| 124 **/ | |
| 125 public long getInstanceSize() { | |
| 126 return NativeSDK.OrthancPluginGetInstanceSize(self); | |
| 127 } | |
| 128 | |
| 129 /** | |
| 130 * Get the DICOM tag hierarchy as a JSON file. | |
| 131 * | |
| 132 * This function returns a pointer to a newly created string containing a JSON | |
| 133 * file. This JSON file encodes the tag hierarchy of the given DICOM instance. | |
| 134 * | |
| 135 * @return The resulting string. | |
| 136 **/ | |
| 137 public String getInstanceJson() { | |
| 138 return NativeSDK.OrthancPluginGetInstanceJson(self); | |
| 139 } | |
| 140 | |
| 141 /** | |
| 142 * Get the DICOM tag hierarchy as a JSON file (with simplification). | |
| 143 * | |
| 144 * This function returns a pointer to a newly created string containing a JSON | |
| 145 * file. This JSON file encodes the tag hierarchy of the given DICOM instance. In | |
| 146 * contrast with ::OrthancPluginGetInstanceJson(), the returned JSON file is in its | |
| 147 * simplified version. | |
| 148 * | |
| 149 * @return The resulting string. | |
| 150 **/ | |
| 151 public String getInstanceSimplifiedJson() { | |
| 152 return NativeSDK.OrthancPluginGetInstanceSimplifiedJson(self); | |
| 153 } | |
| 154 | |
| 155 /** | |
| 156 * Check whether a DICOM instance is associated with some metadata. | |
| 157 * | |
| 158 * This function checks whether the DICOM instance of interest is associated with | |
| 159 * some metadata. As of Orthanc 0.8.1, in the callbacks registered by | |
| 160 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only possibly available | |
| 161 * metadata are "ReceptionDate", "RemoteAET" and "IndexInSeries". | |
| 162 * | |
| 163 * @param metadata The metadata of interest. | |
| 164 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error. | |
| 165 **/ | |
| 166 public int hasInstanceMetadata( | |
| 167 String metadata) { | |
| 168 return NativeSDK.OrthancPluginHasInstanceMetadata(self, metadata); | |
| 169 } | |
| 170 | |
| 171 /** | |
| 172 * Get the value of some metadata associated with a given DICOM instance. | |
| 173 * | |
| 174 * This functions returns the value of some metadata that is associated with the | |
| 175 * DICOM instance of interest. Before calling this function, the existence of the | |
| 176 * metadata must have been checked with ::OrthancPluginHasInstanceMetadata(). | |
| 177 * | |
| 178 * @param metadata The metadata of interest. | |
| 179 * @return The resulting string. | |
| 180 **/ | |
| 181 public String getInstanceMetadata( | |
| 182 String metadata) { | |
| 183 return NativeSDK.OrthancPluginGetInstanceMetadata(self, metadata); | |
| 184 } | |
| 185 | |
| 186 /** | |
| 187 * Get the origin of a DICOM file. | |
| 188 * | |
| 189 * This function returns the origin of a DICOM instance that has been received by | |
| 190 * Orthanc. | |
| 191 * | |
| 192 * @return The origin of the instance. | |
| 193 **/ | |
| 194 public InstanceOrigin getInstanceOrigin() { | |
| 195 return InstanceOrigin.getInstance(NativeSDK.OrthancPluginGetInstanceOrigin(self)); | |
| 196 } | |
| 197 | |
| 198 /** | |
| 199 * Get the transfer syntax of a DICOM file. | |
| 200 * | |
| 201 * This function returns a pointer to a newly created string that contains the | |
| 202 * transfer syntax UID of the DICOM instance. The empty string might be returned if | |
| 203 * this information is unknown. | |
| 204 * | |
| 205 * @return The resulting string. | |
| 206 **/ | |
| 207 public String getInstanceTransferSyntaxUid() { | |
| 208 return NativeSDK.OrthancPluginGetInstanceTransferSyntaxUid(self); | |
| 209 } | |
| 210 | |
| 211 /** | |
| 212 * Check whether the DICOM file has pixel data. | |
| 213 * | |
| 214 * This function returns a Boolean value indicating whether the DICOM instance | |
| 215 * contains the pixel data (7FE0,0010) tag. | |
| 216 * | |
| 217 * @return "1" if the DICOM instance contains pixel data, or "0" if the tag is | |
| 218 * missing, or "-1" in the case of an error. | |
| 219 **/ | |
| 220 public int hasInstancePixelData() { | |
| 221 return NativeSDK.OrthancPluginHasInstancePixelData(self); | |
| 222 } | |
| 223 | |
| 224 /** | |
| 225 * Get the number of frames in a DICOM instance. | |
| 226 * | |
| 227 * This function returns the number of frames that are part of a DICOM image | |
| 228 * managed by the Orthanc core. | |
| 229 * | |
| 230 * @return The number of frames (will be zero in the case of an error). | |
| 231 **/ | |
| 232 public int getInstanceFramesCount() { | |
| 233 return NativeSDK.OrthancPluginGetInstanceFramesCount(self); | |
| 234 } | |
| 235 | |
| 236 /** | |
| 237 * Get the raw content of a frame in a DICOM instance. | |
| 238 * | |
| 239 * This function returns a memory buffer containing the raw content of a frame in a | |
| 240 * DICOM instance that is managed by the Orthanc core. This is notably useful for | |
| 241 * compressed transfer syntaxes, as it gives access to the embedded files (such as | |
| 242 * JPEG, JPEG-LS or JPEG2k). The Orthanc core transparently reassembles the | |
| 243 * fragments to extract the raw frame. | |
| 244 * | |
| 245 * @param frameIndex The index of the frame of interest. | |
| 246 * @return The resulting memory buffer. | |
| 247 **/ | |
| 248 public byte[] getInstanceRawFrame( | |
| 249 int frameIndex) { | |
| 250 return NativeSDK.OrthancPluginGetInstanceRawFrame(self, frameIndex); | |
| 251 } | |
| 252 | |
| 253 /** | |
| 254 * Decode one frame from a DICOM instance. | |
| 255 * | |
| 256 * This function decodes one frame of a DICOM image that is managed by the Orthanc | |
| 257 * core. | |
| 258 * | |
| 259 * @param frameIndex The index of the frame of interest. | |
| 260 * @return The newly constructed object. | |
| 261 **/ | |
| 262 public Image getInstanceDecodedFrame( | |
| 263 int frameIndex) { | |
| 264 return new Image(NativeSDK.OrthancPluginGetInstanceDecodedFrame(self, frameIndex)); | |
| 265 } | |
| 266 | |
| 267 /** | |
| 268 * Writes a DICOM instance to a memory buffer. | |
| 269 * | |
| 270 * This function returns a memory buffer containing the serialization of a DICOM | |
| 271 * instance that is managed by the Orthanc core. | |
| 272 * | |
| 273 * @return The resulting memory buffer. | |
| 274 **/ | |
| 275 public byte[] serializeDicomInstance() { | |
| 276 return NativeSDK.OrthancPluginSerializeDicomInstance(self); | |
| 277 } | |
| 278 | |
| 279 /** | |
| 280 * Format a DICOM memory buffer as a JSON string. | |
| 281 * | |
| 282 * This function takes as DICOM instance managed by the Orthanc core, and outputs a | |
| 283 * JSON string representing the tags of this DICOM file. | |
| 284 * | |
| 285 * @param format The output format. | |
| 286 * @param flags Flags governing the output. | |
| 287 * @param maxStringLength The maximum length of a field. Too long fields will be | |
| 288 * output as "null". The 0 value means no maximum length. | |
| 289 * @return The resulting string. | |
| 290 **/ | |
| 291 public String getInstanceAdvancedJson( | |
| 292 DicomToJsonFormat format, | |
| 293 DicomToJsonFlags flags, | |
| 294 int maxStringLength) { | |
| 295 return NativeSDK.OrthancPluginGetInstanceAdvancedJson(self, format.getValue(), flags.getValue(), maxStringLength); | |
| 296 } | |
| 297 | |
| 298 } |