/usr/include/dcmtk/dcmimgle/diovlay.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 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 | /*
*
* Copyright (C) 1996-2014, 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: DicomOverlay (Header)
*
*/
#ifndef DIOVLAY_H
#define DIOVLAY_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/ofcast.h"
#include "dcmtk/dcmimgle/diobjcou.h"
#include "dcmtk/dcmimgle/diovdat.h"
#include "dcmtk/dcmimgle/diovpln.h"
#include "dcmtk/dcmimgle/diutils.h"
/*------------------------*
* forward declarations *
*------------------------*/
class DiDocument;
class DcmOverlayData;
class DcmLongString;
/*---------------------*
* class declaration *
*---------------------*/
/** Class to handle a set of overlay planes
*/
class DCMTK_DCMIMGLE_EXPORT DiOverlay
: public DiObjectCounter
{
public:
/** constructor
*
** @param docu pointer to dataset (encapsulated)
* @param alloc bits allocated for image pixel data
* @param stored bits stored for image pixel data
* @param high high bit for image pixel data
*/
DiOverlay(const DiDocument *docu = NULL,
const Uint16 alloc = 0,
const Uint16 stored = 0,
const Uint16 high = 0);
/** constructor, clip/scale
*
** @param overlay pointer to reference overlay object
* @param left_pos x-coordinate of new overlay origin (offset for all planes)
* @param top_pos y-coordinate of new overlay origin (offset for all planes)
* @param xfactor scaling factor in x-direction
* @param yfactor scaling factor in y-direction
*/
DiOverlay(const DiOverlay *overlay,
const signed long left_pos,
const signed long top_pos,
const double xfactor,
const double yfactor);
/** constructor, flip
*
** @param overlay pointer to reference overlay object
* @param horz flip horizontally if true
* @param vert flip vertically if true
* @param columns width of the surrounding image
* @param rows height of the surrounding image
*/
DiOverlay(const DiOverlay *overlay,
const int horz,
const int vert,
const Uint16 columns,
const Uint16 rows);
/** constructor, rotate
*
** @param overlay pointer to reference overlay object
* @param degree angle by which the overlay planes should be rotated
* @param columns width of the surrounding image
* @param rows height of the surrounding image
*/
DiOverlay(const DiOverlay *overlay,
const int degree,
const Uint16 columns,
const Uint16 rows);
/** destructor
*/
virtual ~DiOverlay();
/** check whether specified plane is currently visible (not hidden)
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return true if plane is visible, false otherwise
*/
int isPlaneVisible(unsigned int plane);
/** make specified plane visible
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return status, true if successful, false otherwise
*/
int showPlane(unsigned int plane);
/** make specified plane visible and set parameters
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param fore foreground color for overlay plane (in percent: 0.0-1.0)
* @param thresh threshold value for overlay plane (0.0-1.0)
* @param mode new overlay mode (EMO_Default for stored mode)
*
** @return status, true if successful, false otherwise
*/
int showPlane(unsigned int plane,
const double fore,
const double thresh,
const EM_Overlay mode);
/** make specified plane visible and set p-value.
* Only applicable for bitmap shutters.
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param pvalue p-value to be used for the overlay plane (0..65535)
*
** @return status, true if successful, false otherwise
*/
int showPlane(unsigned int plane,
const Uint16 pvalue);
/** make all planes visible
*
** @return status, true if successful, false otherwise
*/
int showAllPlanes();
/** make all planes visible
*
** @param fore foreground color for overlay planes (in percent: 0.0-1.0)
* @param thresh threshold value for overlay planes (in percent: 0.0-1.0)
* @param mode new overlay mode (EMO_Default for stored mode)
*
** @return status, true if successful, false otherwise
*/
int showAllPlanes(const double fore,
const double thresh,
const EM_Overlay mode);
/** make specified plane invisible
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return status, true if successful, false otherwise
*/
int hidePlane(unsigned int plane);
/** make all planes invisible
*
** @return status, true if successful, false otherwise
*/
int hideAllPlanes();
/** move plane to a new place
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param left_pos new x-coordinate of the overlay plane origin
* @param top_pos new y-coordinate of the overlay plane origin
*
** @return status, true if successful, false otherwise
*/
int placePlane(unsigned int plane,
const signed int left_pos,
const signed int top_pos);
/** get group number of specified plane
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return group number (0x6000-0x60ff) if successful, 0 otherwise
*/
unsigned int getPlaneGroupNumber(unsigned int plane) const;
/** get label of specified plane
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return plane label if successful, NULL otherwise
*/
const char *getPlaneLabel(unsigned int plane) const;
/** get description of specified plane
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return plane description if successful, NULL otherwise
*/
const char *getPlaneDescription(unsigned int plane) const;
/** get overlay mode of specified plane
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
*
** @return overlay mode if successful, EMO_Default otherwise
*/
EM_Overlay getPlaneMode(unsigned int plane) const;
/** get number of overlay planes
*
** @return number of overlay planes
*/
inline unsigned int getCount() const
{
return (Data != NULL) ? Data->Count : 0;
}
/** get current x-coordinate of overlay origin.
* This value is added to the origin of all overlay planes.
*
** @return x-coordinate of overlay origin
*/
inline signed long getLeft() const
{
return Left;
}
/** get current y-coordinate of overlay origin.
* This value is added to the origin of all overlay planes.
*
** @return y-coordinate of overlay origin
*/
inline signed long getTop() const
{
return Top;
}
/** check whether there are any overlay planes embedded in the pixel data
*
** @return true if there are embedded planes, false otherwise
*/
int hasEmbeddedData() const;
/** add plane to list of additional overlay planes
*
** @param group group number of plane to be added (0x6000-0x60ff).
* If group number already exists in the list of additional planes
* the old one is replaced. If the number exists in the list of
* planes stored in the image dataset the new plane hides it.
* @param left_pos x-coordinate of the plane origin
* @param top_pos y-coordinate of the plane origin
* @param columns width of the overlay plane (in pixels)
* @param rows height of the overlay plane
* @param data element where the plane data is stored
* @param label element where the plane label is stored
* @param description element where the plane description is stored
* @param mode overlay plane mode
*
** @return status, true if successful, false otherwise
*/
int addPlane(const unsigned int group,
const signed int left_pos,
const signed int top_pos,
const unsigned int columns,
const unsigned int rows,
const DcmOverlayData &data,
const DcmLongString &label,
const DcmLongString &description,
const EM_Overlay mode);
/** remove specified plane from list of additional overlay planes
*
** @param group group number of plane to be removed (0x6000-0x60ff)
*
** @return status, true if successful, false otherwise
*/
int removePlane(const unsigned int group);
inline DiOverlayPlane *getPlane(const unsigned int plane) const
{
return ((Data != NULL) && (Data->Planes != NULL) && (plane < Data->Count)) ? Data->Planes[plane] : OFstatic_cast(DiOverlayPlane *, NULL);
}
/** check whether specified plane exists
*
** @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param visible flag indicating whether plane should be visible or not (default: 0 = ignore)
*
** @return status, true if such a plane exists, false otherwise
*/
inline int hasPlane(unsigned int plane,
const int visible = 0) const
{
return (convertToPlaneNumber(plane, AdditionalPlanes) > 1) && (!visible || Data->Planes[plane]->isVisible());
}
/** get overlay plane data as an array of 1/8/16 bit values.
* Memory isn't handled internally and must therefore be deleted from calling program.
*
** @param frame number of frame
* @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param left_pos get x-coordinate of the plane origin
* @param top_pos get y-coordinate of the plane origin
* @param width get width of the overlay plane (in pixels)
* @param height get height of the overlay plane
* @param mode get overlay plane mode
* @param columns width of the surrounding image
* @param rows height of the surrounding image
* @param bits number of bits (stored) in the resulting array, default: 8
* @param fore foreground color used for the plane (default: 0xff = white, for 8 bits)
* @param back transparent background color (default: 0x00 = black)
*
** @return pointer to pixel data if successful, NULL otherwise
*/
void *getPlaneData(const unsigned long frame,
unsigned int plane,
unsigned int &left_pos,
unsigned int &top_pos,
unsigned int &width,
unsigned int &height,
EM_Overlay &mode,
const Uint16 columns,
const Uint16 rows,
const int bits = 8,
const Uint16 fore = 0xff,
const Uint16 back = 0x0);
/** get overlay plane data as an array of 1/8/16 bit values.
* Memory isn't handled internally and must therefore be deleted from calling program.
*
** @param frame number of frame
* @param plane index of plane (starting from 0) or group number (0x6000-0x60ff)
* @param width get width of the overlay plane (in pixels)
* @param height get height of the overlay plane
* @param bits number of bits (stored) in the resulting array, default: 8
* @param fore foreground color used for the plane (default: 0xff = white, for 8 bits)
* @param back transparent background color (default: 0x00 = black)
*
** @return pointer to pixel data if successful, NULL otherwise
*/
void *getFullPlaneData(const unsigned long frame,
unsigned int plane,
unsigned int &width,
unsigned int &height,
const int bits = 8,
const Uint16 fore = 0xff,
const Uint16 back = 0x0);
/** create overlay plane data in (6xxx,3000) format.
* (1 bit allocated and stored, foreground color is 1, background color is 0,
* data is 16 bit padded - even length)
* Memory isn't handled internally and must therefore be deleted from calling program.
*
** @param buffer stores pointer to overlay data (memory is allocated internally)
* @param plane number (0..15) or group number (0x60nn) of overlay plane
* @param width returns width of overlay plane (in pixels)
* @param height returns height of overlay plane (in pixels)
* @param frames returns number of frames (multiple overlay frames possible!)
*
** @return number of bytes allocated for the 'buffer' if successful, 0 otherwise
*/
unsigned long create6xxx3000PlaneData(Uint8 *&buffer,
unsigned int plane,
unsigned int &width,
unsigned int &height,
unsigned long &frames);
/// constant defining the maximum number of overlay planes (16)
static const unsigned int MaxOverlayCount;
/// constant defining the group number of the first overlay plane (0x6000)
static const unsigned int FirstOverlayGroup;
protected:
/** initialize new overlay managing object
*
** @param overlay reference object used as a template
*
** @return pointer to a new array of pixel data
*/
Uint16 *Init(const DiOverlay *overlay);
/** convert given plane or group number to a valid plane number
*
** @param plane plane or group number to be converted
* @param mode true or false, see return value
*
** @return status, true if successful, false otherwise.
* (1 = additional plane with the specified group number would be new,
* 2 = additional plane with the specified group number already exists,
* 3 = 'plane' is the number of a valid plane - only if 'mode' us false)
*/
int convertToPlaneNumber(unsigned int &plane,
const int mode) const;
/** convert five plane number to corresponding group number
*
** @param plane index of plane (0..15)
*
** @return group number
*/
unsigned int convertToGroupNumber(const unsigned int plane) const
{
return FirstOverlayGroup + 2 * plane;
}
/** check whether given group number is valid.
* Valid means that the number is even and between 0x6000 and 0x60ff.
*
** @param group group number to be checked
*
** @return status, true if valid, false otherwise
*/
int isValidGroupNumber(const unsigned int group) const;
/** check whether the specified plane is valid. and determine maximum resolution
* and number of frames which are common for all overlay planes so far.
*
** @param plane index of plane (0..15)
* @param mode if true the maximum number of frames is determined, otherwise not
*
** @return status, true if successful, false otherwise
*/
int checkPlane(const unsigned int plane,
const int mode = 1);
private:
/// left offset to all planes
signed long Left;
/// top offset to all planes
signed long Top;
/// maximum width of all planes
Uint16 Width;
/// maximum height of all planes
Uint16 Height;
/// maximum number of frames
unsigned long Frames;
/// status, if true planes are added later with addPlane()
int AdditionalPlanes;
/// points to overlay data (provides shared data)
DiOverlayData *Data;
// --- declarations to avoid compiler warnings
DiOverlay(const DiOverlay &);
DiOverlay &operator=(const DiOverlay &);
};
#endif
|