/usr/include/dcmtk/dcmpmap/dpmmodparametricmapimage.h is in libdcmtk-dev 3.6.2-3build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | /*
*
* Copyright (C) 2016, Open Connections GmbH
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation are maintained by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmpmap
*
* Author: Jan Schlamelcher
*
* Purpose: Class for managing the Parametric Map Image Module
*
*/
#ifndef DPMMODPARAMETRICMAPIMAGE_H
#define DPMMODPARAMETRICMAPIMAGE_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofmem.h"
#include "dcmtk/dcmiod/iodrules.h"
#include "dcmtk/dcmiod/modbase.h"
#include "dcmtk/dcmpmap/dpmdef.h"
/** Class representing the Parametric Map Image Module:
*
* ImageType: (CS, 2-n, 1)
* SamplesPerPixel: (US, 1, 1)
* PhotometricInterpretation: (CS, 1, 1)
* BitsAllocated: (US, 1, 1)
* BitsStored: (US, 1, 1C)
* HighBit: (US, 1, 1C)
* PresentationLUTShape: (CS, 1, 1)
* LossyImageCompression: (CS, 1, 1)
* LossyImageCompressionRatio: (DS, 1-n, 1C)
* LossyImageCompressionMethod: (CS, 1-n, 1C)
* BurnedInAnnotation: (CS, 1, 1)
* RecognizableVisualFeatures: (CS, 1, 1)
* ContentQualification: (CS, 1, 1)
*/
class DCMTK_DCMPMAP_EXPORT DPMParametricMapImageModule : public IODModule
{
public:
/** Constructor
* @param item The item to be used for data storage. If NULL, the
* class creates an empty data container.
* @param rules The rule set for this class. If NULL, the class creates
* one from scratch and adds its values.
*/
DPMParametricMapImageModule(OFshared_ptr<DcmItem> item,
OFshared_ptr<IODRules> rules);
/** Constructor
*/
DPMParametricMapImageModule();
/** Destructor
*/
virtual ~DPMParametricMapImageModule();
/** Resets rules to their original values
*/
virtual void resetRules();
/** Get name of module ("DPMParametricMapImageModule")
* @return Name of the module ("DPMParametricMapImageModule")
*/
virtual OFString getName() const;
/** Read attributes from given item into this class
* @param source The source to read from
* @param clearOldData If OFTrue, old data is cleared before reading. Otherwise
* old data is overwritten (or amended)
* @result EC_Normal if reading was successful, error otherwise
*/
virtual OFCondition read(DcmItem& source,
const OFBool clearOldData = OFTrue);
/** Write attributes from this class into given item
* @param destination The item to write to
* @result EC_Normal if writing was successful, error otherwise
*/
virtual OFCondition write(DcmItem& destination);
/** Get Image Type
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getImageType(OFString &value,
const signed long pos = 0) const;
/** Get Samples Per Pixel
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getSamplesPerPixel(Uint16 &value,
const signed long pos = 0) const;
/** Get Photometric Interpretation
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getPhotometricInterpretation(OFString &value,
const signed long pos = 0) const;
/** Get Bits Allocated
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getBitsAllocated(Uint16 &value,
const signed long pos = 0) const;
/** Get Bits Stored
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getBitsStored(Uint16 &value,
const signed long pos = 0) const;
/** Get High Bit
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getHighBit(Uint16 &value,
const signed long pos = 0) const;
/** Get Presentation LUT Shape
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getPresentationLUTShape(OFString &value,
const signed long pos = 0) const;
/** Get Lossy Image Compression
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getLossyImageCompression(OFString &value,
const signed long pos = 0) const;
/** Get Lossy Image Compression Ratio
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getLossyImageCompressionRatio(OFString &value,
const signed long pos = 0) const;
/** Get Lossy Image Compression Method
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getLossyImageCompressionMethod(OFString &value,
const signed long pos = 0) const;
/** Get Burned In Annotation
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getBurnedInAnnotation(OFString &value,
const signed long pos = 0) const;
/** Get Recognizable Visual Features
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getRecognizableVisualFeatures(OFString &value,
const signed long pos = 0) const;
/** Get Content Qualification
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getContentQualification(OFString &value,
const signed long pos = 0) const;
/** Set Image Type
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (2-n) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setImageType(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Samples Per Pixel
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (US) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setSamplesPerPixel(const Uint16 &value,
const OFBool checkValue = OFTrue);
/** Set Photometric Interpretation
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setPhotometricInterpretation(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Bits Allocated
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (US) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setBitsAllocated(const Uint16 &value,
const OFBool checkValue = OFTrue);
/** Set Bits Stored
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (US) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setBitsStored(const Uint16 &value,
const OFBool checkValue = OFTrue);
/** Set High Bit
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (US) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setHighBit(const Uint16 &value,
const OFBool checkValue = OFTrue);
/** Set Presentation LUT Shape
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setPresentationLUTShape(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Lossy Image Compression
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setLossyImageCompression(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Lossy Image Compression Ratio
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (DS) and VM (1-n) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setLossyImageCompressionRatio(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Lossy Image Compression Method
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1-n) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setLossyImageCompressionMethod(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Burned In Annotation
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setBurnedInAnnotation(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set Recognizable Visual Features
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setRecognizableVisualFeatures(const OFString &value,
const OFBool checkValue = OFTrue);
/** Set ContentQualification
* @param value Value to be set (single value only) or "" for no value
* @param checkValue Check 'value' for conformance with VR (CS) and VM (1) if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setContentQualification(const OFString &value,
const OFBool checkValue = OFTrue);
private:
/// The name of this module ("DPMParametricMapImageModule")
static const OFString m_ModuleName;
};
#endif // DPMMODPARAMETRICMAPIMAGE_H
|