Mercurial > hg > orthanc
annotate OrthancServer/FromDcmtkBridge.h @ 2137:595cf22b3e7e
safety checks of macros
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 09 Nov 2016 15:07:50 +0100 |
| parents | bb199bccdc45 |
| children | 8cbb55089a1d |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 62 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
| 1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1004
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 0 | 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. | |
| 136 | 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. | |
| 0 | 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 | |
| 789 | 35 #include "ServerEnumerations.h" |
|
285
4031f73fe0e4
access to the raw dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
176
diff
changeset
|
36 |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
37 #include "../Core/DicomFormat/DicomElement.h" |
| 791 | 38 #include "../Core/DicomFormat/DicomMap.h" |
| 39 | |
| 0 | 40 #include <dcmtk/dcmdata/dcdatset.h> |
|
1831
3ae2ff249675
"/instances/.../header" to get the meta information (header) of the DICOM instance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
41 #include <dcmtk/dcmdata/dcmetinf.h> |
|
1924
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
42 #include <dcmtk/dcmdata/dcpixseq.h> |
|
1935
e251606c1433
FromDcmtkBridge::LoadFromMemoryBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1934
diff
changeset
|
43 #include <dcmtk/dcmdata/dcfilefo.h> |
| 0 | 44 #include <json/json.h> |
| 45 | |
| 2126 | 46 #if ORTHANC_BUILD_UNIT_TESTS == 1 |
| 47 # include <gtest/gtest_prod.h> | |
| 48 #endif | |
| 49 | |
| 50 | |
| 62 | 51 namespace Orthanc |
| 0 | 52 { |
| 2125 | 53 class FromDcmtkBridge : public boost::noncopyable |
| 0 | 54 { |
| 2126 | 55 #if ORTHANC_BUILD_UNIT_TESTS == 1 |
| 56 FRIEND_TEST(FromDcmtkBridge, FromJson); | |
| 57 #endif | |
| 58 | |
|
2128
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
59 friend class ParsedDicomFile; |
| 2131 | 60 friend class Configuration; |
|
2128
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
61 |
| 2125 | 62 private: |
| 63 FromDcmtkBridge(); // Pure static class | |
| 64 | |
| 65 static void ExtractDicomSummary(DicomMap& target, | |
| 66 DcmItem& dataset, | |
| 67 unsigned int maxStringLength, | |
| 68 Encoding defaultEncoding); | |
| 69 | |
| 2126 | 70 static void DatasetToJson(Json::Value& parent, |
| 71 DcmItem& item, | |
| 72 DicomToJsonFormat format, | |
| 73 DicomToJsonFlags flags, | |
| 74 unsigned int maxStringLength, | |
| 75 Encoding encoding); | |
| 76 | |
| 77 static void ElementToJson(Json::Value& parent, | |
| 78 DcmElement& element, | |
| 79 DicomToJsonFormat format, | |
| 80 DicomToJsonFlags flags, | |
| 81 unsigned int maxStringLength, | |
| 82 Encoding dicomEncoding); | |
| 83 | |
|
2128
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
84 static void ExtractDicomAsJson(Json::Value& target, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
85 DcmDataset& dataset, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
86 DicomToJsonFormat format, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
87 DicomToJsonFlags flags, |
| 2131 | 88 unsigned int maxStringLength, |
| 89 Encoding defaultEncoding); | |
|
2128
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2126
diff
changeset
|
90 |
| 0 | 91 public: |
| 1656 | 92 static void InitializeDictionary(); |
| 93 | |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1656
diff
changeset
|
94 static void RegisterDictionaryTag(const DicomTag& tag, |
|
2006
6301bbcbcaed
more generic support of value representations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1998
diff
changeset
|
95 ValueRepresentation vr, |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1656
diff
changeset
|
96 const std::string& name, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1656
diff
changeset
|
97 unsigned int minMultiplicity, |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
98 unsigned int maxMultiplicity, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
99 const std::string& privateCreator); |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1656
diff
changeset
|
100 |
| 1936 | 101 static Encoding DetectEncoding(DcmItem& dataset, |
|
1928
84c7eaeb5244
Configuration::GetDefaultEncoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1924
diff
changeset
|
102 Encoding defaultEncoding); |
|
956
2fd5a163776d
primitives for proper encoding handling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
874
diff
changeset
|
103 |
|
991
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
104 static DicomTag Convert(const DcmTag& tag); |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
105 |
| 0 | 106 static DicomTag GetTag(const DcmElement& element); |
| 107 | |
|
1655
e40fd0d925c5
/tools/create-dicom can create tags with unknown VR
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1417
diff
changeset
|
108 static bool IsUnknownTag(const DicomTag& tag); |
|
e40fd0d925c5
/tools/create-dicom can create tags with unknown VR
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1417
diff
changeset
|
109 |
|
956
2fd5a163776d
primitives for proper encoding handling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
874
diff
changeset
|
110 static DicomValue* ConvertLeafElement(DcmElement& element, |
|
1736
b953c6eef28d
ToJson: IncludePrivateTags and IncludeUnknownTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1735
diff
changeset
|
111 DicomToJsonFlags flags, |
|
1929
cda5b0ab4ce5
ORTHANC_MAXIMUM_TAG_LENGTH made explicit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1928
diff
changeset
|
112 unsigned int maxStringLength, |
|
956
2fd5a163776d
primitives for proper encoding handling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
874
diff
changeset
|
113 Encoding encoding); |
| 0 | 114 |
| 2126 | 115 static void ExtractHeaderAsJson(Json::Value& target, |
| 116 DcmMetaInfo& header, | |
| 117 DicomToJsonFormat format, | |
| 118 DicomToJsonFlags flags, | |
| 119 unsigned int maxStringLength); | |
|
1831
3ae2ff249675
"/instances/.../header" to get the meta information (header) of the DICOM instance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
120 |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
121 static std::string GetTagName(const DicomTag& tag, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
122 const std::string& privateCreator); |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
123 |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
124 static std::string GetTagName(const DcmElement& element); |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
125 |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
126 static std::string GetTagName(const DicomElement& element) |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
127 { |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
128 return GetTagName(element.GetTag(), ""); |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2006
diff
changeset
|
129 } |
| 0 | 130 |
| 304 | 131 static DicomTag ParseTag(const char* name); |
| 0 | 132 |
| 304 | 133 static DicomTag ParseTag(const std::string& name) |
| 0 | 134 { |
| 304 | 135 return ParseTag(name.c_str()); |
| 0 | 136 } |
| 137 | |
| 138 static bool HasTag(const DicomMap& fields, | |
| 139 const std::string& tagName) | |
| 140 { | |
| 304 | 141 return fields.HasTag(ParseTag(tagName)); |
| 0 | 142 } |
| 143 | |
| 144 static const DicomValue& GetValue(const DicomMap& fields, | |
| 145 const std::string& tagName) | |
| 146 { | |
| 304 | 147 return fields.GetValue(ParseTag(tagName)); |
| 0 | 148 } |
| 149 | |
| 150 static void SetValue(DicomMap& target, | |
| 151 const std::string& tagName, | |
| 152 DicomValue* value) | |
| 153 { | |
| 304 | 154 target.SetValue(ParseTag(tagName), value); |
| 0 | 155 } |
| 156 | |
| 157 static void ToJson(Json::Value& result, | |
| 1368 | 158 const DicomMap& values, |
| 159 bool simplify); | |
| 176 | 160 |
| 788 | 161 static std::string GenerateUniqueIdentifier(ResourceType level); |
|
291
4d7469f72a0b
embedding of dicom dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
285
diff
changeset
|
162 |
|
4d7469f72a0b
embedding of dicom dictionaries
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
285
diff
changeset
|
163 static bool SaveToMemoryBuffer(std::string& buffer, |
|
1004
a226e0959d8b
DicomInstanceToStore
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
164 DcmDataset& dataSet); |
| 1360 | 165 |
|
2006
6301bbcbcaed
more generic support of value representations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1998
diff
changeset
|
166 static ValueRepresentation Convert(DcmEVR vr); |
|
6301bbcbcaed
more generic support of value representations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1998
diff
changeset
|
167 |
|
6301bbcbcaed
more generic support of value representations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1998
diff
changeset
|
168 static ValueRepresentation LookupValueRepresentation(const DicomTag& tag); |
| 1689 | 169 |
| 170 static DcmElement* CreateElementForTag(const DicomTag& tag); | |
| 171 | |
| 172 static void FillElementWithString(DcmElement& element, | |
| 173 const DicomTag& tag, | |
| 1695 | 174 const std::string& utf8alue, // Encoded using UTF-8 |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1765
diff
changeset
|
175 bool decodeDataUriScheme, |
| 1695 | 176 Encoding dicomEncoding); |
| 1689 | 177 |
|
1693
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1690
diff
changeset
|
178 static DcmElement* FromJson(const DicomTag& tag, |
|
1934
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
179 const Json::Value& element, // Encoded using UTF-8 |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1765
diff
changeset
|
180 bool decodeDataUriScheme, |
| 1695 | 181 Encoding dicomEncoding); |
|
1765
57b9e6890482
New configuration option: "Dictionary" to declare custom DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1737
diff
changeset
|
182 |
|
1924
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
183 static DcmPixelSequence* GetPixelSequence(DcmDataset& dataset); |
|
1934
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
184 |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
185 static Encoding ExtractEncoding(const Json::Value& json, |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
186 Encoding defaultEncoding); |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
187 |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
188 static DcmDataset* FromJson(const Json::Value& json, // Encoded using UTF-8 |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
189 bool generateIdentifiers, |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
190 bool decodeDataUriScheme, |
|
72a2fd7fed8b
FromDcmtkBridge::FromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1929
diff
changeset
|
191 Encoding defaultEncoding); |
|
1935
e251606c1433
FromDcmtkBridge::LoadFromMemoryBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1934
diff
changeset
|
192 |
|
e251606c1433
FromDcmtkBridge::LoadFromMemoryBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1934
diff
changeset
|
193 static DcmFileFormat* LoadFromMemoryBuffer(const void* buffer, |
|
e251606c1433
FromDcmtkBridge::LoadFromMemoryBuffer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1934
diff
changeset
|
194 size_t size); |
|
1998
9b61701c35f2
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1936
diff
changeset
|
195 |
|
9b61701c35f2
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1936
diff
changeset
|
196 static void FromJson(DicomMap& values, |
|
9b61701c35f2
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1936
diff
changeset
|
197 const Json::Value& result); |
| 0 | 198 }; |
| 199 } |