Mercurial > hg > orthanc
annotate OrthancFramework/Sources/DicomParsing/DicomWebJsonVisitor.h @ 5834:79a497908b04 attach-custom-data tip
merged find-refactoring -> attach-custom-data
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Wed, 09 Oct 2024 11:06:20 +0200 |
parents | f7adfb22e20e |
children | 3f10350b26da |
rev | line source |
---|---|
3202 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5640
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
f7adfb22e20e
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5485
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
3202 | 8 * |
9 * This program is free software: you can redistribute it and/or | |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
10 * modify it under the terms of the GNU Lesser General Public License |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
11 * as published by the Free Software Foundation, either version 3 of |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
12 * the License, or (at your option) any later version. |
3202 | 13 * |
14 * This program is distributed in the hope that it will be useful, but | |
15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
17 * Lesser General Public License for more details. |
3202 | 18 * |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
19 * You should have received a copy of the GNU Lesser General Public |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
20 * License along with this program. If not, see |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4063
diff
changeset
|
21 * <http://www.gnu.org/licenses/>. |
3202 | 22 **/ |
23 | |
24 | |
25 #pragma once | |
26 | |
27 #if !defined(ORTHANC_ENABLE_PUGIXML) | |
28 # error Macro ORTHANC_ENABLE_PUGIXML must be defined to use this file | |
29 #endif | |
30 | |
31 #include "ITagVisitor.h" | |
4202
2007ab69ac16
moving ORTHANC_FORCE_INLINE and ORTHANC_OVERRIDE from Enumerations.h to Compatibility.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4119
diff
changeset
|
32 #include "../Compatibility.h" // For ORTHANC_OVERRIDE |
3202 | 33 |
34 #include <json/value.h> | |
35 | |
36 | |
37 namespace Orthanc | |
38 { | |
4063
e00f3d089991
shared library of orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
39 class ORTHANC_PUBLIC DicomWebJsonVisitor : public ITagVisitor |
3202 | 40 { |
41 public: | |
42 enum BinaryMode | |
43 { | |
44 BinaryMode_Ignore, | |
45 BinaryMode_BulkDataUri, | |
46 BinaryMode_InlineBinary | |
47 }; | |
48 | |
49 class IBinaryFormatter : public boost::noncopyable | |
50 { | |
51 public: | |
52 virtual ~IBinaryFormatter() | |
53 { | |
54 } | |
55 | |
56 virtual BinaryMode Format(std::string& bulkDataUri, | |
57 const std::vector<DicomTag>& parentTags, | |
58 const std::vector<size_t>& parentIndexes, | |
59 const DicomTag& tag, | |
60 ValueRepresentation vr) = 0; | |
61 }; | |
62 | |
63 private: | |
64 Json::Value result_; | |
65 IBinaryFormatter *formatter_; | |
66 | |
67 static std::string FormatTag(const DicomTag& tag); | |
68 | |
69 Json::Value& CreateNode(const std::vector<DicomTag>& parentTags, | |
70 const std::vector<size_t>& parentIndexes, | |
71 const DicomTag& tag); | |
72 | |
73 static Json::Value FormatInteger(int64_t value); | |
74 | |
75 static Json::Value FormatDouble(double value); | |
76 | |
77 public: | |
4297 | 78 DicomWebJsonVisitor(); |
3202 | 79 |
4297 | 80 void SetFormatter(IBinaryFormatter& formatter); |
3202 | 81 |
4297 | 82 void Clear(); |
3202 | 83 |
4297 | 84 const Json::Value& GetResult() const; |
3202 | 85 |
86 #if ORTHANC_ENABLE_PUGIXML == 1 | |
3203
810772486249
URI "/instances/.../file" can return DICOMweb JSON or XML, depending on Accept header
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3202
diff
changeset
|
87 void FormatXml(std::string& target) const; |
3202 | 88 #endif |
89 | |
4734
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
90 virtual Action VisitNotSupported(const std::vector<DicomTag>& parentTags, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
91 const std::vector<size_t>& parentIndexes, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
92 const DicomTag& tag, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
93 ValueRepresentation vr) |
4297 | 94 ORTHANC_OVERRIDE; |
3202 | 95 |
4737
979ae3ea3381
DANGEROUS commit: Anonymization is now also applied to nested sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4734
diff
changeset
|
96 virtual Action VisitSequence(const std::vector<DicomTag>& parentTags, |
979ae3ea3381
DANGEROUS commit: Anonymization is now also applied to nested sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4734
diff
changeset
|
97 const std::vector<size_t>& parentIndexes, |
979ae3ea3381
DANGEROUS commit: Anonymization is now also applied to nested sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4734
diff
changeset
|
98 const DicomTag& tag, |
979ae3ea3381
DANGEROUS commit: Anonymization is now also applied to nested sequences
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4734
diff
changeset
|
99 size_t countItems) |
3202 | 100 ORTHANC_OVERRIDE; |
101 | |
4734
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
102 virtual Action VisitBinary(const std::vector<DicomTag>& parentTags, |
3202 | 103 const std::vector<size_t>& parentIndexes, |
104 const DicomTag& tag, | |
105 ValueRepresentation vr, | |
4734
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
106 const void* data, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
107 size_t size) |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
108 ORTHANC_OVERRIDE; |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
109 |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
110 virtual Action VisitIntegers(const std::vector<DicomTag>& parentTags, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
111 const std::vector<size_t>& parentIndexes, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
112 const DicomTag& tag, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
113 ValueRepresentation vr, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
114 const std::vector<int64_t>& values) |
3202 | 115 ORTHANC_OVERRIDE; |
116 | |
4734
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
117 virtual Action VisitDoubles(const std::vector<DicomTag>& parentTags, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
118 const std::vector<size_t>& parentIndexes, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
119 const DicomTag& tag, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
120 ValueRepresentation vr, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
121 const std::vector<double>& values) |
3202 | 122 ORTHANC_OVERRIDE; |
123 | |
4734
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
124 virtual Action VisitAttributes(const std::vector<DicomTag>& parentTags, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
125 const std::vector<size_t>& parentIndexes, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
126 const DicomTag& tag, |
b51c08bd5c38
added ITagVisitor::Action_Remove
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
127 const std::vector<DicomTag>& values) |
3202 | 128 ORTHANC_OVERRIDE; |
129 | |
130 virtual Action VisitString(std::string& newValue, | |
131 const std::vector<DicomTag>& parentTags, | |
132 const std::vector<size_t>& parentIndexes, | |
133 const DicomTag& tag, | |
134 ValueRepresentation vr, | |
135 const std::string& value) | |
136 ORTHANC_OVERRIDE; | |
137 }; | |
138 } |