Mercurial > hg > orthanc-wsi
annotate Framework/DicomizerParameters.h @ 311:4315bd3bffa7
added CITATION.cff
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Sat, 06 Apr 2024 17:39:24 +0200 |
| parents | 7020852a8fa9 |
| children | 0683312e21ba |
| 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 | |
|
309
7020852a8fa9
updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
298
diff
changeset
|
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
|
7020852a8fa9
updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
298
diff
changeset
|
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 7 * |
| 8 * This program is free software: you can redistribute it and/or | |
| 9 * modify it under the terms of the GNU Affero General Public License | |
| 10 * as published by the Free Software Foundation, either version 3 of | |
| 11 * the License, or (at your option) any later version. | |
| 12 * | |
| 13 * This program is distributed in the hope that it will be useful, but | |
| 14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 16 * Affero General Public License for more details. | |
| 17 * | |
| 18 * You should have received a copy of the GNU Affero General Public License | |
| 19 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 20 **/ | |
| 21 | |
| 22 | |
| 23 #pragma once | |
| 24 | |
| 25 #include "Inputs/ITiledPyramid.h" | |
| 26 #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
|
27 #include "Targets/IFileTarget.h" |
| 0 | 28 #include "DicomToolbox.h" |
| 192 | 29 #include <WebServiceParameters.h> |
| 0 | 30 |
| 31 #include <stdint.h> | |
| 32 | |
| 33 namespace OrthancWSI | |
| 34 { | |
| 35 class DicomizerParameters | |
| 36 { | |
| 37 private: | |
| 38 bool safetyCheck_; | |
| 39 bool repaintBackground_; | |
| 40 uint8_t backgroundColor_[3]; | |
| 41 ImageCompression targetCompression_; | |
| 42 bool hasTargetTileSize_; | |
| 43 unsigned int targetTileWidth_; | |
| 44 unsigned int targetTileHeight_; | |
| 45 unsigned int threadsCount_; | |
| 46 unsigned int maxDicomFileSize_; | |
| 47 bool reconstructPyramid_; | |
| 48 unsigned int pyramidLevelsCount_; // "0" means use default choice | |
| 49 unsigned int pyramidLowerLevelsCount_; // "0" means use default choice | |
| 50 bool smooth_; | |
| 51 std::string inputFile_; | |
| 52 uint8_t jpegQuality_; | |
| 53 bool forceReencode_; | |
| 54 std::string folder_; | |
| 55 std::string folderPattern_; | |
| 56 std::string dataset_; | |
| 57 OpticalPath opticalPath_; | |
| 58 std::string iccProfile_; | |
| 59 | |
| 60 Orthanc::WebServiceParameters orthanc_; | |
| 61 | |
|
244
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
62 // New in release 1.1 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
63 bool isCytomineSource_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
64 Orthanc::WebServiceParameters cytomineServer_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
65 int cytomineImageInstanceId_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
66 std::string cytominePublicKey_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
67 std::string cytominePrivateKey_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
68 ImageCompression cytomineCompression_; |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
69 |
|
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
|
70 // New in release 2.1 |
|
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 unsigned int tiffAlignment_; |
|
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
72 |
| 0 | 73 public: |
| 74 DicomizerParameters(); | |
| 75 | |
| 76 void SetSafetyCheck(bool safety) | |
| 77 { | |
| 78 safetyCheck_ = safety; | |
| 79 } | |
| 80 | |
| 81 bool IsSafetyCheck() const | |
| 82 { | |
| 83 return safetyCheck_; | |
| 84 } | |
| 85 | |
| 86 bool IsRepaintBackground() const | |
| 87 { | |
| 88 return repaintBackground_; | |
| 89 } | |
| 90 | |
| 91 void SetRepaintBackground(bool repaint) | |
| 92 { | |
| 93 repaintBackground_ = repaint; | |
| 94 } | |
| 95 | |
| 96 void SetBackgroundColor(uint8_t red, | |
| 97 uint8_t green, | |
| 98 uint8_t blue); | |
| 99 | |
| 100 uint8_t GetBackgroundColorRed() const | |
| 101 { | |
| 102 return backgroundColor_[0]; | |
| 103 } | |
| 104 | |
| 105 uint8_t GetBackgroundColorGreen() const | |
| 106 { | |
| 107 return backgroundColor_[1]; | |
| 108 } | |
| 109 | |
| 110 uint8_t GetBackgroundColorBlue() const | |
| 111 { | |
| 112 return backgroundColor_[2]; | |
| 113 } | |
| 114 | |
| 115 void SetTargetCompression(ImageCompression compression) | |
| 116 { | |
| 117 targetCompression_ = compression; | |
| 118 } | |
| 119 | |
| 120 ImageCompression GetTargetCompression() const | |
| 121 { | |
| 122 return targetCompression_; | |
| 123 } | |
| 124 | |
| 125 void SetTargetTileSize(unsigned int width, | |
| 126 unsigned int height); | |
| 127 | |
| 128 unsigned int GetTargetTileWidth(unsigned int defaultWidth) const; | |
| 129 | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
130 unsigned int GetTargetTileWidth(const ITiledPyramid& source) const; |
| 0 | 131 |
| 132 unsigned int GetTargetTileHeight(unsigned int defaultHeight) const; | |
| 133 | |
|
217
20bc074ec19a
Viewer can display DICOM pyramids whose tile sizes vary across levels
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
214
diff
changeset
|
134 unsigned int GetTargetTileHeight(const ITiledPyramid& source) const; |
| 0 | 135 |
| 136 void SetThreadsCount(unsigned int threads); | |
| 137 | |
| 138 unsigned int GetThreadsCount() const | |
| 139 { | |
| 140 return threadsCount_; | |
| 141 } | |
| 142 | |
| 143 void SetDicomMaxFileSize(unsigned int size); | |
| 144 | |
| 145 unsigned int GetDicomMaxFileSize() const | |
| 146 { | |
| 147 return maxDicomFileSize_; | |
| 148 } | |
| 149 | |
| 150 bool IsReconstructPyramid() const | |
| 151 { | |
| 152 return reconstructPyramid_; | |
| 153 } | |
| 154 | |
| 155 void SetReconstructPyramid(bool reconstruct) | |
| 156 { | |
| 157 reconstructPyramid_ = reconstruct; | |
| 158 } | |
| 159 | |
| 160 void SetPyramidLevelsCount(unsigned int count); | |
| 161 | |
| 162 unsigned int GetPyramidLevelsCount(const IPyramidWriter& target, | |
| 163 const ITiledPyramid& source) const; | |
| 164 | |
| 165 void SetPyramidLowerLevelsCount(unsigned int count); | |
| 166 | |
| 167 unsigned int GetPyramidLowerLevelsCount(const IPyramidWriter& target, | |
| 168 const ITiledPyramid& source) const; | |
| 169 | |
| 170 void SetSmoothEnabled(bool smooth) | |
| 171 { | |
| 172 smooth_ = smooth; | |
| 173 } | |
| 174 | |
| 175 bool IsSmoothEnabled() const | |
| 176 { | |
| 177 return smooth_; | |
| 178 } | |
| 179 | |
| 180 void SetInputFile(const std::string& path) | |
| 181 { | |
| 182 inputFile_ = path; | |
| 183 } | |
| 184 | |
| 185 const std::string& GetInputFile() const | |
| 186 { | |
| 187 return inputFile_; | |
| 188 } | |
| 189 | |
| 190 void SetJpegQuality(int quality); | |
| 191 | |
| 192 uint8_t GetJpegQuality() const | |
| 193 { | |
| 194 return jpegQuality_; | |
| 195 } | |
| 196 | |
| 197 void SetForceReencode(bool force) | |
| 198 { | |
| 199 forceReencode_ = force; | |
| 200 } | |
| 201 | |
| 202 bool IsForceReencode() const | |
| 203 { | |
| 204 return forceReencode_; | |
| 205 } | |
| 206 | |
| 207 void SetTargetFolder(const std::string& folder) | |
| 208 { | |
| 209 folder_ = folder; | |
| 210 } | |
| 211 | |
| 212 const std::string& GetTargetFolderPattern() const | |
| 213 { | |
| 214 return folderPattern_; | |
| 215 } | |
| 216 | |
| 217 void SetTargetFolderPattern(const std::string& pattern) | |
| 218 { | |
| 219 folderPattern_ = pattern; | |
| 220 } | |
| 221 | |
| 222 Orthanc::WebServiceParameters& GetOrthancParameters() | |
| 223 { | |
| 224 return orthanc_; | |
| 225 } | |
| 226 | |
| 227 const Orthanc::WebServiceParameters& GetOrthancParameters() const | |
| 228 { | |
| 229 return orthanc_; | |
| 230 } | |
| 231 | |
| 232 IFileTarget* CreateTarget() const; | |
| 233 | |
| 234 void SetDatasetPath(const std::string& path) | |
| 235 { | |
| 236 dataset_ = path; | |
| 237 } | |
| 238 | |
| 239 const std::string& GetDatasetPath() const | |
| 240 { | |
| 241 return dataset_; | |
| 242 } | |
| 243 | |
| 244 void SetOpticalPath(OpticalPath opticalPath) | |
| 245 { | |
| 246 opticalPath_ = opticalPath; | |
| 247 } | |
| 248 | |
| 249 OpticalPath GetOpticalPath() const | |
| 250 { | |
| 251 return opticalPath_; | |
| 252 } | |
| 253 | |
| 254 void SetIccProfilePath(const std::string& path) | |
| 255 { | |
| 256 iccProfile_ = path; | |
| 257 } | |
| 258 | |
| 259 const std::string& GetIccProfilePath() const | |
| 260 { | |
| 261 return iccProfile_; | |
| 262 } | |
|
244
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
263 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
264 void SetCytomineSource(const std::string& url, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
265 const std::string& publicKey, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
266 const std::string& privateKey, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
267 int imageInstanceId, |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
268 ImageCompression compression); |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
269 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
270 bool IsCytomineSource() const |
|
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 return isCytomineSource_; |
|
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 |
|
4273518c2009
OrthancWSIDicomizer: Support importing of images from Cytomine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
242
diff
changeset
|
275 const Orthanc::WebServiceParameters& GetCytomineServer() const; |
|
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 std::string& GetCytominePublicKey() 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& GetCytominePrivateKey() 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 int GetCytomineImageInstanceId() 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 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
|
284 |
|
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
285 void SetTiffAlignment(unsigned int alignment); |
|
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 |
|
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
287 unsigned int GetTiffAlignment() const |
|
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 { |
|
fa734a851551
New option: "tiff-alignment" to control deep zoom of plain TIFF over IIIF
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
254
diff
changeset
|
289 return tiffAlignment_; |
|
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 } |
| 0 | 291 }; |
| 292 } |