annotate OrthancFramework/Sources/DicomFormat/DicomInstanceHasher.h @ 4110:d99739cbe94c

make DicomInstanceHasher and ParsedDicomDir public classes
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 10:03:59 +0200
parents d25f4c0fa160
children bf7b9edf6b81
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "DicomMap.h"
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 namespace Orthanc
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 /**
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 * This class implements the hashing mechanism that is used to
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 * convert DICOM unique identifiers to Orthanc identifiers. Any
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 * Orthanc identifier for a DICOM resource corresponds to the SHA-1
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 * hash of the DICOM identifiers.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 * \note SHA-1 hash is used because it is less sensitive to
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 * collision attacks than MD5. <a
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 * href="http://en.wikipedia.org/wiki/SHA-256#Comparison_of_SHA_functions">[Reference]</a>
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 **/
4110
d99739cbe94c make DicomInstanceHasher and ParsedDicomDir public classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
50 class ORTHANC_PUBLIC DicomInstanceHasher
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 private:
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 std::string patientId_;
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
54 std::string studyUid_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 std::string seriesUid_;
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
56 std::string instanceUid_;
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
57
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
58 std::string patientHash_;
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
59 std::string studyHash_;
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
60 std::string seriesHash_;
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
61 std::string instanceHash_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
315
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
63 void Setup(const std::string& patientId,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
64 const std::string& studyUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
65 const std::string& seriesUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
66 const std::string& instanceUid);
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
67
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 public:
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 DicomInstanceHasher(const DicomMap& instance);
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
315
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
71 DicomInstanceHasher(const std::string& patientId,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
72 const std::string& studyUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
73 const std::string& seriesUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
74 const std::string& instanceUid)
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
75 {
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
76 Setup(patientId, studyUid, seriesUid, instanceUid);
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
77 }
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
78
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 const std::string& GetPatientId() const
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 return patientId_;
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
84 const std::string& GetStudyUid() const
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
86 return studyUid_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 const std::string& GetSeriesUid() const
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 return seriesUid_;
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 }
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
94 const std::string& GetInstanceUid() const
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 {
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
96 return instanceUid_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 }
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
99 const std::string& HashPatient();
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
101 const std::string& HashStudy();
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
103 const std::string& HashSeries();
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
105 const std::string& HashInstance();
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 };
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 }