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