/usr/include/dcmtk/dcmiod/modimagepixel.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 | /*
*
* Copyright (C) 2015-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: dcmiod
*
* Author: Michael Onken
*
* Purpose: Class for managing the Image Pixel Module
*
*/
#ifndef MODIMAGEPIXEL_H
#define MODIMAGEPIXEL_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/dcmiod/modimagepixelbase.h"
#include "dcmtk/dcmdata/dcdeftag.h"
/** Class representing the Image Pixel Module:
*
* Samples Per Pixel: (US, 1, 1)
* Photometric Interpretation (CS, 1, 1)
* Rows: (US, 1, 1)
* Columns: (US, 1, 1)
* Bits Allocated: (US, 1, 1)
* Bits Stored: (US, 1, 1)
* High Bit: (US, 1, 1)
* Pixel Representation: (US, 1, 1)
* Pixel Data is left out for now
* Planar Configuration: (US, 1, 1C)
* Pixel Aspect Ratio: (IS, 2, 1C)
* ICC Profile: (OB, 1, 3)
*/
template<typename T>
class DCMTK_DCMIOD_EXPORT IODImagePixelModule : public IODImagePixelBase
{
public:
/// Data type of pixels
typedef T value_type;
static const DcmTagKey pixel_data_tag;
/** 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.
*/
IODImagePixelModule(OFshared_ptr<DcmItem> item,
OFshared_ptr<IODRules> rules);
/** Constructor
*/
IODImagePixelModule();
/** Destructor
*/
virtual ~IODImagePixelModule();
/** 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);
/** Resets rules to their original values
*/
virtual void resetRules();
/** Get name of module
* @return Name of the module ("ImagePixelModule")
*/
virtual OFString getName() const;
/** Get pixel data type, always returns DataType::INTEGER for this class.
* @return The data type of the pixel data
*/
virtual DataType getDataType() 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)
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getBitsStored(Uint16& value,
const signed long pos = 0);
/** 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)
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getHighBit(Uint16& value,
const signed long pos = 0);
/** Get Pixel Representation
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1)
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getPixelRepresentation(Uint16& value,
const signed long pos = 0);
/** Get Planar Configuration
* @param value Reference to variable in which the value should be stored
* @param pos Index of the value to get (0..vm-1)
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getPlanarConfiguration(Uint16& value,
const signed long pos = 0);
/** Get ICC Profile
* @param values Reference to variable in which the values should be stored
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition getICCProfile(OFVector<Uint8>& values);
/** Set Samples per Pixel
* @param value Reference to variable in which the value should be stored
* @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 Reference to variable in which the value should be stored
* @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 Reference to variable in which the value should be stored
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setBitsAllocated(const Uint16 value,
const OFBool checkValue = OFTrue);
/** Set Bits Stored
* @param value Reference to variable in which the value should be stored
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setBitsStored(const Uint16 value,
const OFBool checkValue = OFTrue);
/** Set High Bit
* @param value Reference to variable in which the value should be stored
* @param checkValue Check 'value'. Not evaluated (here for consistency
* with other setter functions).
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setHighBit(const Uint16 value,
const OFBool checkValue = OFTrue);
/** Set Pixel Representation
* @param value Reference to variable in which the value should be stored
* @param checkValue Check 'value' for conformance with VR (US) and consistency
* if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setPixelRepresentation(const Uint16 value,
const OFBool checkValue = OFTrue);
/** Set Planar Configuration
* @param value Reference to variable in which the value should be stored
* @param checkValue Check 'value' for conformance with VR (US) and consistency
* with other attributes if enabled
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setPlanarConfiguration(const Uint16 value,
const OFBool checkValue = OFTrue);
/** Set ICC Profile
* @param values Reference to variable in which the values should be stored
* @param length Length of array provided in values parameter
* @return EC_Normal if successful, an error code otherwise
*/
virtual OFCondition setICCProfile(const Uint8* values,
const size_t length);
private:
/// This module's name ("ImagePixelModule")
static const OFString m_ModuleName;
};
#endif // MODIMAGEPIXEL_H
|