Mercurial > hg > orthanc-wsi
annotate Framework/Algorithms/PyramidReader.cpp @ 334:f011fc199b6a default tip
back to mainline
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 18 Oct 2024 15:44:18 +0200 |
| parents | 8ad12abde290 |
| children |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
|
312
0683312e21ba
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
309
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
|
0683312e21ba
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
309
diff
changeset
|
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
309
7020852a8fa9
updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 8 * |
| 9 * This program is free software: you can redistribute it and/or | |
| 10 * modify it under the terms of the GNU Affero General Public License | |
| 11 * as published by the Free Software Foundation, either version 3 of | |
| 12 * the License, or (at your option) any later version. | |
| 13 * | |
| 14 * This program is distributed in the hope that it will be useful, but | |
| 15 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 17 * Affero General Public License for more details. | |
| 18 * | |
| 19 * You should have received a copy of the GNU Affero General Public License | |
| 20 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 21 **/ | |
| 22 | |
| 23 | |
|
16
7a88c614be04
preparing for precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
24 #include "../PrecompiledHeadersWSI.h" |
| 0 | 25 #include "PyramidReader.h" |
| 26 | |
| 27 #include "../ImageToolbox.h" | |
|
199
a1c265cb2174
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
192
diff
changeset
|
28 |
|
a1c265cb2174
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
192
diff
changeset
|
29 #include <Compatibility.h> // For std::unique_ptr |
| 192 | 30 #include <Logging.h> |
| 31 #include <OrthancException.h> | |
| 0 | 32 |
| 33 #include <cassert> | |
| 34 | |
| 35 namespace OrthancWSI | |
| 36 { | |
| 37 class PyramidReader::SourceTile : public boost::noncopyable | |
| 38 { | |
| 39 private: | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
40 PyramidReader& that_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
41 unsigned int tileX_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
42 unsigned int tileY_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
43 bool hasRawTile_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
44 std::string rawTile_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
45 ImageCompression rawTileCompression_; |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
46 bool isEmpty_; |
| 0 | 47 |
|
199
a1c265cb2174
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
192
diff
changeset
|
48 std::unique_ptr<Orthanc::ImageAccessor> decoded_; |
| 0 | 49 |
| 50 bool IsRepaintNeeded() const | |
| 51 { | |
| 52 return (that_.parameters_.IsRepaintBackground() && | |
| 53 ((tileX_ + 1) * that_.sourceTileWidth_ > that_.levelWidth_ || | |
| 54 (tileY_ + 1) * that_.sourceTileHeight_ > that_.levelHeight_)); | |
| 55 } | |
| 56 | |
| 57 void RepaintBackground() | |
| 58 { | |
| 59 assert(decoded_.get() != NULL); | |
| 60 LOG(INFO) << "Repainting background of tile (" | |
| 61 << tileX_ << "," << tileY_ << ") at level " << that_.level_; | |
| 62 | |
| 63 if ((tileY_ + 1) * that_.sourceTileHeight_ > that_.levelHeight_) | |
| 64 { | |
| 65 // Bottom overflow | |
| 66 assert(tileY_ * that_.sourceTileHeight_ < that_.levelHeight_); | |
| 67 | |
| 68 unsigned int bottom = that_.levelHeight_ - tileY_ * that_.sourceTileHeight_; | |
| 154 | 69 Orthanc::ImageAccessor a; |
| 70 decoded_->GetRegion(a, 0, bottom, | |
| 71 that_.sourceTileWidth_, | |
| 72 that_.sourceTileHeight_ - bottom); | |
| 0 | 73 ImageToolbox::Set(a, |
| 74 that_.parameters_.GetBackgroundColorRed(), | |
| 75 that_.parameters_.GetBackgroundColorGreen(), | |
| 76 that_.parameters_.GetBackgroundColorBlue()); | |
| 77 | |
| 78 } | |
| 79 | |
| 80 if ((tileX_ + 1) * that_.sourceTileWidth_ > that_.levelWidth_) | |
| 81 { | |
| 82 // Right overflow | |
| 83 assert(tileX_ * that_.sourceTileWidth_ < that_.levelWidth_); | |
| 84 | |
| 85 unsigned int right = that_.levelWidth_ - tileX_ * that_.sourceTileWidth_; | |
| 154 | 86 Orthanc::ImageAccessor a; |
| 87 decoded_->GetRegion(a, right, 0, | |
| 88 that_.sourceTileWidth_ - right, | |
| 89 that_.sourceTileHeight_); | |
| 0 | 90 ImageToolbox::Set(a, |
| 91 that_.parameters_.GetBackgroundColorRed(), | |
| 92 that_.parameters_.GetBackgroundColorGreen(), | |
| 93 that_.parameters_.GetBackgroundColorBlue()); | |
| 94 } | |
| 95 } | |
| 96 | |
| 97 | |
| 98 public: | |
| 99 SourceTile(PyramidReader& that, | |
| 100 unsigned int tileX, | |
| 101 unsigned int tileY) : | |
| 102 that_(that), | |
| 103 tileX_(tileX), | |
| 104 tileY_(tileY) | |
| 105 { | |
| 106 if (!that_.parameters_.IsForceReencode() && | |
| 107 !IsRepaintNeeded() && | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
108 that_.source_.ReadRawTile(rawTile_, rawTileCompression_, that_.level_, tileX, tileY)) |
| 0 | 109 { |
| 110 hasRawTile_ = true; | |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
111 isEmpty_ = false; |
| 0 | 112 } |
| 113 else | |
| 114 { | |
| 115 hasRawTile_ = false; | |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
116 |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
117 decoded_.reset(that_.source_.DecodeTile(isEmpty_, that_.level_, tileX, tileY)); |
| 0 | 118 if (decoded_.get() == NULL) |
| 119 { | |
| 120 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 121 } | |
| 122 | |
| 123 RepaintBackground(); | |
| 124 } | |
| 125 } | |
| 126 | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
127 bool HasRawTile(ImageCompression& compression) const |
| 0 | 128 { |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
129 if (hasRawTile_) |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
130 { |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
131 compression = rawTileCompression_; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
132 return true; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
133 } |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
134 else |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
135 { |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
136 return false; |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
137 } |
| 0 | 138 } |
| 139 | |
| 140 const std::string& GetRawTile() const | |
| 141 { | |
| 142 if (hasRawTile_) | |
| 143 { | |
| 144 return rawTile_; | |
| 145 } | |
| 146 else | |
| 147 { | |
| 148 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 149 } | |
| 150 } | |
| 151 | |
| 152 const Orthanc::ImageAccessor& GetDecodedTile() | |
| 153 { | |
| 154 if (decoded_.get() == NULL) | |
| 155 { | |
| 156 if (!hasRawTile_) | |
| 157 { | |
| 158 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 159 } | |
| 160 | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
161 decoded_.reset(ImageToolbox::DecodeTile(rawTile_, rawTileCompression_)); |
| 0 | 162 if (decoded_.get() == NULL) |
| 163 { | |
| 164 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
| 165 } | |
| 166 | |
| 167 RepaintBackground(); | |
| 168 } | |
| 169 | |
| 170 return *decoded_; | |
| 171 } | |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
172 |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
173 bool IsEmpty() const |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
174 { |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
175 return isEmpty_; |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
176 } |
| 0 | 177 }; |
| 178 | |
| 179 | |
| 180 Orthanc::ImageAccessor& PyramidReader::GetOutsideTile() | |
| 181 { | |
| 182 if (outside_.get() == NULL) | |
| 183 { | |
| 184 outside_.reset(ImageToolbox::Allocate(source_.GetPixelFormat(), targetTileWidth_, targetTileHeight_)); | |
| 185 ImageToolbox::Set(*outside_, | |
| 186 parameters_.GetBackgroundColorRed(), | |
| 187 parameters_.GetBackgroundColorGreen(), | |
| 188 parameters_.GetBackgroundColorBlue()); | |
| 189 } | |
| 190 | |
| 191 return *outside_; | |
| 192 } | |
| 193 | |
| 194 | |
| 195 void PyramidReader::CheckTileSize(const Orthanc::ImageAccessor& tile) const | |
| 196 { | |
| 197 if (tile.GetWidth() != sourceTileWidth_ || | |
| 198 tile.GetHeight() != sourceTileHeight_) | |
| 199 { | |
| 200 LOG(ERROR) << "One tile in the input image has size " << tile.GetWidth() << "x" << tile.GetHeight() | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
201 << " instead of required " << sourceTileWidth_ << "x" << sourceTileHeight_; |
| 0 | 202 throw Orthanc::OrthancException(Orthanc::ErrorCode_IncompatibleImageSize); |
| 203 } | |
| 204 } | |
| 205 | |
| 206 | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
207 void PyramidReader::CheckTileSize(const std::string& tile, |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
208 ImageCompression compression) const |
| 0 | 209 { |
| 210 if (parameters_.IsSafetyCheck()) | |
| 211 { | |
|
199
a1c265cb2174
replacing deprecated std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
192
diff
changeset
|
212 std::unique_ptr<Orthanc::ImageAccessor> decoded(ImageToolbox::DecodeTile(tile, compression)); |
| 0 | 213 CheckTileSize(*decoded); |
| 214 } | |
| 215 } | |
| 216 | |
| 217 | |
| 218 PyramidReader::SourceTile& PyramidReader::AccessSourceTile(const Location& location) | |
| 219 { | |
| 220 Cache::iterator found = cache_.find(location); | |
| 221 if (found != cache_.end()) | |
| 222 { | |
| 223 return *found->second; | |
| 224 } | |
| 225 else | |
| 226 { | |
| 227 SourceTile *tile = new SourceTile(*this, location.first, location.second); | |
| 228 cache_[location] = tile; | |
| 229 return *tile; | |
| 230 } | |
| 231 } | |
| 232 | |
| 233 | |
| 234 PyramidReader::Location PyramidReader::MapTargetToSourceLocation(unsigned int tileX, | |
| 235 unsigned int tileY) | |
| 236 { | |
| 237 return std::make_pair(tileX / (sourceTileWidth_ / targetTileWidth_), | |
| 238 tileY / (sourceTileHeight_ / targetTileHeight_)); | |
| 239 } | |
| 240 | |
| 241 | |
| 242 PyramidReader::PyramidReader(ITiledPyramid& source, | |
| 243 unsigned int level, | |
| 244 unsigned int targetTileWidth, | |
| 245 unsigned int targetTileHeight, | |
| 246 const DicomizerParameters& parameters) : | |
| 247 source_(source), | |
| 248 level_(level), | |
| 249 levelWidth_(source.GetLevelWidth(level)), | |
| 250 levelHeight_(source.GetLevelHeight(level)), | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
251 sourceTileWidth_(source.GetTileWidth(level)), |
|
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
252 sourceTileHeight_(source.GetTileHeight(level)), |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
253 targetTileWidth_(targetTileWidth), |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
254 targetTileHeight_(targetTileHeight), |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
255 parameters_(parameters) |
| 0 | 256 { |
| 257 if (sourceTileWidth_ % targetTileWidth_ != 0 || | |
| 258 sourceTileHeight_ % targetTileHeight_ != 0) | |
| 259 { | |
| 260 LOG(ERROR) << "When resampling the tile size, it must be a integer divisor of the original tile size"; | |
| 261 throw Orthanc::OrthancException(Orthanc::ErrorCode_IncompatibleImageSize); | |
| 262 } | |
| 263 } | |
| 264 | |
| 265 | |
| 266 PyramidReader::~PyramidReader() | |
| 267 { | |
| 268 for (Cache::iterator it = cache_.begin(); it != cache_.end(); ++it) | |
| 269 { | |
| 270 assert(it->second != NULL); | |
| 271 delete it->second; | |
| 272 } | |
| 273 } | |
| 274 | |
| 275 | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
276 const std::string* PyramidReader::GetRawTile(ImageCompression& compression, |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
277 unsigned int tileX, |
| 0 | 278 unsigned int tileY) |
| 279 { | |
| 280 if (sourceTileWidth_ != targetTileWidth_ || | |
| 281 sourceTileHeight_ != targetTileHeight_) | |
| 282 { | |
| 283 return NULL; | |
| 284 } | |
| 285 | |
| 286 SourceTile& source = AccessSourceTile(MapTargetToSourceLocation(tileX, tileY)); | |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
287 |
|
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
288 if (source.HasRawTile(compression)) |
| 0 | 289 { |
|
57
91fc9583b2de
big refactoring to support sparse tiling
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
290 CheckTileSize(source.GetRawTile(), compression); |
| 0 | 291 return &source.GetRawTile(); |
| 292 } | |
| 293 else | |
| 294 { | |
| 295 return NULL; | |
| 296 } | |
| 297 } | |
| 298 | |
| 299 | |
| 154 | 300 void PyramidReader::GetDecodedTile(Orthanc::ImageAccessor& target, |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
301 bool& isEmpty, |
| 154 | 302 unsigned int tileX, |
| 303 unsigned int tileY) | |
| 0 | 304 { |
| 305 if (tileX * targetTileWidth_ >= levelWidth_ || | |
| 306 tileY * targetTileHeight_ >= levelHeight_) | |
| 307 { | |
| 308 // Accessing a tile out of the source image | |
| 154 | 309 GetOutsideTile().GetReadOnlyAccessor(target); |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
310 isEmpty = true; |
| 0 | 311 } |
| 154 | 312 else |
| 313 { | |
| 314 SourceTile& source = AccessSourceTile(MapTargetToSourceLocation(tileX, tileY)); | |
| 315 const Orthanc::ImageAccessor& tile = source.GetDecodedTile(); | |
| 0 | 316 |
| 154 | 317 CheckTileSize(tile); |
| 0 | 318 |
| 154 | 319 assert(sourceTileWidth_ % targetTileWidth_ == 0 && |
| 320 sourceTileHeight_ % targetTileHeight_ == 0); | |
| 0 | 321 |
| 154 | 322 unsigned int xx = tileX % (sourceTileWidth_ / targetTileWidth_); |
| 323 unsigned int yy = tileY % (sourceTileHeight_ / targetTileHeight_); | |
| 0 | 324 |
| 154 | 325 const uint8_t* bytes = |
| 326 reinterpret_cast<const uint8_t*>(tile.GetConstRow(yy * targetTileHeight_)) + | |
| 327 GetBytesPerPixel(tile.GetFormat()) * xx * targetTileWidth_; | |
| 0 | 328 |
| 154 | 329 target.AssignReadOnly(tile.GetFormat(), |
| 330 targetTileWidth_, | |
| 331 targetTileHeight_, | |
|
318
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
332 tile.GetPitch(), bytes); |
|
8ad12abde290
sparse re-encoding with OpenSlide (notably for MIRAX format)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
333 isEmpty = source.IsEmpty(); |
| 154 | 334 } |
| 0 | 335 } |
| 336 } |