/usr/include/dcmtk/dcmimgle/diutils.h is in libdcmtk2-dev 3.6.0-15.
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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 | /*
*
* Copyright (C) 1996-2010, OFFIS e.V.
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation were developed by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmimgle
*
* Author: Joerg Riesmeier
*
* Purpose: Utilities (Header)
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:27 $
* CVS/RCS Revision: $Revision: 1.42 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DIUTILS_H
#define DIUTILS_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/oftypes.h"
#include "dcmtk/ofstd/ofcast.h"
#include "dcmtk/oflog/oflog.h"
OFLogger DCM_dcmimgleGetLogger();
#define DCMIMGLE_TRACE(msg) OFLOG_TRACE(DCM_dcmimgleGetLogger(), msg)
#define DCMIMGLE_DEBUG(msg) OFLOG_DEBUG(DCM_dcmimgleGetLogger(), msg)
#define DCMIMGLE_INFO(msg) OFLOG_INFO(DCM_dcmimgleGetLogger(), msg)
#define DCMIMGLE_WARN(msg) OFLOG_WARN(DCM_dcmimgleGetLogger(), msg)
#define DCMIMGLE_ERROR(msg) OFLOG_ERROR(DCM_dcmimgleGetLogger(), msg)
#define DCMIMGLE_FATAL(msg) OFLOG_FATAL(DCM_dcmimgleGetLogger(), msg)
/*---------------------*
* const definitions *
*---------------------*/
/** @name configuration flags
*/
//@{
/// compatibility with old ACR-NEMA images
const unsigned long CIF_AcrNemaCompatibility = 0x0000001;
/// accept wrong palette attribute tags
const unsigned long CIF_WrongPaletteAttributeTags = 0x0000002;
/// element pixel data may be detached if it is no longer needed by DicomImage
const unsigned long CIF_MayDetachPixelData = 0x0000004;
/// use presentation state instead of 'built-in' LUTs & overlays
const unsigned long CIF_UsePresentationState = 0x0000008;
/// don't convert YCbCr (Full and Full 4:2:2) color images to RGB
const unsigned long CIF_KeepYCbCrColorModel = 0x0000010;
/// take responsibility for the given external DICOM dataset, i.e. delete it on destruction
const unsigned long CIF_TakeOverExternalDataset = 0x0000020;
/// ignore modality transformation (rescale slope/intercept or LUT) stored in the dataset
const unsigned long CIF_IgnoreModalityTransformation = 0x0000040;
/// ignore third value of the modality LUT descriptor, determine bit depth automatically
const unsigned long CIF_IgnoreModalityLutBitDepth = 0x0000080;
/// check third value of the LUT descriptor, compare with with expected bit depth based on LUT data
const unsigned long CIF_CheckLutBitDepth = 0x0000100;
/// use absolute (possible) pixel range for determining the internal representation (monochrome only)
const unsigned long CIF_UseAbsolutePixelRange = 0x0000200;
/// use partial access to pixel data, i.e. without decompressing or loading a complete multi-frame image
const unsigned long CIF_UsePartialAccessToPixelData = 0x0000400;
/// always decompress complete pixel data when processing an image, i.e. even if partial access is used
const unsigned long CIF_DecompressCompletePixelData = 0x0000800;
/// never access embedded overlays since this requires to load and uncompress the complete pixel data
const unsigned long CIF_NeverAccessEmbeddedOverlays = 0x0001000;
//@}
// / true color color mode (for monochrome images only)
const int MI_PastelColor = -1;
/*--------------------*
* type definitions *
*--------------------*/
/** constants for photometric interpretation
*/
enum EP_Interpretation
{
/// unknown, undefined, invalid
EPI_Unknown,
// no element value available
EPI_Missing,
/// monochrome 1
EPI_Monochrome1,
/// monochrome 2
EPI_Monochrome2,
/// palette color
EPI_PaletteColor,
/// RGB color
EPI_RGB,
/// HSV color (retired)
EPI_HSV,
/// ARGB color (retired)
EPI_ARGB,
/// CMYK color (retired)
EPI_CMYK,
/// YCbCr full
EPI_YBR_Full,
/// YCbCr full 4:2:2
EPI_YBR_Full_422,
/// YCbCr partial 4:2:2
EPI_YBR_Partial_422
};
/** structure for photometric string and related constant
*/
struct SP_Interpretation
{
/// string (name of the color model without spaces and underscores)
const char *Name;
/// defined term according to the DICOM standard
const char *DefinedTerm;
/// integer constant
EP_Interpretation Type;
};
/** structure for BMP bitmap file header
*/
struct SB_BitmapFileHeader
{
/// signature, must always be 'BM'
char bfType[2];
/// file size in bytes
Uint32 bfSize;
/// reserved, should be '0'
Uint16 bfReserved1;
/// reserved, should be '0'
Uint16 bfReserved2;
/// offset from the beginning of the file to the bitmap data (in bytes)
Uint32 bfOffBits;
};
/** structure for BMP bitmap info header
*/
struct SB_BitmapInfoHeader
{
/// size of the BitmapInfoHeader, usually '40'
Uint32 biSize;
/// width of the image (in pixels)
Sint32 biWidth;
/// height of the image (in pixels)
Sint32 biHeight;
/// number of planes, usually '1'
Uint16 biPlanes;
/// bits per pixel, supported values: 8 = color palette with 256 entries, 24 = true color
Uint16 biBitCount;
/// type of compression, support value: 0 = BI_RGB, no compression
Uint32 biCompression;
/// size of the image data (in bytes), might be set to '0' if image is uncompressed
Uint32 biSizeImage;
/// horizontal resolution: pixels/meter, usually set to '0'
Sint32 biXPelsPerMeter;
/// vertical resolution: pixels/meter, usually set to '0'
Sint32 biYPelsPerMeter;
/// number of actually used colors, if '0' the number of colors is calculated using 'biBitCount'
Uint32 biClrUsed;
/// number of important colors, '0' means all
Uint32 biClrImportant;
};
/** internal representation of pixel data
*/
enum EP_Representation
{
/// unsigned 8 bit integer
EPR_Uint8, EPR_MinUnsigned = EPR_Uint8,
/// signed 8 bit integer
EPR_Sint8, EPR_MinSigned = EPR_Sint8,
/// unsigned 16 bit integer
EPR_Uint16,
/// signed 16 bit integer
EPR_Sint16,
/// unsigned 32 bit integer
EPR_Uint32, EPR_MaxUnsigned = EPR_Uint32,
/// signed 32 bit integer
EPR_Sint32, EPR_MaxSigned = EPR_Sint32
};
/** image status code
*/
enum EI_Status
{
/// normal, no error
EIS_Normal,
/// data dictionary not found
EIS_NoDataDictionary,
/// invalid dataset/file
EIS_InvalidDocument,
/// mandatory attribute missing
EIS_MissingAttribute,
/// invalid value for an important attribute
EIS_InvalidValue,
/// specified value for an attribute not supported
EIS_NotSupportedValue,
/// memory exhausted etc.
EIS_MemoryFailure,
/// invalid image, internal error
EIS_InvalidImage,
/// other error
EIS_OtherError
};
/** overlay modes.
* This mode is used to define how to display an overlay plane.
*/
enum EM_Overlay
{
/// default mode, as stored in the dataset
EMO_Default,
/// replace mode
EMO_Replace,
/// graphics overlay
EMO_Graphic = EMO_Replace,
/// threshold replace
EMO_ThresholdReplace,
/// complement
EMO_Complement,
/// invert the overlay bitmap
EMO_InvertBitmap,
/// region of interest (ROI)
EMO_RegionOfInterest,
/// bitmap shutter, used for GSPS objects
EMO_BitmapShutter
};
/** VOI LUT functions
*/
enum EF_VoiLutFunction
{
/// default function (not explicitly set)
EFV_Default,
/// function LINEAR
EFV_Linear,
/// function SIGMOID
EFV_Sigmoid
};
/** presentation LUT shapes
*/
enum ES_PresentationLut
{
/// default shape (not explicitly set)
ESP_Default,
/// shape IDENTITY
ESP_Identity,
/// shape INVERSE
ESP_Inverse,
/// shape LIN OD
ESP_LinOD
};
/** polarity
*/
enum EP_Polarity
{
/// NORMAL
EPP_Normal,
/// REVERSE (opposite polarity)
EPP_Reverse
};
/** bits per table entry modes.
* Specifies whether the given value in the LUT descriptor is used.
*/
enum EL_BitsPerTableEntry
{
/// use given value
ELM_UseValue,
/// ignore given value, use auto detection
ELM_IgnoreValue,
/// check whether given value is consistent with LUT data
ELM_CheckValue
};
/*----------------------------*
* constant initializations *
*----------------------------*/
const SP_Interpretation PhotometricInterpretationNames[] =
{
{"MONOCHROME1", "MONOCHROME1", EPI_Monochrome1},
{"MONOCHROME2", "MONOCHROME2", EPI_Monochrome2},
{"PALETTECOLOR", "PALETTE COLOR", EPI_PaletteColor}, // space deleted to simplify detection
{"RGB", "RGB", EPI_RGB},
{"HSV", "HSV", EPI_HSV},
{"ARGB", "ARGB", EPI_ARGB},
{"CMYK", "CMYK", EPI_CMYK},
{"YBRFULL", "YBR_FULL", EPI_YBR_Full}, // underscore deleted to simplify detection
{"YBRFULL422", "YBR_FULL_422", EPI_YBR_Full_422}, // underscores deleted to simplify detection
{"YBRPARTIAL422", "YBR_PARTIAL_422", EPI_YBR_Partial_422}, // underscores deleted to simplify detection
{NULL, NULL, EPI_Unknown}
};
/*---------------------*
* macro definitions *
*---------------------*/
#define MAX_UINT Uint32
#define MAX_SINT Sint32
#define MAX_BITS 32
#define MAX_BITS_TYPE Uint32
#define MAX_RAWPPM_BITS 8
#define MAX_INTERPOLATION_BITS 16
#define bitsof(expr) (sizeof(expr) << 3)
/*----------------------*
* class declarations *
*----------------------*/
/** Class comprising several global functions and constants.
* introduced to avoid problems with naming convention
*/
class DicomImageClass
{
public:
/** calculate maximum value which could be stored in the specified number of bits
*
** @param mv_bits number of bits
* @param mv_pos value subtracted from the maximum value (0 or 1)
*
** @return maximum value
*/
static inline unsigned long maxval(const int mv_bits,
const unsigned long mv_pos = 1)
{
return (mv_bits < MAX_BITS) ?
(OFstatic_cast(unsigned long, 1) << mv_bits) - mv_pos : OFstatic_cast(MAX_BITS_TYPE, -1);
}
/** calculate number of bits which are necessary to store the specified value
*
** @param tb_value value to be stored
* @param tb_pos value subtracted from the value (0 or 1) before converting
*
** @return number of bits
*/
static inline unsigned int tobits(unsigned long tb_value,
const unsigned long tb_pos = 1)
{
if (tb_value > 0)
tb_value -= tb_pos;
register unsigned int tb_bits = 0;
while (tb_value > 0)
{
++tb_bits;
tb_value >>= 1;
}
return tb_bits;
}
/** calculate number of bits which are necessary to store the specified value range
*
** @param minvalue minimum value to be stored
* @param maxvalue maximum value to be stored
*
** @return number of bits
*/
static unsigned int rangeToBits(double minvalue,
double maxvalue);
/** determine whether integer representation is signed or unsigned
*
** @param repres integer representation (enum) to be checked
*
** @return true if representation is signed, false if unsigned
*/
static int isRepresentationSigned(EP_Representation repres);
/** determine number of bits used for a particular integer representation
*
** @param repres integer representation (enum) to be checked
*
** @return number of bits
*/
static unsigned int getRepresentationBits(EP_Representation repres);
/** determine integer representation which is necessary to store values in the specified range
*
** @param minvalue minimum value to be stored
* @param maxvalue maximum value to be stored
*
** @return integer representation (enum)
*/
static EP_Representation determineRepresentation(double minvalue,
double maxvalue);
};
#endif
/*
*
* CVS/RCS Log:
* $Log: diutils.h,v $
* Revision 1.42 2010-10-14 13:16:27 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.41 2010-10-05 15:24:02 joergr
* Added preliminary support for VOI LUT function. Please note, however, that
* the sigmoid transformation is not yet implemented.
*
* Revision 1.40 2010-03-01 09:08:47 uli
* Removed some unnecessary include directives in the headers.
*
* Revision 1.39 2010-02-23 16:31:34 joergr
* Added new helper function which determines whether an integer representation
* is signed or unsigned.
*
* Revision 1.38 2009-11-25 14:59:11 joergr
* Added list of Defined Terms for the attribute PhotometricInterpretation.
*
* Revision 1.37 2009-11-17 17:55:47 joergr
* Added new enum value for missing photometric interpretation value.
* Added new configuration flags for the upcoming support of partial access to
* pixel data, i.e. without decompressing/loading a complete multi-frame image.
*
* Revision 1.36 2009-10-28 14:38:17 joergr
* Fixed minor issues in log output.
*
* Revision 1.35 2009-10-28 09:53:40 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.34 2009-04-21 08:19:51 joergr
* Added new compatibility flag CIF_UseAbsolutePixelRange which changes the way
* the internal representation of monochrome images is determined.
*
* Revision 1.33 2009-04-20 12:19:40 joergr
* Added new helper function getRepresentationBits().
*
* Revision 1.32 2007/03/16 11:56:06 joergr
* Introduced new flag that allows to select how to handle the BitsPerTableEntry
* value in the LUT descriptor (use, ignore or check).
*
* Revision 1.31 2005/12/08 16:48:12 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.30 2005/03/09 17:29:42 joergr
* Added support for new overlay mode "invert bitmap".
* Added new helper function rangeToBits().
*
* Revision 1.29 2004/11/29 16:52:22 joergr
* Removed email address from CVS log.
*
* Revision 1.28 2004/11/29 11:15:16 joergr
* Introduced new integer type MAX_BITS_TYPE for internal use.
*
* Revision 1.27 2004/11/25 09:38:43 meichel
* Fixed bug in DicomImageClass::maxval affecting 64-bit platforms.
*
* Revision 1.26 2004/08/03 11:41:50 meichel
* Headers libc.h and unistd.h are now included via ofstdinc.h
*
* Revision 1.25 2003/12/23 15:53:22 joergr
* Replaced post-increment/decrement operators by pre-increment/decrement
* operators where appropriate (e.g. 'i++' by '++i').
*
* Revision 1.24 2003/12/17 16:17:29 joergr
* Added new compatibility flag that allows to ignore the third value of LUT
* descriptors and to determine the bits per table entry automatically.
*
* Revision 1.23 2003/12/08 18:49:54 joergr
* Adapted type casts to new-style typecast operators defined in ofcast.h.
* Removed leading underscore characters from preprocessor symbols (reserved
* symbols). Updated copyright header.
*
* Revision 1.22 2003/05/20 09:19:51 joergr
* Added new configuration/compatibility flag that allows to ignore the
* modality transform stored in the dataset.
*
* Revision 1.21 2002/11/27 14:08:08 meichel
* Adapted module dcmimgle to use of new header file ofstdinc.h
*
* Revision 1.20 2002/06/26 16:08:14 joergr
* Added configuration flag that enables the DicomImage class to take the
* responsibility of an external DICOM dataset (i.e. delete it on destruction).
*
* Revision 1.19 2001/11/09 16:25:59 joergr
* Added support for Window BMP file format.
*
* Revision 1.18 2001/09/28 13:11:00 joergr
* Added new flag (CIF_KeepYCbCrColorModel) which avoids conversion of YCbCr
* color models to RGB.
*
* Revision 1.17 2001/06/01 15:49:52 meichel
* Updated copyright header
*
* Revision 1.16 2000/07/07 13:40:31 joergr
* Added support for LIN OD presentation LUT shape.
*
* Revision 1.15 2000/06/07 14:30:28 joergr
* Added method to set the image polarity (normal, reverse).
*
* Revision 1.14 2000/04/28 12:32:33 joergr
* DebugLevel - global for the module - now derived from OFGlobal (MF-safe).
*
* Revision 1.13 2000/03/08 16:24:25 meichel
* Updated copyright header.
*
* Revision 1.12 2000/02/23 15:12:16 meichel
* Corrected macro for Borland C++ Builder 4 workaround.
*
* Revision 1.11 2000/02/01 10:52:38 meichel
* Avoiding to include <stdlib.h> as extern "C" on Borland C++ Builder 4,
* workaround for bug in compiler header files.
*
* Revision 1.10 1999/09/17 13:08:13 joergr
* Added/changed/completed DOC++ style comments in the header files.
*
* Revision 1.9 1999/07/23 14:16:16 joergr
* Added flag to avoid color space conversion for color images (not yet
* implemented).
*
* Revision 1.8 1999/04/30 16:33:19 meichel
* Now including stdio.h in diutils.h, required on SunOS
*
* Revision 1.7 1999/04/28 14:55:41 joergr
* Added experimental support to create grayscale images with more than 256
* shades of gray to be displayed on a consumer monitor (use pastel colors).
*
* Revision 1.6 1999/03/24 17:20:28 joergr
* Added/Modified comments and formatting.
*
* Revision 1.5 1999/02/03 17:36:06 joergr
* Moved global functions maxval() and determineRepresentation() to class
* DicomImageClass (as static methods).
* Added BEGIN_EXTERN_C and END_EXTERN_C to some C includes.
*
* Revision 1.4 1999/01/20 15:13:12 joergr
* Added new overlay plane mode for bitmap shutters.
*
* Revision 1.3 1998/12/23 11:38:08 joergr
* Introduced new overlay mode item EMO_Graphic (= EMO_Replace).
*
* Revision 1.2 1998/12/16 16:40:15 joergr
* Some layouting.
*
* Revision 1.1 1998/11/27 15:51:45 joergr
* Added copyright message.
* Introduced global debug level for dcmimage module to control error output.
* Moved type definitions to diutils.h.
* Added methods to support presentation LUTs and shapes.
* Introduced configuration flags to adjust behaviour in different cases.
*
* Revision 1.5 1998/06/25 08:50:10 joergr
* Added compatibility mode to support ACR-NEMA images and wrong
* palette attribute tags.
*
* Revision 1.4 1998/05/11 14:53:30 joergr
* Added CVS/RCS header to each file.
*
*
*/
|