Mercurial > hg > orthanc
annotate OrthancServer/ParsedDicomFile.h @ 2170:baf8dd89b4e0
improved support for sandboxed environments
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 23 Nov 2016 11:45:02 +0100 |
| parents | 5a8840920121 |
| children | 9b373b7d6713 |
| rev | line source |
|---|---|
| 790 | 1 /** |
| 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:
1160
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 790 | 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 "../Core/DicomFormat/DicomInstanceHasher.h" | |
|
1902
8b0ee8d5e6d0
Refactoring leading to speedups with custom image decoders
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
36 #include "../Core/Images/ImageAccessor.h" |
|
1824
b530c3dfe2a6
refactoring image decoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
37 #include "../Core/IDynamicObject.h" |
| 790 | 38 #include "../Core/RestApi/RestApiOutput.h" |
| 2142 | 39 #include "../Core/Toolbox.h" |
| 790 | 40 #include "ServerEnumerations.h" |
| 41 | |
|
1788
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
42 class DcmDataset; |
|
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
43 class DcmFileFormat; |
|
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
44 |
| 790 | 45 namespace Orthanc |
| 46 { | |
| 47 class ParsedDicomFile : public IDynamicObject | |
| 48 { | |
| 49 private: | |
| 794 | 50 struct PImpl; |
| 51 PImpl* pimpl_; | |
| 790 | 52 |
| 794 | 53 ParsedDicomFile(ParsedDicomFile& other); |
| 790 | 54 |
|
991
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
55 void RemovePrivateTagsInternal(const std::set<DicomTag>* toKeep); |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
56 |
|
1693
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1686
diff
changeset
|
57 void UpdateStorageUid(const DicomTag& tag, |
|
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1686
diff
changeset
|
58 const std::string& value, |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
59 bool decodeDataUriScheme); |
|
1693
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1686
diff
changeset
|
60 |
|
1924
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
61 void InvalidateCache(); |
|
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
62 |
|
1982
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
63 bool EmbedContentInternal(const std::string& dataUriScheme); |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
64 |
| 790 | 65 public: |
|
1805
f08978b1f45b
c-find scu for modality worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
66 ParsedDicomFile(bool createIdentifiers); // Create a minimal DICOM instance |
| 790 | 67 |
|
1787
1b1d5470233f
refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
68 ParsedDicomFile(const DicomMap& map); |
|
1b1d5470233f
refactoring of DicomFindAnswers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
69 |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1788
diff
changeset
|
70 ParsedDicomFile(const void* content, |
| 791 | 71 size_t size); |
| 790 | 72 |
| 791 | 73 ParsedDicomFile(const std::string& content); |
| 790 | 74 |
|
1788
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
75 ParsedDicomFile(DcmDataset& dicom); |
|
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
76 |
|
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
77 ParsedDicomFile(DcmFileFormat& dicom); |
|
6a2d507ef064
getting rid of opaque data structures
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1787
diff
changeset
|
78 |
| 792 | 79 ~ParsedDicomFile(); |
| 80 | |
|
1824
b530c3dfe2a6
refactoring image decoding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1818
diff
changeset
|
81 DcmFileFormat& GetDcmtkObject() const; |
| 790 | 82 |
| 793 | 83 ParsedDicomFile* Clone(); |
| 790 | 84 |
| 85 void SendPathValue(RestApiOutput& output, | |
| 86 const UriComponents& uri); | |
| 87 | |
| 88 void Answer(RestApiOutput& output); | |
| 89 | |
| 90 void Remove(const DicomTag& tag); | |
| 91 | |
|
1699
8ca0e89798b2
"/modify" can insert/modify sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1695
diff
changeset
|
92 void Replace(const DicomTag& tag, |
|
8ca0e89798b2
"/modify" can insert/modify sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1695
diff
changeset
|
93 const std::string& utf8Value, |
|
1982
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
94 bool decodeDataUriScheme, |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
95 DicomReplaceMode mode); |
| 1695 | 96 |
| 97 void Replace(const DicomTag& tag, | |
|
1699
8ca0e89798b2
"/modify" can insert/modify sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1695
diff
changeset
|
98 const Json::Value& value, // Assumed to be encoded with UTF-8 |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
99 bool decodeDataUriScheme, |
|
1982
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
100 DicomReplaceMode mode); |
| 790 | 101 |
|
1693
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1686
diff
changeset
|
102 void Insert(const DicomTag& tag, |
| 1695 | 103 const Json::Value& value, // Assumed to be encoded with UTF-8 |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
104 bool decodeDataUriScheme); |
|
1693
558b25228a23
creation of tag hierarchy from json
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1686
diff
changeset
|
105 |
|
1982
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
106 void ReplacePlainString(const DicomTag& tag, |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
107 const std::string& utf8Value) |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
108 { |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
109 Replace(tag, utf8Value, false, DicomReplaceMode_InsertIfAbsent); |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
110 } |
|
b5d4f9c156ad
Modification of instances can now replace PixelData
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1950
diff
changeset
|
111 |
|
991
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
112 void RemovePrivateTags() |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
113 { |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
114 RemovePrivateTagsInternal(NULL); |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
115 } |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
116 |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
117 void RemovePrivateTags(const std::set<DicomTag>& toKeep) |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
118 { |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
119 RemovePrivateTagsInternal(&toKeep); |
|
2f76b92addd4
keep private tags during anonymization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
956
diff
changeset
|
120 } |
| 790 | 121 |
| 122 bool GetTagValue(std::string& value, | |
| 123 const DicomTag& tag); | |
| 124 | |
| 125 DicomInstanceHasher GetHasher(); | |
| 126 | |
| 127 void SaveToMemoryBuffer(std::string& buffer); | |
| 128 | |
| 129 void SaveToFile(const std::string& path); | |
|
800
ecedd89055db
generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
795
diff
changeset
|
130 |
| 1562 | 131 void EmbedContent(const std::string& dataUriScheme); |
|
800
ecedd89055db
generation of DICOM images from PNG files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
795
diff
changeset
|
132 |
| 1562 | 133 void EmbedImage(const ImageAccessor& accessor); |
|
874
87791ebc1f50
download matlab images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
800
diff
changeset
|
134 |
|
1555
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
135 void EmbedImage(const std::string& mime, |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
136 const std::string& content); |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
137 |
|
956
2fd5a163776d
primitives for proper encoding handling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
874
diff
changeset
|
138 Encoding GetEncoding() const; |
|
1090
e494ceb8d763
support more encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
139 |
|
e494ceb8d763
support more encodings
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
991
diff
changeset
|
140 void SetEncoding(Encoding encoding); |
|
1160
80671157d051
generalization of create-dicom
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1090
diff
changeset
|
141 |
|
2128
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
142 void DatasetToJson(Json::Value& target, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
143 DicomToJsonFormat format, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
144 DicomToJsonFlags flags, |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
145 unsigned int maxStringLength); |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
146 |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
147 // This version uses the default parameters for |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
148 // FileContentType_DicomAsJson |
|
9329ba17a069
Possibility to DELETE "dicom-as-json" attachments to reconstruct them
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1982
diff
changeset
|
149 void DatasetToJson(Json::Value& target); |
|
1555
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
150 |
|
1831
3ae2ff249675
"/instances/.../header" to get the meta information (header) of the DICOM instance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
151 void HeaderToJson(Json::Value& target, |
|
3ae2ff249675
"/instances/.../header" to get the meta information (header) of the DICOM instance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
152 DicomToJsonFormat format); |
|
3ae2ff249675
"/instances/.../header" to get the meta information (header) of the DICOM instance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
153 |
|
1555
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
154 bool HasTag(const DicomTag& tag) const; |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
155 |
|
d6a93e12b1c1
Creation of DICOM files with encapsulated PDF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
156 void EmbedPdf(const std::string& pdf); |
|
1556
b8dc2f855a83
Preview of PDF files encapsulated in DICOM from Orthanc Explorer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1555
diff
changeset
|
157 |
|
b8dc2f855a83
Preview of PDF files encapsulated in DICOM from Orthanc Explorer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1555
diff
changeset
|
158 bool ExtractPdf(std::string& pdf); |
|
1662
09be34b2f30e
ParsedDicomFile::Convert()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1612
diff
changeset
|
159 |
|
09be34b2f30e
ParsedDicomFile::Convert()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1612
diff
changeset
|
160 void Convert(DicomMap& tags); |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
161 |
|
1924
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
162 void GetRawFrame(std::string& target, // OUT |
|
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
163 std::string& mime, // OUT |
|
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
164 unsigned int frameId); // IN |
|
6c73df12ca51
New URI: "/instances/.../frames/.../raw" to access the raw frames (bypass image decoding)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1902
diff
changeset
|
165 |
|
1950
533ff46e944b
return a single raw frame from DICOM videos
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1935
diff
changeset
|
166 unsigned int GetFramesCount() const; |
|
533ff46e944b
return a single raw frame from DICOM videos
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1935
diff
changeset
|
167 |
|
1818
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
168 static ParsedDicomFile* CreateFromJson(const Json::Value& value, |
|
1065401501fb
ParsedDicomFile::CreateFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1805
diff
changeset
|
169 DicomFromJsonFlags flags); |
| 790 | 170 }; |
| 171 | |
| 172 } |