Mercurial > hg > orthanc-stone
annotate Framework/Loaders/OrthancSeriesVolumeProgressiveLoader.cpp @ 933:f75f6cb69c1b
Commented-out traces for debug
author | Benjamin Golinvaux <bgo@osimis.io> |
---|---|
date | Fri, 26 Jul 2019 20:09:42 +0200 |
parents | 2b4b6b86520a |
children | 401808e7ff2e |
rev | line source |
---|---|
814 | 1 /** |
2 * Stone of Orthanc | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium | |
6 * | |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU Affero General Public License | |
9 * as published by the Free Software Foundation, either version 3 of | |
10 * the License, or (at your option) any later version. | |
11 * | |
12 * This program is distributed in the hope that it will be useful, but | |
13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 * Affero General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU Affero General Public License | |
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 **/ | |
20 | |
21 | |
22 #include "OrthancSeriesVolumeProgressiveLoader.h" | |
23 | |
24 #include "../Toolbox/GeometryToolbox.h" | |
25 #include "../Volumes/DicomVolumeImageMPRSlicer.h" | |
26 #include "BasicFetchingItemsSorter.h" | |
27 #include "BasicFetchingStrategy.h" | |
28 | |
29 #include <Core/Images/ImageProcessing.h> | |
30 #include <Core/OrthancException.h> | |
31 | |
32 namespace OrthancStone | |
33 { | |
34 class OrthancSeriesVolumeProgressiveLoader::ExtractedSlice : public DicomVolumeImageMPRSlicer::Slice | |
35 { | |
36 private: | |
37 const OrthancSeriesVolumeProgressiveLoader& that_; | |
38 | |
39 public: | |
40 ExtractedSlice(const OrthancSeriesVolumeProgressiveLoader& that, | |
41 const CoordinateSystem3D& plane) : | |
42 DicomVolumeImageMPRSlicer::Slice(*that.volume_, plane), | |
43 that_(that) | |
44 { | |
819 | 45 if (IsValid()) |
817
68f888812af4
simplification of DicomVolumeImageMPRSlicer::ExtractedSlice
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
814
diff
changeset
|
46 { |
819 | 47 if (GetProjection() == VolumeProjection_Axial) |
48 { | |
49 // For coronal and sagittal projections, we take the global | |
50 // revision of the volume because even if a single slice changes, | |
51 // this means the projection will yield a different result --> | |
52 // we must increase the revision as soon as any slice changes | |
53 SetRevision(that_.seriesGeometry_.GetSliceRevision(GetSliceIndex())); | |
54 } | |
817
68f888812af4
simplification of DicomVolumeImageMPRSlicer::ExtractedSlice
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
814
diff
changeset
|
55 |
819 | 56 if (that_.strategy_.get() != NULL && |
57 GetProjection() == VolumeProjection_Axial) | |
58 { | |
59 that_.strategy_->SetCurrent(GetSliceIndex()); | |
60 } | |
814 | 61 } |
62 } | |
63 }; | |
64 | |
65 | |
66 | |
67 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::CheckSlice(size_t index, | |
68 const DicomInstanceParameters& reference) const | |
69 { | |
70 const DicomInstanceParameters& slice = *slices_[index]; | |
71 | |
72 if (!GeometryToolbox::IsParallel( | |
73 reference.GetGeometry().GetNormal(), | |
74 slice.GetGeometry().GetNormal())) | |
75 { | |
76 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadGeometry, | |
77 "A slice in the volume image is not parallel to the others"); | |
78 } | |
79 | |
80 if (reference.GetExpectedPixelFormat() != slice.GetExpectedPixelFormat()) | |
81 { | |
82 throw Orthanc::OrthancException(Orthanc::ErrorCode_IncompatibleImageFormat, | |
83 "The pixel format changes across the slices of the volume image"); | |
84 } | |
85 | |
86 if (reference.GetImageInformation().GetWidth() != slice.GetImageInformation().GetWidth() || | |
87 reference.GetImageInformation().GetHeight() != slice.GetImageInformation().GetHeight()) | |
88 { | |
89 throw Orthanc::OrthancException(Orthanc::ErrorCode_IncompatibleImageSize, | |
90 "The width/height of slices are not constant in the volume image"); | |
91 } | |
92 | |
93 if (!LinearAlgebra::IsNear(reference.GetPixelSpacingX(), slice.GetPixelSpacingX()) || | |
94 !LinearAlgebra::IsNear(reference.GetPixelSpacingY(), slice.GetPixelSpacingY())) | |
95 { | |
96 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadGeometry, | |
97 "The pixel spacing of the slices change across the volume image"); | |
98 } | |
99 } | |
100 | |
101 | |
102 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::CheckVolume() const | |
103 { | |
104 for (size_t i = 0; i < slices_.size(); i++) | |
105 { | |
106 assert(slices_[i] != NULL); | |
107 if (slices_[i]->GetImageInformation().GetNumberOfFrames() != 1) | |
108 { | |
109 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadGeometry, | |
110 "This class does not support multi-frame images"); | |
111 } | |
112 } | |
113 | |
114 if (slices_.size() != 0) | |
115 { | |
116 const DicomInstanceParameters& reference = *slices_[0]; | |
117 | |
118 for (size_t i = 1; i < slices_.size(); i++) | |
119 { | |
120 CheckSlice(i, reference); | |
121 } | |
122 } | |
123 } | |
124 | |
125 | |
126 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::Clear() | |
127 { | |
128 for (size_t i = 0; i < slices_.size(); i++) | |
129 { | |
130 assert(slices_[i] != NULL); | |
131 delete slices_[i]; | |
132 } | |
133 | |
134 slices_.clear(); | |
135 slicesRevision_.clear(); | |
136 } | |
137 | |
138 | |
139 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::CheckSliceIndex(size_t index) const | |
140 { | |
141 if (!HasGeometry()) | |
142 { | |
143 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
144 } | |
145 else if (index >= slices_.size()) | |
146 { | |
147 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
148 } | |
149 else | |
150 { | |
151 assert(slices_.size() == GetImageGeometry().GetDepth() && | |
152 slices_.size() == slicesRevision_.size()); | |
153 } | |
154 } | |
155 | |
156 | |
157 // WARNING: The payload of "slices" must be of class "DicomInstanceParameters" | |
158 // (called with the slices created in LoadGeometry) | |
159 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::ComputeGeometry(SlicesSorter& slices) | |
160 { | |
161 Clear(); | |
162 | |
163 if (!slices.Sort()) | |
164 { | |
165 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange, | |
166 "Cannot sort the 3D slices of a DICOM series"); | |
167 } | |
168 | |
169 if (slices.GetSlicesCount() == 0) | |
170 { | |
171 geometry_.reset(new VolumeImageGeometry); | |
172 } | |
173 else | |
174 { | |
175 slices_.reserve(slices.GetSlicesCount()); | |
176 slicesRevision_.resize(slices.GetSlicesCount(), 0); | |
177 | |
178 for (size_t i = 0; i < slices.GetSlicesCount(); i++) | |
179 { | |
180 const DicomInstanceParameters& slice = | |
181 dynamic_cast<const DicomInstanceParameters&>(slices.GetSlicePayload(i)); | |
182 slices_.push_back(new DicomInstanceParameters(slice)); | |
183 } | |
184 | |
185 CheckVolume(); | |
186 | |
187 const double spacingZ = slices.ComputeSpacingBetweenSlices(); | |
188 LOG(INFO) << "Computed spacing between slices: " << spacingZ << "mm"; | |
189 | |
190 const DicomInstanceParameters& parameters = *slices_[0]; | |
191 | |
192 geometry_.reset(new VolumeImageGeometry); | |
193 geometry_->SetSize(parameters.GetImageInformation().GetWidth(), | |
194 parameters.GetImageInformation().GetHeight(), | |
195 static_cast<unsigned int>(slices.GetSlicesCount())); | |
196 geometry_->SetAxialGeometry(slices.GetSliceGeometry(0)); | |
197 geometry_->SetVoxelDimensions(parameters.GetPixelSpacingX(), | |
198 parameters.GetPixelSpacingY(), spacingZ); | |
199 } | |
200 } | |
201 | |
202 | |
203 const VolumeImageGeometry& OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::GetImageGeometry() const | |
204 { | |
205 if (!HasGeometry()) | |
206 { | |
207 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
208 } | |
209 else | |
210 { | |
211 assert(slices_.size() == geometry_->GetDepth()); | |
212 return *geometry_; | |
213 } | |
214 } | |
215 | |
216 | |
217 const DicomInstanceParameters& OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::GetSliceParameters(size_t index) const | |
218 { | |
219 CheckSliceIndex(index); | |
220 return *slices_[index]; | |
221 } | |
222 | |
223 | |
224 uint64_t OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::GetSliceRevision(size_t index) const | |
225 { | |
226 CheckSliceIndex(index); | |
227 return slicesRevision_[index]; | |
228 } | |
229 | |
230 | |
231 void OrthancSeriesVolumeProgressiveLoader::SeriesGeometry::IncrementSliceRevision(size_t index) | |
232 { | |
233 CheckSliceIndex(index); | |
234 slicesRevision_[index] ++; | |
235 } | |
236 | |
237 | |
238 static unsigned int GetSliceIndexPayload(const OracleCommandWithPayload& command) | |
239 { | |
240 return dynamic_cast< const Orthanc::SingleValueObject<unsigned int>& >(command.GetPayload()).GetValue(); | |
241 } | |
242 | |
243 | |
244 void OrthancSeriesVolumeProgressiveLoader::ScheduleNextSliceDownload() | |
245 { | |
246 assert(strategy_.get() != NULL); | |
247 | |
248 unsigned int sliceIndex, quality; | |
249 | |
250 if (strategy_->GetNext(sliceIndex, quality)) | |
251 { | |
252 assert(quality <= BEST_QUALITY); | |
253 | |
254 const DicomInstanceParameters& slice = seriesGeometry_.GetSliceParameters(sliceIndex); | |
255 | |
256 const std::string& instance = slice.GetOrthancInstanceIdentifier(); | |
257 if (instance.empty()) | |
258 { | |
259 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
260 } | |
261 | |
262 std::auto_ptr<OracleCommandWithPayload> command; | |
263 | |
264 if (quality == BEST_QUALITY) | |
265 { | |
266 std::auto_ptr<GetOrthancImageCommand> tmp(new GetOrthancImageCommand); | |
913
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
267 // TODO: review the following comment. Commented out by bgo on 2019-07-19 |
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
268 // reason: Alain has seen cases where gzipping the uint16 image took 11 sec |
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
269 // to produce 5mb. The unzipped request was much much faster. |
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
270 //tmp->SetHttpHeader("Accept-Encoding", "gzip"); |
814 | 271 tmp->SetHttpHeader("Accept", std::string(Orthanc::EnumerationToString(Orthanc::MimeType_Pam))); |
819 | 272 tmp->SetInstanceUri(instance, slice.GetExpectedPixelFormat()); |
814 | 273 tmp->SetExpectedPixelFormat(slice.GetExpectedPixelFormat()); |
274 command.reset(tmp.release()); | |
275 } | |
276 else | |
277 { | |
278 std::auto_ptr<GetOrthancWebViewerJpegCommand> tmp(new GetOrthancWebViewerJpegCommand); | |
913
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
279 // TODO: review the following comment. Commented out by bgo on 2019-07-19 |
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
280 // (gzip for jpeg seems overkill) |
2b4b6b86520a
Re-enabled gl debug output in GuiAdapter +
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
281 //tmp->SetHttpHeader("Accept-Encoding", "gzip"); |
814 | 282 tmp->SetInstance(instance); |
283 tmp->SetQuality((quality == 0 ? 50 : 90)); | |
284 tmp->SetExpectedPixelFormat(slice.GetExpectedPixelFormat()); | |
285 command.reset(tmp.release()); | |
286 } | |
287 | |
288 command->SetPayload(new Orthanc::SingleValueObject<unsigned int>(sliceIndex)); | |
289 oracle_.Schedule(*this, command.release()); | |
290 } | |
291 } | |
292 | |
293 /** | |
294 This is called in response to GET "/series/XXXXXXXXXXXXX/instances-tags" | |
295 */ | |
296 void OrthancSeriesVolumeProgressiveLoader::LoadGeometry(const OrthancRestApiCommand::SuccessMessage& message) | |
297 { | |
298 Json::Value body; | |
299 message.ParseJsonBody(body); | |
300 | |
301 if (body.type() != Json::objectValue) | |
302 { | |
303 throw Orthanc::OrthancException(Orthanc::ErrorCode_NetworkProtocol); | |
304 } | |
305 | |
306 { | |
307 Json::Value::Members instances = body.getMemberNames(); | |
308 | |
309 SlicesSorter slices; | |
310 | |
311 for (size_t i = 0; i < instances.size(); i++) | |
312 { | |
313 Orthanc::DicomMap dicom; | |
314 dicom.FromDicomAsJson(body[instances[i]]); | |
315 | |
316 std::auto_ptr<DicomInstanceParameters> instance(new DicomInstanceParameters(dicom)); | |
317 instance->SetOrthancInstanceIdentifier(instances[i]); | |
318 | |
319 // the 3D plane corresponding to the slice | |
320 CoordinateSystem3D geometry = instance->GetGeometry(); | |
321 slices.AddSlice(geometry, instance.release()); | |
322 } | |
323 | |
324 seriesGeometry_.ComputeGeometry(slices); | |
325 } | |
326 | |
327 size_t slicesCount = seriesGeometry_.GetImageGeometry().GetDepth(); | |
328 | |
329 if (slicesCount == 0) | |
330 { | |
331 volume_->Initialize(seriesGeometry_.GetImageGeometry(), Orthanc::PixelFormat_Grayscale8); | |
332 } | |
333 else | |
334 { | |
335 const DicomInstanceParameters& parameters = seriesGeometry_.GetSliceParameters(0); | |
336 | |
337 volume_->Initialize(seriesGeometry_.GetImageGeometry(), parameters.GetExpectedPixelFormat()); | |
338 volume_->SetDicomParameters(parameters); | |
339 volume_->GetPixelData().Clear(); | |
340 | |
341 strategy_.reset(new BasicFetchingStrategy(sorter_->CreateSorter(static_cast<unsigned int>(slicesCount)), BEST_QUALITY)); | |
342 | |
343 assert(simultaneousDownloads_ != 0); | |
344 for (unsigned int i = 0; i < simultaneousDownloads_; i++) | |
345 { | |
346 ScheduleNextSliceDownload(); | |
347 } | |
348 } | |
349 | |
350 slicesQuality_.resize(slicesCount, 0); | |
351 | |
352 BroadcastMessage(DicomVolumeImage::GeometryReadyMessage(*volume_)); | |
353 } | |
354 | |
355 | |
356 void OrthancSeriesVolumeProgressiveLoader::SetSliceContent(unsigned int sliceIndex, | |
357 const Orthanc::ImageAccessor& image, | |
358 unsigned int quality) | |
359 { | |
360 assert(sliceIndex < slicesQuality_.size() && | |
361 slicesQuality_.size() == volume_->GetPixelData().GetDepth()); | |
362 | |
363 if (quality >= slicesQuality_[sliceIndex]) | |
364 { | |
365 { | |
366 ImageBuffer3D::SliceWriter writer(volume_->GetPixelData(), VolumeProjection_Axial, sliceIndex); | |
367 Orthanc::ImageProcessing::Copy(writer.GetAccessor(), image); | |
368 } | |
369 | |
370 volume_->IncrementRevision(); | |
371 seriesGeometry_.IncrementSliceRevision(sliceIndex); | |
372 slicesQuality_[sliceIndex] = quality; | |
373 | |
374 BroadcastMessage(DicomVolumeImage::ContentUpdatedMessage(*volume_)); | |
375 } | |
376 | |
377 ScheduleNextSliceDownload(); | |
378 } | |
379 | |
380 | |
381 void OrthancSeriesVolumeProgressiveLoader::LoadBestQualitySliceContent(const GetOrthancImageCommand::SuccessMessage& message) | |
382 { | |
383 SetSliceContent(GetSliceIndexPayload(message.GetOrigin()), message.GetImage(), BEST_QUALITY); | |
384 } | |
385 | |
386 | |
387 void OrthancSeriesVolumeProgressiveLoader::LoadJpegSliceContent(const GetOrthancWebViewerJpegCommand::SuccessMessage& message) | |
388 { | |
389 unsigned int quality; | |
390 | |
391 switch (message.GetOrigin().GetQuality()) | |
392 { | |
393 case 50: | |
394 quality = LOW_QUALITY; | |
395 break; | |
396 | |
397 case 90: | |
398 quality = MIDDLE_QUALITY; | |
399 break; | |
400 | |
401 default: | |
402 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
403 } | |
404 | |
405 SetSliceContent(GetSliceIndexPayload(message.GetOrigin()), message.GetImage(), quality); | |
406 } | |
407 | |
408 | |
409 OrthancSeriesVolumeProgressiveLoader::OrthancSeriesVolumeProgressiveLoader(const boost::shared_ptr<DicomVolumeImage>& volume, | |
410 IOracle& oracle, | |
411 IObservable& oracleObservable) : | |
412 IObserver(oracleObservable.GetBroker()), | |
413 IObservable(oracleObservable.GetBroker()), | |
414 oracle_(oracle), | |
415 active_(false), | |
416 simultaneousDownloads_(4), | |
417 volume_(volume), | |
418 sorter_(new BasicFetchingItemsSorter::Factory) | |
419 { | |
420 oracleObservable.RegisterObserverCallback( | |
421 new Callable<OrthancSeriesVolumeProgressiveLoader, OrthancRestApiCommand::SuccessMessage> | |
422 (*this, &OrthancSeriesVolumeProgressiveLoader::LoadGeometry)); | |
423 | |
424 oracleObservable.RegisterObserverCallback( | |
425 new Callable<OrthancSeriesVolumeProgressiveLoader, GetOrthancImageCommand::SuccessMessage> | |
426 (*this, &OrthancSeriesVolumeProgressiveLoader::LoadBestQualitySliceContent)); | |
427 | |
428 oracleObservable.RegisterObserverCallback( | |
429 new Callable<OrthancSeriesVolumeProgressiveLoader, GetOrthancWebViewerJpegCommand::SuccessMessage> | |
430 (*this, &OrthancSeriesVolumeProgressiveLoader::LoadJpegSliceContent)); | |
431 } | |
432 | |
433 | |
434 void OrthancSeriesVolumeProgressiveLoader::SetSimultaneousDownloads(unsigned int count) | |
435 { | |
436 if (active_) | |
437 { | |
438 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
439 } | |
440 else if (count == 0) | |
441 { | |
442 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
443 } | |
444 else | |
445 { | |
446 simultaneousDownloads_ = count; | |
447 } | |
448 } | |
449 | |
450 | |
451 void OrthancSeriesVolumeProgressiveLoader::LoadSeries(const std::string& seriesId) | |
452 { | |
933
f75f6cb69c1b
Commented-out traces for debug
Benjamin Golinvaux <bgo@osimis.io>
parents:
913
diff
changeset
|
453 // LOG(TRACE) << "OrthancSeriesVolumeProgressiveLoader::LoadSeries seriesId=" << seriesId; |
814 | 454 if (active_) |
455 { | |
933
f75f6cb69c1b
Commented-out traces for debug
Benjamin Golinvaux <bgo@osimis.io>
parents:
913
diff
changeset
|
456 // LOG(TRACE) << "OrthancSeriesVolumeProgressiveLoader::LoadSeries NOT ACTIVE! --> ERROR"; |
814 | 457 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
458 } | |
459 else | |
460 { | |
461 active_ = true; | |
462 | |
463 std::auto_ptr<OrthancRestApiCommand> command(new OrthancRestApiCommand); | |
464 command->SetUri("/series/" + seriesId + "/instances-tags"); | |
465 | |
933
f75f6cb69c1b
Commented-out traces for debug
Benjamin Golinvaux <bgo@osimis.io>
parents:
913
diff
changeset
|
466 // LOG(TRACE) << "OrthancSeriesVolumeProgressiveLoader::LoadSeries about to call oracle_.Schedule"; |
814 | 467 oracle_.Schedule(*this, command.release()); |
933
f75f6cb69c1b
Commented-out traces for debug
Benjamin Golinvaux <bgo@osimis.io>
parents:
913
diff
changeset
|
468 // LOG(TRACE) << "OrthancSeriesVolumeProgressiveLoader::LoadSeries called oracle_.Schedule"; |
814 | 469 } |
470 } | |
471 | |
472 | |
473 IVolumeSlicer::IExtractedSlice* | |
474 OrthancSeriesVolumeProgressiveLoader::ExtractSlice(const CoordinateSystem3D& cuttingPlane) | |
475 { | |
476 if (volume_->HasGeometry()) | |
477 { | |
478 return new ExtractedSlice(*this, cuttingPlane); | |
479 } | |
480 else | |
481 { | |
482 return new IVolumeSlicer::InvalidSlice; | |
483 } | |
484 } | |
485 } |