annotate Framework/Loaders/OrthancMultiframeVolumeLoader.h @ 1273:398ea4259e65

merge
author Alain Mazy <alain@mazy.be>
date Mon, 03 Feb 2020 14:57:22 +0100
parents 2d8ab34c8c91
children f4a06ad1580b
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
1270
2d8ab34c8c91 upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1260
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"
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "../Volumes/DicomVolumeImage.h"
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
816
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 815
diff changeset
27 #include <boost/shared_ptr.hpp>
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 815
diff changeset
28
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 class OrthancMultiframeVolumeLoader :
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 public LoaderStateMachine,
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
33 public IObservable,
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
34 public IGeometryProvider
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 class LoadRTDoseGeometry;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 class LoadGeometry;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 class LoadTransferSyntax;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class LoadUncompressedPixelData;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 boost::shared_ptr<DicomVolumeImage> volume_;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 std::string instanceId_;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 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
45 bool pixelDataLoaded_;
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
46 float outliersHalfRejectionRate_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
47 float distributionRawMin_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
48 float distributionRawMax_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
49 float computedDistributionMin_;
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
50 float computedDistributionMax_;
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 const std::string& GetInstanceId() const;
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 void ScheduleFrameDownloads();
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 void SetTransferSyntax(const std::string& transferSyntax);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 void SetGeometry(const Orthanc::DicomMap& dicom);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
60
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 This method will :
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
63
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
64 - 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
65 - 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
66 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
67 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
68
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
69 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
70 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
71 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
72
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
73 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
74 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
75 */
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 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
77 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
78
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
79 /** 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
80 template <typename T>
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
81 void CopyPixelDataAndComputeDistribution(
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
82 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
83 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
84
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
85 /** 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
86 template <typename T>
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
87 void ComputeMinMaxWithOutlierRejection(
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
88 const std::map<T, uint64_t>& distribution);
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 void SetUncompressedPixelData(const std::string& pixelData);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91
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
92 virtual bool HasGeometry() const ORTHANC_OVERRIDE;
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
93 virtual const VolumeImageGeometry& GetImageGeometry() const ORTHANC_OVERRIDE;
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
94
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 public:
921
81d30cd93b65 Ability to ask the loader for the geometry in PULL mode (when subscribing to the messages is not possible) + small changes (removed const/ref qualifiers for boost::shared_ptr param, added traces, doc change)
Benjamin Golinvaux <bgo@osimis.io>
parents: 816
diff changeset
96 OrthancMultiframeVolumeLoader(boost::shared_ptr<DicomVolumeImage> volume,
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 IOracle& oracle,
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
98 IObservable& oracleObservable,
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
99 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
100
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 virtual ~OrthancMultiframeVolumeLoader();
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
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
103 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
104 {
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 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
106 }
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
1260
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
108 void GetDistributionMinMax
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
109 (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
110
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
111 void GetDistributionMinMaxWithOutliersRejection
5a2d5380148d Added outlier rejection for min max computation in multiframe volume loader
Benjamin Golinvaux <bgo@osimis.io>
parents: 949
diff changeset
112 (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
113
815
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 void LoadInstance(const std::string& instanceId);
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 };
df442f1ba0c6 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 }