annotate Framework/Deprecated/Loaders/OrthancMultiframeVolumeLoader.h @ 1303:83af7e562b45 broker

IGeometryProvider interface for deprecated loaders (required for AB testing in older app)
author Benjamin Golinvaux <bgo@osimis.io>
date Wed, 04 Mar 2020 09:44:09 +0100
parents 7ec8fea061b9
children 9bea7e15b519
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
1271
0ca50d275b9a upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1225
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "LoaderStateMachine.h"
1225
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
25 #include "../../Volumes/DicomVolumeImage.h"
1303
83af7e562b45 IGeometryProvider interface for deprecated loaders (required for AB testing in older app)
Benjamin Golinvaux <bgo@osimis.io>
parents: 1279
diff changeset
26 #include "../Volumes/IGeometryProvider.h"
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
816
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 815
diff changeset
28 #include <boost/shared_ptr.hpp>
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 815
diff changeset
29
1225
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
30 namespace Deprecated
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 class OrthancMultiframeVolumeLoader :
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 public LoaderStateMachine,
1303
83af7e562b45 IGeometryProvider interface for deprecated loaders (required for AB testing in older app)
Benjamin Golinvaux <bgo@osimis.io>
parents: 1279
diff changeset
34 public OrthancStone::IObservable,
83af7e562b45 IGeometryProvider interface for deprecated loaders (required for AB testing in older app)
Benjamin Golinvaux <bgo@osimis.io>
parents: 1279
diff changeset
35 public IGeometryProvider
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 private:
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 class LoadRTDoseGeometry;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 class LoadGeometry;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class LoadTransferSyntax;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class LoadUncompressedPixelData;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
1225
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
43 boost::shared_ptr<OrthancStone::DicomVolumeImage> volume_;
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 std::string instanceId_;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 std::string transferSyntaxUid_;
937
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
46 bool pixelDataLoaded_;
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
47 float outliersHalfRejectionRate_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
48 float distributionRawMin_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
49 float distributionRawMax_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
50 float computedDistributionMin_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
51 float computedDistributionMax_;
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 const std::string& GetInstanceId() const;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 void ScheduleFrameDownloads();
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 void SetTransferSyntax(const std::string& transferSyntax);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 void SetGeometry(const Orthanc::DicomMap& dicom);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
61
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
62 /**
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
63 This method will :
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
64
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
65 - copy the pixel values from the response to the volume image
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
66 - compute the maximum and minimum value while discarding the
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
67 outliersHalfRejectionRate_ fraction of the outliers from both the start
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
68 and the end of the distribution.
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
69
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
70 In English, this means that, if the volume dataset contains a few extreme
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
71 values very different from the rest (outliers) that we want to get rid of,
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
72 this method allows to do so.
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
73
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
74 If you supply 0.005, for instance, it means 1% of the extreme values will
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
75 be rejected (0.5% on each side of the distribution)
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
76 */
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 template <typename T>
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
78 void CopyPixelDataAndComputeMinMax(const std::string& pixelData);
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
79
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
80 /** Service method for CopyPixelDataAndComputeMinMax*/
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
81 template <typename T>
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
82 void CopyPixelDataAndComputeDistribution(
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
83 const std::string& pixelData,
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
84 std::map<T, uint64_t>& distribution);
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
85
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
86 /** Service method for CopyPixelDataAndComputeMinMax*/
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
87 template <typename T>
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
88 void ComputeMinMaxWithOutlierRejection(
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
89 const std::map<T, uint64_t>& distribution);
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 void SetUncompressedPixelData(const std::string& pixelData);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92
1156
34ee7204fde3 removing IGeometryProvider
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 949
diff changeset
93 bool HasGeometry() const;
1225
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
94 const OrthancStone::VolumeImageGeometry& GetImageGeometry() const;
949
32eaf4929b08 OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader now implement IGeometryProvider so that the geometry reference can be switched (CT or DOSE, for instance) + VolumeImageGeometry::SetSize renamed to VolumeImageGeometry::SetSizeInVoxels + prevent text layer update if text or properties do not change + a few stream operator<< for debug (Vector, Matrix,...) + fixed memory access aligment issues in ImageBuffer3D::ExtractSagittalSlice + fix for wrong screen Y offset of mpr slices in DicomVolumeImageMPRSlicer.
Benjamin Golinvaux <bgo@osimis.io>
parents: 937
diff changeset
95
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 public:
1225
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
97 OrthancMultiframeVolumeLoader(boost::shared_ptr<OrthancStone::DicomVolumeImage> volume,
16738485e457 deprecating DicomStructureSetLoader, OrthancMultiframeVolumeLoader and OrthancSeriesVolumeProgressiveLoader
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1156
diff changeset
98 OrthancStone::IOracle& oracle,
1279
7ec8fea061b9 integration mainline->broker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1270 1271
diff changeset
99 OrthancStone::IObservable& oracleObservable,
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
100 float outliersHalfRejectionRate = 0.0005);
935
401808e7ff2e Added traces in LoaderCache objects dtors + fuse to prevent dead weak ptrs to be calleds in VisitWdigets (in GuiAdapter.h)
Benjamin Golinvaux <bgo@osimis.io>
parents: 921
diff changeset
101
401808e7ff2e Added traces in LoaderCache objects dtors + fuse to prevent dead weak ptrs to be calleds in VisitWdigets (in GuiAdapter.h)
Benjamin Golinvaux <bgo@osimis.io>
parents: 921
diff changeset
102 virtual ~OrthancMultiframeVolumeLoader();
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
937
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
104 bool IsPixelDataLoaded() const
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
105 {
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
106 return pixelDataLoaded_;
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
107 }
86ac61a040c9 Added getters and notifications to allow clients of the loaders (DicomStructureSetLoader, OrthancSeriesVolumeProgressiveLoader and OrthancMultiframeVolumeLoader) to know when the loading is finished + added ability for SDL event loop to execute a callback repeatedly (used to check the view loading state)
Benjamin Golinvaux <bgo@osimis.io>
parents: 935
diff changeset
108
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
109 void GetDistributionMinMax
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
110 (float& minValue, float& maxValue) const;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
111
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
112 void GetDistributionMinMaxWithOutliersRejection
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
113 (float& minValue, float& maxValue) const;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
114
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 void LoadInstance(const std::string& instanceId);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 };
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 }