annotate OrthancFramework/Sources/DicomFormat/DicomInstanceHasher.h @ 5111:7547c7dfd017

/tools/metrics-prometheus: added orthanc_last_change and orthanc_up_time_s
author Alain Mazy <am@osimis.io>
date Tue, 22 Nov 2022 18:01:23 +0100
parents c767035fff77
children 0ea402b4d901
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
4870
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * 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: 4110
diff changeset
9 * 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: 4110
diff changeset
10 * 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: 4110
diff changeset
11 * the License, or (at your option) any later version.
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * 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: 4110
diff changeset
16 * Lesser General Public License for more details.
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4110
diff changeset
18 * 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: 4110
diff changeset
19 * 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: 4110
diff changeset
20 * <http://www.gnu.org/licenses/>.
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "DicomMap.h"
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 namespace Orthanc
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 /**
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 * This class implements the hashing mechanism that is used to
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 * convert DICOM unique identifiers to Orthanc identifiers. Any
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 * Orthanc identifier for a DICOM resource corresponds to the SHA-1
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 * hash of the DICOM identifiers.
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 * \note SHA-1 hash is used because it is less sensitive to
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 * collision attacks than MD5. <a
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 * 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
39 **/
4110
d99739cbe94c make DicomInstanceHasher and ParsedDicomDir public classes
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
40 class ORTHANC_PUBLIC DicomInstanceHasher
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 private:
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 std::string patientId_;
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
44 std::string studyUid_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 std::string seriesUid_;
179
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
46 std::string instanceUid_;
78e28d0098d9 refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 178
diff changeset
47
4985
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
48 mutable std::string patientHash_;
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
49 mutable std::string studyHash_;
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
50 mutable std::string seriesHash_;
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
51 mutable std::string instanceHash_;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
315
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
53 void Setup(const std::string& patientId,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
54 const std::string& studyUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
55 const std::string& seriesUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
56 const std::string& instanceUid);
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
57
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 public:
4199
fbc49a65340a cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
59 explicit DicomInstanceHasher(const DicomMap& instance);
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
315
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
61 DicomInstanceHasher(const std::string& patientId,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
62 const std::string& studyUid,
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
63 const std::string& seriesUid,
4296
3b70a2e6a06c moving inline methods to source files for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
64 const std::string& instanceUid);
315
fc856d175d18 modifications
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 179
diff changeset
65
4296
3b70a2e6a06c moving inline methods to source files for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
66 const std::string& GetPatientId() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
4296
3b70a2e6a06c moving inline methods to source files for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
68 const std::string& GetStudyUid() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69
4296
3b70a2e6a06c moving inline methods to source files for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
70 const std::string& GetSeriesUid() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
4296
3b70a2e6a06c moving inline methods to source files for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4199
diff changeset
72 const std::string& GetInstanceUid() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73
4985
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
74 const std::string& HashPatient() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
4985
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
76 const std::string& HashStudy() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
4985
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
78 const std::string& HashSeries() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
4985
c767035fff77 cppcheck
Alain Mazy <am@osimis.io>
parents: 4870
diff changeset
80 const std::string& HashInstance() const;
178
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 };
5739b4d10a4b hashing
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }