|
0
|
1 /**
|
|
|
2 * Orthanc - A Lightweight, RESTful DICOM Store
|
|
12
|
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
|
|
0
|
4 * Department, University Hospital of Liege, Belgium
|
|
|
5 *
|
|
|
6 * This program is free software: you can redistribute it and/or
|
|
|
7 * modify it under the terms of the GNU General Public License as
|
|
|
8 * published by the Free Software Foundation, either version 3 of the
|
|
|
9 * License, or (at your option) any later version.
|
|
|
10 *
|
|
|
11 * In addition, as a special exception, the copyright holders of this
|
|
|
12 * program give permission to link the code of its release with the
|
|
|
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
|
|
|
14 * that use the same license as the "OpenSSL" library), and distribute
|
|
|
15 * the linked executables. You must obey the GNU General Public License
|
|
|
16 * in all respects for all of the code used other than "OpenSSL". If you
|
|
|
17 * modify file(s) with this exception, you may extend this exception to
|
|
|
18 * your version of the file(s), but you are not obligated to do so. If
|
|
|
19 * you do not wish to do so, delete this exception statement from your
|
|
|
20 * version. If you delete this exception statement from all source files
|
|
|
21 * in the program, then also delete it here.
|
|
|
22 *
|
|
|
23 * This program is distributed in the hope that it will be useful, but
|
|
|
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
26 * General Public License for more details.
|
|
|
27 *
|
|
|
28 * You should have received a copy of the GNU General Public License
|
|
|
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
30 **/
|
|
|
31
|
|
|
32
|
|
|
33 #pragma once
|
|
|
34
|
|
|
35 #include <string>
|
|
|
36 #include <json/value.h>
|
|
|
37
|
|
7
|
38 #include "PublicEnumerations.h"
|
|
0
|
39 #include "OrthancClientException.h"
|
|
3
|
40 #include "../Orthanc/Core/IDynamicObject.h"
|
|
14
|
41 #include "../Orthanc/Core/Images/PngReader.h"
|
|
0
|
42
|
|
|
43 namespace OrthancClient
|
|
|
44 {
|
|
|
45 class OrthancConnection;
|
|
|
46
|
|
|
47 /**
|
|
|
48 * {summary}{Connection to an instance stored in %Orthanc.}
|
|
|
49 * {description}{This class encapsulates a connection to an image instance
|
|
|
50 * from a remote instance of %Orthanc.}
|
|
|
51 **/
|
|
|
52 class LAAW_API Instance : public Orthanc::IDynamicObject
|
|
|
53 {
|
|
|
54 private:
|
|
|
55 const OrthancConnection& connection_;
|
|
|
56 std::string id_;
|
|
|
57 Json::Value tags_;
|
|
|
58 std::auto_ptr<Orthanc::PngReader> reader_;
|
|
7
|
59 ImageExtractionMode mode_;
|
|
0
|
60 std::auto_ptr<std::string> dicom_;
|
|
|
61 std::string content_;
|
|
|
62
|
|
|
63 void DownloadImage();
|
|
|
64
|
|
|
65 void DownloadDicom();
|
|
|
66
|
|
|
67 public:
|
|
|
68 /**
|
|
|
69 * {summary}{Create a connection to some image instance.}
|
|
|
70 * {param}{connection The remote instance of %Orthanc.}
|
|
|
71 * {param}{id The %Orthanc identifier of the image instance.}
|
|
|
72 **/
|
|
|
73 Instance(const OrthancConnection& connection,
|
|
|
74 const char* id);
|
|
|
75
|
|
|
76
|
|
|
77 /**
|
|
|
78 * {summary}{Get the %Orthanc identifier of this identifier.}
|
|
|
79 * {returns}{The identifier.}
|
|
|
80 **/
|
|
|
81 const char* GetId() const
|
|
|
82 {
|
|
|
83 return id_.c_str();
|
|
|
84 }
|
|
|
85
|
|
|
86
|
|
|
87 /**
|
|
|
88 * {summary}{Set the extraction mode for the 2D image corresponding to this instance.}
|
|
|
89 * {param}{mode The extraction mode.}
|
|
|
90 **/
|
|
7
|
91 void SetImageExtractionMode(ImageExtractionMode mode);
|
|
0
|
92
|
|
|
93 /**
|
|
|
94 * {summary}{Get the extraction mode for the 2D image corresponding to this instance.}
|
|
|
95 * {returns}{The extraction mode.}
|
|
|
96 **/
|
|
7
|
97 ImageExtractionMode GetImageExtractionMode() const
|
|
0
|
98 {
|
|
|
99 return mode_;
|
|
|
100 }
|
|
|
101
|
|
|
102
|
|
|
103 /**
|
|
|
104 * {summary}{Get the string value of some DICOM tag of this instance.}
|
|
|
105 * {param}{tag The name of the tag of interest.}
|
|
|
106 * {returns}{The value of the tag.}
|
|
|
107 **/
|
|
|
108 const char* GetTagAsString(const char* tag) const;
|
|
|
109
|
|
|
110 /**
|
|
|
111 * {summary}{Get the floating point value that is stored in some DICOM tag of this instance.}
|
|
|
112 * {param}{tag The name of the tag of interest.}
|
|
|
113 * {returns}{The value of the tag.}
|
|
|
114 **/
|
|
|
115 float GetTagAsFloat(const char* tag) const;
|
|
|
116
|
|
|
117 /**
|
|
|
118 * {summary}{Get the integer value that is stored in some DICOM tag of this instance.}
|
|
|
119 * {param}{tag The name of the tag of interest.}
|
|
|
120 * {returns}{The value of the tag.}
|
|
|
121 **/
|
|
|
122 int32_t GetTagAsInt(const char* tag) const;
|
|
|
123
|
|
|
124
|
|
|
125 /**
|
|
|
126 * {summary}{Get the width of the 2D image.}
|
|
|
127 * {description}{Get the width of the 2D image that is encoded by this DICOM instance.}
|
|
|
128 * {returns}{The width.}
|
|
|
129 **/
|
|
|
130 uint32_t GetWidth();
|
|
|
131
|
|
|
132 /**
|
|
|
133 * {summary}{Get the height of the 2D image.}
|
|
|
134 * {description}{Get the height of the 2D image that is encoded by this DICOM instance.}
|
|
|
135 * {returns}{The height.}
|
|
|
136 **/
|
|
|
137 uint32_t GetHeight();
|
|
|
138
|
|
|
139 /**
|
|
|
140 * {summary}{Get the number of bytes between two lines of the image (pitch).}
|
|
|
141 * {description}{Get the number of bytes between two lines of the image in the memory buffer returned by GetBuffer(). This value depends on the extraction mode for the image.}
|
|
|
142 * {returns}{The pitch.}
|
|
|
143 **/
|
|
|
144 uint32_t GetPitch();
|
|
|
145
|
|
|
146 /**
|
|
|
147 * {summary}{Get the format of the pixels of the 2D image.}
|
|
|
148 * {description}{Return the memory layout that is used for the 2D image that is encoded by this DICOM instance. This value depends on the extraction mode for the image.}
|
|
|
149 * {returns}{The pixel format.}
|
|
|
150 **/
|
|
7
|
151 PixelFormat GetPixelFormat();
|
|
0
|
152
|
|
|
153 /**
|
|
|
154 * {summary}{Access the memory buffer in which the raw pixels of the 2D image are stored.}
|
|
|
155 * {returns}{A pointer to the memory buffer.}
|
|
|
156 **/
|
|
|
157 const void* GetBuffer();
|
|
|
158
|
|
|
159 /**
|
|
|
160 * {summary}{Access the memory buffer in which the raw pixels of some line of the 2D image are stored.}
|
|
|
161 * {param}{y The line of interest.}
|
|
|
162 * {returns}{A pointer to the memory buffer.}
|
|
|
163 **/
|
|
|
164 const void* GetBuffer(uint32_t y);
|
|
|
165
|
|
|
166 /**
|
|
|
167 * {summary}{Get the size of the DICOM file corresponding to this instance.}
|
|
|
168 * {returns}{The file size.}
|
|
|
169 **/
|
|
|
170 const uint64_t GetDicomSize();
|
|
|
171
|
|
|
172 /**
|
|
|
173 * {summary}{Get a pointer to the content of the DICOM file corresponding to this instance.}
|
|
|
174 * {returns}{The DICOM file.}
|
|
|
175 **/
|
|
|
176 const void* GetDicom();
|
|
|
177
|
|
|
178 /**
|
|
|
179 * {summary}{Discard the downloaded 2D image, so as to make room in memory.}
|
|
|
180 **/
|
|
|
181 void DiscardImage();
|
|
|
182
|
|
|
183 /**
|
|
|
184 * {summary}{Discard the downloaded DICOM file, so as to make room in memory.}
|
|
|
185 **/
|
|
|
186 void DiscardDicom();
|
|
|
187
|
|
|
188 LAAW_API_INTERNAL void SplitVectorOfFloats(std::vector<float>& target,
|
|
|
189 const char* tag);
|
|
|
190
|
|
|
191 /**
|
|
|
192 * {summary}{Load a raw tag from the DICOM file.}
|
|
|
193 * {param}{path The path to the tag of interest (e.g. "0020-000d").}
|
|
|
194 **/
|
|
|
195 void LoadTagContent(const char* path);
|
|
|
196
|
|
|
197 /**
|
|
|
198 * {summary}{Return the value of the raw tag that was loaded by LoadContent.}
|
|
|
199 * {returns}{The tag value.}
|
|
|
200 **/
|
|
|
201 const char* GetLoadedTagContent() const;
|
|
|
202 };
|
|
|
203 }
|
