Mercurial > hg > orthanc-wsi
annotate Framework/DicomizerParameters.h @ 334:f011fc199b6a default tip
back to mainline
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 18 Oct 2024 15:44:18 +0200 |
| parents | a92bb720f90b |
| 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:
298
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 | |
| 24 #pragma once | |
| 25 | |
| 26 #include "Inputs/ITiledPyramid.h" | |
| 27 #include "Outputs/IPyramidWriter.h" | |
|
61
147bd6dc28db
refactoring using new items in the plugin toolbox of Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
59
diff
changeset
|
28 #include "Targets/IFileTarget.h" |
| 0 | 29 #include "DicomToolbox.h" |
| 192 | 30 #include <WebServiceParameters.h> |
| 0 | 31 |
| 32 #include <stdint.h> | |
| 33 | |
| 34 namespace OrthancWSI | |
| 35 { | |
| 36 class DicomizerParameters | |
| 37 { | |
| 38 private: | |
| 39 bool safetyCheck_; | |
| 40 bool repaintBackground_; | |
| 41 uint8_t backgroundColor_[3]; | |
| 42 ImageCompression targetCompression_; | |
| 43 bool hasTargetTileSize_; | |
| 44 unsigned int targetTileWidth_; | |
| 45 unsigned int targetTileHeight_; | |
| 46 unsigned int threadsCount_; | |
| 47 unsigned int maxDicomFileSize_; | |
| 48 bool reconstructPyramid_; | |
| 49 unsigned int pyramidLevelsCount_; // "0" means use default choice | |
| 50 unsigned int pyramidLowerLevelsCount_; // "0" means use default choice | |
| 51 bool smooth_; | |
| 52 std::string inputFile_; | |
| 53 uint8_t jpegQuality_; | |
| 54 bool forceReencode_; | |
| 55 std::string folder_; | |
| 56 std::string folderPattern_; | |
| 57 std::string dataset_; | |
| 58 OpticalPath opticalPath_; | |
| 59 std::string iccProfile_; | |
| 60 | |
| 61 Orthanc::WebServiceParameters orthanc_; | |
| 62 | |
|
244
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
63 // New in release 1.1 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
64 bool isCytomineSource_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
65 Orthanc::WebServiceParameters cytomineServer_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
66 int cytomineImageInstanceId_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
67 std::string cytominePublicKey_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
68 std::string cytominePrivateKey_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
69 ImageCompression cytomineCompression_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
70 |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
71 // New in release 2.1 |
|
323
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
72 bool forceOpenSlide_; |
|
324
a92bb720f90b
renamed option --tiff-alignment as --padding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
323
diff
changeset
|
73 unsigned int padding_; |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
74 |
| 0 | 75 public: |
| 76 DicomizerParameters(); | |
| 77 | |
| 78 void SetSafetyCheck(bool safety) | |
| 79 { | |
| 80 safetyCheck_ = safety; | |
| 81 } | |
| 82 | |
| 83 bool IsSafetyCheck() const | |
| 84 { | |
| 85 return safetyCheck_; | |
| 86 } | |
| 87 | |
| 88 bool IsRepaintBackground() const | |
| 89 { | |
| 90 return repaintBackground_; | |
| 91 } | |
| 92 | |
| 93 void SetRepaintBackground(bool repaint) | |
| 94 { | |
| 95 repaintBackground_ = repaint; | |
| 96 } | |
| 97 | |
| 98 void SetBackgroundColor(uint8_t red, | |
| 99 uint8_t green, | |
| 100 uint8_t blue); | |
| 101 | |
| 102 uint8_t GetBackgroundColorRed() const | |
| 103 { | |
| 104 return backgroundColor_[0]; | |
| 105 } | |
| 106 | |
| 107 uint8_t GetBackgroundColorGreen() const | |
| 108 { | |
| 109 return backgroundColor_[1]; | |
| 110 } | |
| 111 | |
| 112 uint8_t GetBackgroundColorBlue() const | |
| 113 { | |
| 114 return backgroundColor_[2]; | |
| 115 } | |
| 116 | |
| 117 void SetTargetCompression(ImageCompression compression) | |
| 118 { | |
| 119 targetCompression_ = compression; | |
| 120 } | |
| 121 | |
| 122 ImageCompression GetTargetCompression() const | |
| 123 { | |
| 124 return targetCompression_; | |
| 125 } | |
| 126 | |
| 127 void SetTargetTileSize(unsigned int width, | |
| 128 unsigned int height); | |
| 129 | |
| 130 unsigned int GetTargetTileWidth(unsigned int defaultWidth) const; | |
| 131 | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
132 unsigned int GetTargetTileWidth(const ITiledPyramid& source) const; |
| 0 | 133 |
| 134 unsigned int GetTargetTileHeight(unsigned int defaultHeight) const; | |
| 135 | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
136 unsigned int GetTargetTileHeight(const ITiledPyramid& source) const; |
| 0 | 137 |
| 138 void SetThreadsCount(unsigned int threads); | |
| 139 | |
| 140 unsigned int GetThreadsCount() const | |
| 141 { | |
| 142 return threadsCount_; | |
| 143 } | |
| 144 | |
| 145 void SetDicomMaxFileSize(unsigned int size); | |
| 146 | |
| 147 unsigned int GetDicomMaxFileSize() const | |
| 148 { | |
| 149 return maxDicomFileSize_; | |
| 150 } | |
| 151 | |
| 152 bool IsReconstructPyramid() const | |
| 153 { | |
| 154 return reconstructPyramid_; | |
| 155 } | |
| 156 | |
| 157 void SetReconstructPyramid(bool reconstruct) | |
| 158 { | |
| 159 reconstructPyramid_ = reconstruct; | |
| 160 } | |
| 161 | |
| 162 void SetPyramidLevelsCount(unsigned int count); | |
| 163 | |
| 164 unsigned int GetPyramidLevelsCount(const IPyramidWriter& target, | |
| 165 const ITiledPyramid& source) const; | |
| 166 | |
| 167 void SetPyramidLowerLevelsCount(unsigned int count); | |
| 168 | |
| 169 unsigned int GetPyramidLowerLevelsCount(const IPyramidWriter& target, | |
| 170 const ITiledPyramid& source) const; | |
| 171 | |
| 172 void SetSmoothEnabled(bool smooth) | |
| 173 { | |
| 174 smooth_ = smooth; | |
| 175 } | |
| 176 | |
| 177 bool IsSmoothEnabled() const | |
| 178 { | |
| 179 return smooth_; | |
| 180 } | |
| 181 | |
| 182 void SetInputFile(const std::string& path) | |
| 183 { | |
| 184 inputFile_ = path; | |
| 185 } | |
| 186 | |
| 187 const std::string& GetInputFile() const | |
| 188 { | |
| 189 return inputFile_; | |
| 190 } | |
| 191 | |
| 192 void SetJpegQuality(int quality); | |
| 193 | |
| 194 uint8_t GetJpegQuality() const | |
| 195 { | |
| 196 return jpegQuality_; | |
| 197 } | |
| 198 | |
| 199 void SetForceReencode(bool force) | |
| 200 { | |
| 201 forceReencode_ = force; | |
| 202 } | |
| 203 | |
| 204 bool IsForceReencode() const | |
| 205 { | |
| 206 return forceReencode_; | |
| 207 } | |
| 208 | |
| 209 void SetTargetFolder(const std::string& folder) | |
| 210 { | |
| 211 folder_ = folder; | |
| 212 } | |
| 213 | |
| 214 const std::string& GetTargetFolderPattern() const | |
| 215 { | |
| 216 return folderPattern_; | |
| 217 } | |
| 218 | |
| 219 void SetTargetFolderPattern(const std::string& pattern) | |
| 220 { | |
| 221 folderPattern_ = pattern; | |
| 222 } | |
| 223 | |
| 224 Orthanc::WebServiceParameters& GetOrthancParameters() | |
| 225 { | |
| 226 return orthanc_; | |
| 227 } | |
| 228 | |
| 229 const Orthanc::WebServiceParameters& GetOrthancParameters() const | |
| 230 { | |
| 231 return orthanc_; | |
| 232 } | |
| 233 | |
| 234 IFileTarget* CreateTarget() const; | |
| 235 | |
| 236 void SetDatasetPath(const std::string& path) | |
| 237 { | |
| 238 dataset_ = path; | |
| 239 } | |
| 240 | |
| 241 const std::string& GetDatasetPath() const | |
| 242 { | |
| 243 return dataset_; | |
| 244 } | |
| 245 | |
| 246 void SetOpticalPath(OpticalPath opticalPath) | |
| 247 { | |
| 248 opticalPath_ = opticalPath; | |
| 249 } | |
| 250 | |
| 251 OpticalPath GetOpticalPath() const | |
| 252 { | |
| 253 return opticalPath_; | |
| 254 } | |
| 255 | |
| 256 void SetIccProfilePath(const std::string& path) | |
| 257 { | |
| 258 iccProfile_ = path; | |
| 259 } | |
| 260 | |
| 261 const std::string& GetIccProfilePath() const | |
| 262 { | |
| 263 return iccProfile_; | |
| 264 } | |
|
244
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
265 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
266 void SetCytomineSource(const std::string& url, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
267 const std::string& publicKey, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
268 const std::string& privateKey, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
269 int imageInstanceId, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
270 ImageCompression compression); |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
271 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
272 bool IsCytomineSource() const |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
273 { |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
274 return isCytomineSource_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
275 } |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
276 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
277 const Orthanc::WebServiceParameters& GetCytomineServer() const; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
278 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
279 const std::string& GetCytominePublicKey() const; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
280 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
281 const std::string& GetCytominePrivateKey() const; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
282 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
283 int GetCytomineImageInstanceId() const; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
284 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
285 ImageCompression GetCytomineCompression() const; |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
286 |
|
324
a92bb720f90b
renamed option --tiff-alignment as --padding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
323
diff
changeset
|
287 void SetPadding(unsigned int padding); |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
288 |
|
324
a92bb720f90b
renamed option --tiff-alignment as --padding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
323
diff
changeset
|
289 unsigned int GetPadding() const |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
290 { |
|
324
a92bb720f90b
renamed option --tiff-alignment as --padding
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
323
diff
changeset
|
291 return padding_; |
|
298
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
292 } |
|
323
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
293 |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
294 void SetForceOpenSlide(bool force) |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
295 { |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
296 forceOpenSlide_ = force; |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
297 } |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
298 |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
299 bool IsForceOpenSlide() const |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
300 { |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
301 return forceOpenSlide_; |
|
429c4efa1fde
added option --force-openslide
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
312
diff
changeset
|
302 } |
| 0 | 303 }; |
| 304 } |