/usr/include/dcmtk/dcmpstat/dvpstat.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 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 | /*
*
* Copyright (C) 1998-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: dcmpstat
*
* Author: Marco Eichelberg
*
* Purpose:
* classes: DVPresentationState
*
* Last Update: $Author: joergr $
* Update Date: $Date: 2010-10-14 13:16:37 $
* CVS/RCS Revision: $Revision: 1.47 $
* Status: $State: Exp $
*
* CVS/RCS Log at end of file
*
*/
#ifndef DVPSTAT_H
#define DVPSTAT_H
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
#include "dcmtk/dcmpstat/dcmpstat.h"
class DicomImage;
class DiDisplayFunction;
/** a Grayscale Softcopy Presentation State.
* This class manages the data structures comprising a Presentation State object.
* Presentation states can be created, read, written, and modified.
*/
class DVPresentationState: public DcmPresentationState
{
public:
/** default constructor
* @param dispFunction list of objects describing the display
* characteristics of the monitor. Used to implement the standard display function.
* The parameter should be an array with DVPSD_max entries (see DVInterface).
* If absent, no display transform is performed.
* @param minPrintBitmapX default value for minimum print bitmap size X
* @param minPrintBitmapY default value for minimum print bitmap size Y
* @param maxPrintBitmapX default value for maximum print bitmap size X
* @param maxPrintBitmapY default value for maximum print bitmap size Y
* @param maxPreviewImageX default value for maximum preview image size X
* @param maxPreviewImageY default value for maximum preview image size Y
*/
DVPresentationState(
DiDisplayFunction **dispFunction=NULL,
unsigned long minPrintBitmapX=0,
unsigned long minPrintBitmapY=0,
unsigned long maxPrintBitmapX=0,
unsigned long maxPrintBitmapY=0,
unsigned long maxPreviewImageX=0,
unsigned long maxPreviewImageY=0);
/// destructor
virtual ~DVPresentationState();
/** resets the object to initial state.
* After this call, the object is in the same state as after
* creation with the default constructor.
*/
void clear();
/** reads a presentation state from a DICOM dataset.
* The DICOM elements of the presentation state are copied
* from the dataset to this object.
* The completeness and correctness of the
* presentation state (presence of all required elements,
* value multiplicity) is checked.
* If this method returns an error code, the object is in undefined state afterwards.
* @param dset the dataset from which the presentation state is to be read
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition read(DcmItem &dset);
/** creates a default presentation state for a DICOM image.
* A number of flags specify how curves, overlays, VOI transformations,
* a display shutter and a presentation LUT shape
* should be treated when found in the image IOD.
* If this method returns an error code, the object is in undefined state afterwards.
* @param dset the DICOM dataset containing the image IOD
* @param overlayActivation flag defining how overlays should be handled
* (copied, activated or ignored). Default: Copy overlays.
* @param voiActivation flag defining how VOI LUTs or VOI window width/center should
* be handled. Default: Use VOI and prefer VOI LUT from VOI window.
* @param curveActivation flag defining whether curves in the image should
* be activated. Default: Activate curves.
* @param shutterActivation flag defining whether a shutter (not bitmap shutter)
* should be copied to the presentation state when found in the image.
* Default: Copy shutter.
* @param presentationActivation flag defining whether a presentation LUT shape
* should be copied to the presentation state when found in the image.
* Default: Copy presentation LUT shape.
* @param layering flag defining how graphic layers should be created for
* activated overlays and curves. Default: Create one layer for all overlays
* and another layer for all curves.
* @param aetitle the series retrieveAETitle. Must be a valid DICOM 'AE' value. Default: value absent.
* @param filesetID the series storageMediaFileSetID. Must be a valid DICOM 'SH' value. Default: value absent.
* @param filesetUID the series storageMediaFileSetUID. Must be a valid DICOM UID. Default: value absent.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition createFromImage(DcmItem &dset,
DVPSoverlayActivation overlayActivation = DVPSO_copyOverlays,
DVPSVOIActivation voiActivation = DVPSV_preferVOILUT,
OFBool curveActivation = OFTrue,
OFBool shutterActivation = OFTrue,
OFBool presentationActivation = OFTrue,
DVPSGraphicLayering layering = DVPSG_twoLayers,
const char * aetitle = NULL,
const char * filesetID = NULL,
const char * filesetUID = NULL);
/** adds a reference to the currently attached image to this
* presentation state. This method checks if the given image
* is not yet referenced and if its Study UID and SOP class
* match for this presentation state and returns an error code otherwise.
* @param aetitle the series retrieveAETitle. Must be a valid DICOM 'AE' value. Default: value absent.
* @param filesetID the series storageMediaFileSetID. Must be a valid DICOM 'SH' value. Default: value absent.
* @param filesetUID the series storageMediaFileSetUID. Must be a valid DICOM UID. Default: value absent.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition addImageReferenceAttached(
const char *aetitle=NULL,
const char *filesetID=NULL,
const char *filesetUID=NULL);
/** removes a reference to the currently attached image from this presentation state.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition removeImageReferenceAttached();
/** sets the current Presentation LUT type.
* DVPSP_table can only be used if the presentation state
* contains a lookup table, i.e. if havePresentationLookupTable() returns OFTrue.
* @param newType the new presentation LUT type.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setCurrentPresentationLUT(DVPSPresentationLUTType newType);
/** resets the Presentation LUT to the default LUT shape
* which is DVPSP_identity for MONOCHROME2 images and DVPSP_inverse for MONOCHROME1.
* DVPSP_table can only be used if the presentation state
* contains a lookup table, i.e. if havePresentationLookupTable() returns OFTrue.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setDefaultPresentationLUTShape();
/** stores a presentation lookup table in the presentation state.
* This method stores a presentation lookup table in the
* presentation state and activates it. The LUT is copied to
* the presentation state. If the method returns EC_Normal,
* any old presentation LUT in the presentation state is overwritten.
* This method keeps the inverse/not inverse status intact,
* i.e. inverses the LUT if necessary.
* @param lutDescriptor the LUT Descriptor in DICOM format (VM=3)
* @param lutData the LUT Data in DICOM format
* @param lutExplanation the LUT Explanation in DICOM format, may be empty.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPresentationLookupTable(
DcmUnsignedShort& lutDescriptor,
DcmUnsignedShort& lutData,
DcmLongString& lutExplanation);
/** stores a presentation lookup table in the presentation state.
* This method stores a presentation lookup table in the
* presentation state and activates it. The LUT is copied to
* the presentation state. Overwrites old LUT. If unsuccessful,
* LUT is set to DVPSP_identity.
* This method keeps the inverse/not inverse status intact,
* i.e. inverses the LUT if necessary.
* @param dset dataset from which the Presentation LUT SQ or Shape is read.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setPresentationLookupTable(DcmItem &dset);
/** writes the current Presentation LUT to a DICOM dataset.
* Copies of the DICOM element managed by this object are inserted into
* the DICOM dataset. In the case of a MONOCHROME1 image an inverted
* LUT is written to dataset because the print bitmap is always MONOCHROME2.
* @param dset the dataset to which the Presentation LUT SQ/Shape is written
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition writePresentationLUTforPrint(DcmItem &dset);
/** checks whether the attached image is MONOCHROME1. In this case, the
* presentation LUT must be reversed when applied to the print bitmap
* which is always MONOCHROME2.
* @return OFTrue if attached image is MONOCHROME1, OFFalse otherwise.
*/
OFBool isMonochrome1Image() { return currentImageMonochrome1; }
/** check if a VOI window is currently active
* @return OFTrue if a VOI window is active
*/
OFBool haveActiveVOIWindow();
/** check if a VOI LUT is currently active
* @return OFTrue if a VOI LUT is active
*/
OFBool haveActiveVOILUT();
/** returns a description string for a currently active VOI transform.
* If no description is available, NULL is returned.
* @return a pointer to a string or NULL.
*/
const char *getCurrentVOIDescription();
/** gets the width of the current VOI window.
* May only be called if haveActiveVOIWindow() is OFTrue.
* @param w the window width is returned in this parameter
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getCurrentWindowWidth(double &w);
/** get the center of the current VOI window.
* May only be called if haveActiveVOIWindow() is OFTrue.
* @param c the window center is returned in this parameter
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getCurrentWindowCenter(double &c);
/** gets the number of VOI LUTs available in the attached image.
*/
size_t getNumberOfVOILUTsInImage();
/** gets the number of VOI Windows available in the attached image.
*/
size_t getNumberOfVOIWindowsInImage();
/** returns a description string for the given VOI LUT in the attached
* image.
* If no description for the given index is available, NULL is returned.
* @param idx index, must be < getNumberOfVOILUTsInImage()
* @return a pointer to a string or NULL.
*/
const char *getDescriptionOfVOILUTsInImage(size_t idx);
/** returns a description string for the given VOI Window
* in the attached image.
* If no description for the given index is available, NULL is returned.
* @param idx index, must be < getNumberOfVOIWindowsInImage()
* @return a pointer to a string or NULL.
*/
const char *getDescriptionOfVOIWindowsInImage(size_t idx);
/** activates one of the VOI LUTs from the attached image.
* The applicability of the activation is controlled by the applicability parameter.
* @param idx index of the VOI transform, must be < getNumberOfVOILUTsInImage().
* @param applicability defines the applicability of the new VOI transform.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setVOILUTFromImage(size_t idx,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** activates one of the VOI Windows from the attached image.
* The applicability of the activation is controlled by the applicability parameter.
* @param idx index of the VOI transform, must be < getNumberOfVOIWindowsInImage().
* @param applicability defines the applicability of the new VOI transform.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setVOIWindowFromImage(size_t idx,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** sets a user defined VOI window center and width.
* The applicability of the VOI window is controlled by the applicability parameter.
* @param wCenter the window center
* @param wWidth the window width
* @param description an optional description. Default: absent.
* @param applicability defines the applicability of the new VOI transform.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setVOIWindow(double wCenter, double wWidth, const char *description=NULL,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** stores a VOI lookup table in the presentation state.
* This method stores a VOI lookup table in the
* presentation state and activates it. The LUT is copied to
* the presentation state.
* If the method returns an error code, an old LUT is left unchanged.
* The applicability of the VOI LUT is controlled by the applicability parameter.
* @param lutDescriptor the LUT Descriptor in DICOM format (VM=3)
* @param lutData the LUT Data in DICOM format
* @param lutExplanation the LUT Explanation in DICOM format, may be empty.
* @param applicability defines the applicability of the new VOI transform.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setVOILUT(
DcmUnsignedShort& lutDescriptor,
DcmUnsignedShort& lutData,
DcmLongString& lutExplanation,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** deactivates the current VOI transformation.
* The applicability of the deactivation is controlled by the applicability parameter.
* After a call to this method, no VOI transform is active for the current image and frame.
* @param applicability defines the applicability of the new VOI transform.
*/
void deactivateVOI(DVPSObjectApplicability applicability=DVPSB_currentImage);
/** stores VOI lookup table with a gamma curve shape in the presentation state.
* If a VOI window is currently active the center and width values are used to specify
* the number of LUT entries and the first value mapped, otherwise the full pixel range
* is used. The output range of the LUT is always 16 bit (data is stored as OW).
* This method stores a VOI lookup table in the presentation state and activates it.
* The LUT is copied to the presentation state.
* If the method returns an error code, an old LUT is left unchanged.
* The applicability of the VOI LUT is controlled by the applicability parameter.
* @param gammaValue gamma value used to create the VOI LUT data
* @param applicability defines the applicability of the new VOI transform.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setGammaVOILUT(double gammaValue, DVPSObjectApplicability applicability=DVPSB_currentImage);
/** gets the presentation size mode for the current image and frame.
* This method may only be called when an image is attached to the presentation state.
* @return presentation size mode
*/
DVPSPresentationSizeMode getDisplayedAreaPresentationSizeMode();
/** gets the presentation pixel aspect ratio for for the current image and frame.
* Pixel aspect ratio is defined here as the width of a pixel divided
* by the height of a pixel (x/y).
* This method may only be called when an image is attached to the presentation state.
* @return pixel aspect ratio
*/
double getDisplayedAreaPresentationPixelAspectRatio();
/** gets the displayed area top lefthand corner and
* bottom righthand corner for the current potentially rotated and flipped image and frame.
* This method may only be called when an image is attached to the presentation state.
* @param tlhcX the displayed area top lefthand corner X value is returned in this parameter
* @param tlhcY the displayed area top lefthand corner Y value is returned in this parameter
* @param brhcX the displayed area bottom righthand corner X value is returned in this parameter
* @param brhcY the displayed area bottom righthand corner Y value is returned in this parameter
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition getStandardDisplayedArea(Sint32& tlhcX, Sint32& tlhcY, Sint32& brhcX, Sint32& brhcY);
/** gets the displayed area top lefthand corner and
* bottom righthand corner for the current image and frame, as if the image was unrotated
* This method may only be called when an image is attached to the presentation state.
* @param tlhcX the displayed area top lefthand corner X value is returned in this parameter
* @param tlhcY the displayed area top lefthand corner Y value is returned in this parameter
* @param brhcX the displayed area bottom righthand corner X value is returned in this parameter
* @param brhcY the displayed area bottom righthand corner Y value is returned in this parameter
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition getImageRelativeDisplayedArea(Sint32& tlhcX, Sint32& tlhcY, Sint32& brhcX, Sint32& brhcY);
/** gets the presentation pixel spacing for the current image and frame if it is known.
* @param x the horizontal pixel spacing (mm) is returned in this parameter upon success
* @param y the vertical pixel spacing (mm) is returned in this parameter upon success
* @return EC_Normal if successful, an error code if no presentation pixel spacing is available.
*/
OFCondition getDisplayedAreaPresentationPixelSpacing(double& x, double& y);
/** gets the presentation pixel magnification ratio for the current image and frame if it is present.
* @param magnification the magnification ratio is returned in this parameter upon success
* @return EC_Normal if successful, an error code if no magnification ratio is available.
*/
OFCondition getDisplayedAreaPresentationPixelMagnificationRatio(double& magnification);
/** checks if "TRUE SIZE" can be used as presentation size mode for the current image and frame
* (i.e. pixel spacing is known).
* @return OFTrue if TRUE SIZE mode is available, OFFalse otherwise.
*/
OFBool canUseDisplayedAreaTrueSize();
/** sets the displayed area and size mode (for the current frame, the current image
* or all images referenced by the presentation state object).
* @param sizeMode presentation size mode.
* @param tlhcX displayed area top lefthand corner X
* @param tlhcY displayed area top lefthand corner Y
* @param brhcX displayed area bottom righthand corner X
* @param brhcY displayed area bottom righthand corner Y
* @param magnification magnification factor - ignored unless sizeMode==DVPSD_magnify.
* @param applicability defines the applicability of the new displayed area definition.
* Possible choices are: DVPSB_currentFrame - current frame only,
* DVPSB_currentImage - all frames of current image (default),
* and DVPSB_allImages - all images referenced by this presentation state.
* The last choice should be used with care
* because it will also cause the pixel spacing or pixel aspect ratio of the current image
* to be applied to all images referenced by the presentation state.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setStandardDisplayedArea(
DVPSPresentationSizeMode sizeMode,
Sint32 tlhcX, Sint32 tlhcY,
Sint32 brhcX, Sint32 brhcY,
double magnification=1.0,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** sets the displayed area and size mode (for the current frame, the current image
* or all images referenced by the presentation state object).
* Treats the image as if it was neither rotated nor flipped.
* @param sizeMode presentation size mode.
* @param tlhcX displayed area top lefthand corner X
* @param tlhcY displayed area top lefthand corner Y
* @param brhcX displayed area bottom righthand corner X
* @param brhcY displayed area bottom righthand corner Y
* @param magnification magnification factor - ignored unless sizeMode==DVPSD_magnify.
* @param applicability defines the applicability of the new displayed area definition.
* Possible choices are: DVPSB_currentFrame - current frame only,
* DVPSB_currentImage - all frames of current image (default),
* and DVPSB_allImages - all images referenced by this presentation state.
* The last choice should be used with care
* because it will also cause the pixel spacing or pixel aspect ratio of the current image
* to be applied to all images referenced by the presentation state.
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition setImageRelativeDisplayedArea(
DVPSPresentationSizeMode sizeMode,
Sint32 tlhcX, Sint32 tlhcY,
Sint32 brhcX, Sint32 brhcY,
double magnification=1.0,
DVPSObjectApplicability applicability=DVPSB_currentImage);
/** deactivates display shutter of given type.
* After a call to this method haveShutter(type) will return OFFalse.
* @param type the shutter type
*/
void removeShutter(DVPSShutterType type);
/** sets and activates rectangular display shutter.
* If a bitmap shutter is exists, it is deactivated if this
* method returns successfully. If no shutter display value exists,
* a default of 0 (black) is set.
* @param lv the left vertical edge
* @param rv the right vertical edge
* @param uh the upper horizontal edge
* @param lh the lower horizontal edge
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setRectShutter(Sint32 lv, Sint32 rv, Sint32 uh, Sint32 lh);
/** sets and activates circular display shutter.
* If a bitmap shutter is exists, it is deactivated if this
* method returns successfully. If no shutter display value exists,
* a default of 0 (black) is set.
* @param centerX the X component of the shutter center
* @param centerY the Y component of the shutter center
* @param radius the (horizontal) radius of the shutter
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition setCircularShutter(Sint32 centerX, Sint32 centerY, Sint32 radius);
/** sets polygonal display shutter point.
* This method adds a point to the polygonal display shutter,
* which must already have at least an origin.
* If the point set with this method is identical to the
* origin of the shutter, the shutter is activated and
* a possible bitmap shutter is deactivated. If no shutter display value exists,
* a default of 0 (black) is set.
* @param x the x component of the shutter origin
* @param y the x component of the shutter origin
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition addPolyShutterVertex(Sint32 x, Sint32 y);
/** removes and deletes a graphic layer. All text, graphic, curve
* and overlay objects on this graphic layer are also deleted or deactivated, respectively.
* @param idx index of the graphic layer, must be < getNumberOfGraphicLayers()
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition removeGraphicLayer(size_t idx);
/** returns the number of text objects for the given
* graphic layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @return number of text objects
*/
size_t getNumberOfTextObjects(size_t layer);
/** gets the text object with the given index
* on the given layer. If the text object or the graphic layer does
* not exist, NULL is returned.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the text object, must be < getNumberOfTextObjects(layer)
* @return a pointer to the text object
*/
DVPSTextObject *getTextObject(size_t layer, size_t idx);
/** creates a new text object on the given layer.
* Returns a pointer to the new text object.
* If the creation of the text object fails or if the graphic layer
* does not exist, NULL is returned.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param applicability defines to which images/frames the new object applies.
* Default: all images referenced by the presentation state.
* @return a pointer to the new text object
*/
DVPSTextObject *addTextObject(size_t layer,
DVPSObjectApplicability applicability=DVPSB_allImages);
/** deletes the text object with the given index
* on the given layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the text object, must be < getNumberOfTextObjects(layer)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition removeTextObject(size_t layer, size_t idx);
/** moves the text object with the given index on the given
* layer to a different layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param old_layer index of the graphic layer on which the text object is,
* must be < getNumberOfGraphicLayers()
* @param idx index of the text object, must be < getNumberOfTextObjects(layer)
* @param new_layer index of the graphic layer to which the text object is moved,
* must be < getNumberOfGraphicLayers()
* @param applicability defines to which images/frames the new object applies from now on.
* Default: all images referenced by the presentation state.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition moveTextObject(size_t old_layer, size_t idx, size_t new_layer,
DVPSObjectApplicability applicability=DVPSB_allImages);
/** returns the number of graphic objects for the given
* graphic layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @return number of graphic objects
*/
size_t getNumberOfGraphicObjects(size_t layer);
/** gets the graphic object with the given index
* on the given layer. If the graphic object or the graphic layer does
* not exist, NULL is returned.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer)
* @return a pointer to the graphic object
*/
DVPSGraphicObject *getGraphicObject(size_t layer, size_t idx);
/** creates a new graphic object on the given layer.
* Returns a pointer to the new graphic object.
* If the creation of the graphic object fails or if the graphic layer
* does not exist, NULL is returned.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param applicability defines to which images/frames the new object applies.
* Default: all images referenced by the presentation state.
* @return a pointer to the new graphic object
*/
DVPSGraphicObject *addGraphicObject(size_t layer,
DVPSObjectApplicability applicability=DVPSB_allImages);
/** deletes the graphic object with the given index
* on the given layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition removeGraphicObject(size_t layer, size_t idx);
/** moves the graphic object with the given index on the given
* layer to a different layer.
* Only the objects that are applicable to the current (attached) image
* and the selected frame number are used by this method.
* @param old_layer index of the graphic layer on which the graphic object is,
* must be < getNumberOfGraphicLayers()
* @param idx index of the graphic object, must be < getNumberOfGraphicObjects(layer)
* @param new_layer index of the graphic layer to which the graphic object is moved,
* must be < getNumberOfGraphicLayers()
* @param applicability defines to which images/frames the new object applies from now on.
* Default: all images referenced by the presentation state.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition moveGraphicObject(size_t old_layer, size_t idx, size_t new_layer,
DVPSObjectApplicability applicability=DVPSB_allImages);
/** gets the curve with the given index
* on the given layer. If the curve or the graphic layer does
* not exist, NULL is returned.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the curve, must be < getNumberOfCurves(layer)
* @return a pointer to the curve
*/
DVPSCurve *getCurve(size_t layer, size_t idx);
/** returns the number of curves in the attached image
* that could be activated in the presentation state.
* @return number of available curves
*/
size_t getNumberOfCurvesInImage();
/** gets the curve with the given index
* from the attached image. If the curve does
* not exist, NULL is returned.
* @param idx index of the curve, must be < getNumberOfCurvesInImage()
* @return a pointer to the curve
*/
DVPSCurve *getCurveInImage(size_t idx);
/** activates curve in presentation state.
* This method adds an activation for the given curve from the
* attached image to the given graphic layer in the presentation state.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param curveidxinimage index of the curve in the attached image,
* must be < getNumberOfCurvesInImage()
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition addCurve(size_t layer, size_t curveidxinimage);
/** gets the overlay label of the given activated overlay.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the overlay, must be < getNumberOfActiveOverlays().
* @return label string if it exists, NULL otherwise.
*/
const char *getActiveOverlayLabel(size_t layer, size_t idx);
/** gets the overlay description of the given activated overlay.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the overlay, must be < getNumberOfActiveOverlays().
* @return description string if it exists, NULL otherwise.
*/
const char *getActiveOverlayDescription(size_t layer, size_t idx);
/** checks whether the given activated overlay is a ROI
* (region of interest) overlay.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the overlay, must be < getNumberOfActiveOverlays().
* @return OFTrue if overlay exists and is ROI, OFFalse otherwise.
*/
OFBool activeOverlayIsROI(size_t layer, size_t idx);
/** gets one overlay bitmap.
* @param layer index of the graphic layer on which this overlay is
* activated, must be < getNumberOfGraphicLayers().
* @param idx index of the overlay activation on the given layer,
* must be < getNumberOfActiveOverlays(layer).
* @param overlayData upon success a pointer to the overlay plane is passed back
* in this parameter. The overlay plane is organized as one byte or one word per pixel.
* The byte/word values are already transformed from pvalues to DDLs.
* @param width upon success the width of the overlay bitmap in pixels is returned in this parameter.
* @param height upon success the height of the overlay bitmap in pixels is returned in this parameter.
* @param left_pos upon success the horizontal position of the overlay relative to the image
* is returned. 0 means that the overlay is left aligned with the image.
* Since the overlay is cropped at the borders of the image, values < 0 are impossible.
* @param top_pos upon success the vertical position of the overlay relative to the image
* is returned.
* @param isROI returns OFTrue if the overlay is ROI, OFFalse if the overlay is Graphic.
* @param fore returns value of foreground color (pvalue), all other values are transparent
* @param bits number of bits used for overlayData (valid: 8 or 12, default: 8). If bits is less than or
* equal to 8 the resulting overlayData is an array of 8 bit values, an array 16 bit values otherwise.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getOverlayData(
size_t layer,
size_t idx,
const void *&overlayData,
unsigned int &width,
unsigned int &height,
unsigned int &left_pos,
unsigned int &top_pos,
OFBool &isROI,
Uint16 &fore,
unsigned int bits = 8);
/** gets the number of overlays which are embedded in the
* image currently attached to the presentation state. Overlays in the image are counted only
* if they are not shadowed by overlays that are embedded in the presentation state
* and use the same repeating group number.
* @return number of overlays in attached image
*/
size_t getNumberOfOverlaysInImage();
/** gets the repeating group number of the given overlay in the attached image.
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return repeating group number if found, 0 otherwise.
*/
Uint16 getOverlayInImageGroup(size_t idx);
/** gets the overlay label of the given overlay in the attached image.
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return label string if it exists, NULL otherwise.
*/
const char *getOverlayInImageLabel(size_t idx);
/** gets the overlay description of the given overlay in the attached image.
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return description string if it exists, NULL otherwise.
*/
const char *getOverlayInImageDescription(size_t idx);
/** gets the index of the activation layer on which the given
* overlay from the attached image is activated.
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return layer index (which is < getNumberOfGraphicLayers()) if overlay exists
* and is activated, DVPS_IDX_NONE otherwise.
*/
size_t getOverlayInImageActivationLayer(size_t idx);
/** checks whether the given overlay in the attached image is a ROI
* (region of interest) overlay.
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return OFTrue if overlay exists and is ROI, OFFalse otherwise.
*/
OFBool overlayInImageIsROI(size_t idx);
/** removes an overlay from the presentation state.
* If the overlay is activated, the activation is also removed.
* Since overlays in the presentation state can shadow overlays in the attached image,
* execution of this method may change the number of overlays reported in the attached image.
* @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition removeOverlayFromPresentationState(size_t idx);
/** changes the repeating group used for an overlay in the presentation state.
* Since overlays in the presentation state can shadow overlays in the attached image,
* execution of this method may change the number of overlays reported in the attached image.
* @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
* @param newGroup new repeating group number 0x6000-0x601F (even). If this optional parameter is omitted,
* the method attemps to automatically determine a new group number so that no overlay in the
* attached image is shadowed any more. If this is impossible, the method fails and leaves
* the overlay repeating group unchanged.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition changeOverlayGroupInPresentationState(size_t idx, Uint16 newGroup=0);
/** adds a new overlay bitmap to the presentation state.
* The overlay is read from a DICOM dataset which must contain the
* attributes required for a graphic or ROI overlay, see class DVPSOverlay.
* The dataset can be an image or standalone overlay IOD.
* The overlay data is copied into the presentation state, i.e. the DICOM dataset
* can be deleted after execution of this method.
* @param overlayIOD the DICOM dataset from which the overlay is to be read
* @param groupInItem the repeating group 0x6000..0x61F (even) of the overlay to be read
* @param newGroup repeating group number 0x6000-0x601F (even) to be used for
* the overlay in the presentation state. If this optional parameter is omitted,
* the method attemps to automatically determine a new group number so that no overlay in the
* attached image is shadowed any more. If this is impossible, a group number so far unused
* in the presentation state is taken.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition addOverlayToPresentationState(DcmItem& overlayIOD, Uint16 groupInItem, Uint16 newGroup=0);
/** checks if an overlay from the presentation state is suitable
* for use as a bitmap shutter. An overlay is suitable if it is a graphic overlay
* with the same size as the attached image and with the origin 1\1.
* This method does not check wether the overlay is already activated as overlay
* or bitmap shutter.
* @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
* @return OFTrue if overlay can be used as display shutter.
*/
OFBool overlayIsSuitableAsBitmapShutter(size_t idx);
/** activates the given overlay from the attached image
* on the given graphic layer.
* If the overlay is already activated (i.e.
* getOverlayInImageActivationLayer(idx) != DVPS_IDX_NONE) this method fails.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the overlay, must be < getNumberOfOverlaysInImage().
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition activateOverlayInImage(size_t layer, size_t idx);
/** activates the given overlay from the presentation state
* on the given graphic layer.
* If the overlay is already activated or used as a bitmap overlay (i.e.
* getOverlayInPresentationStateActivationLayer(idx) != DVPS_IDX_NONE or
* overlayIsBitmapShutter(idx) == OFTrue) this method fails.
* @param layer index of the graphic layer, must be < getNumberOfGraphicLayers()
* @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition activateOverlayInPresentationState(size_t layer, size_t idx);
/** activates an overlay as bitmap shutter.
* The overlay must not be activated on a graphic layer (i.e.
* getOverlayInPresentationStateActivationLayer(idx) != DVPS_IDX_NONE,
* otherwise this method fails.
* @param idx index of the overlay, must be < getNumberOfOverlaysInPresentationState().
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition activateOverlayAsBitmapShutter(size_t idx);
/** removes activation for an overlay which may be
* embedded in the attached image or part of the presentation state.
* @param layer index of the graphic layer on which this overlay is
* activated, must be < getNumberOfGraphicLayers().
* @param idx index of the overlay activation on the given layer,
* must be < getNumberOfActiveOverlays(layer).
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition deactivateOverlay(size_t layer, size_t idx);
/** attaches an image to the presentation state.
* If an image is already attached to the presentation state,
* the old image is detached (and freed if necessary) and the new image is attached.
* A preview image is created automatically (if values for preview resolution are valid).
* @param dataset pointer to the DICOM image as DcmDataset.
* @param transferOwnership if true, the presentation state assumes ownership
* of the passed DcmDataset, which is freed when a different image is attached
* or the presentation state is deleted.
* @return EC_Normal if successful, an error code otherwise. If an error code
* is returned, the presentation state has the same state as before the call
* to this method.
*/
OFCondition attachImage(DcmDataset *dataset, OFBool transferOwnership);
/** attaches an image to the presentation state.
* If an image is already attached to the presentation state,
* the old image is detached (and freed if necessary) and the new image is attached.
* A preview image is created automatically (if values for preview resolution are valid).
* @param fileformat pointer to the DICOM image as DcmFileFormat.
* @param transferOwnership if true, the presentation state assumes ownership
* of the passed DcmFileFormat, which is freed when a different image is attached
* or the presentation state is deleted.
* @return EC_Normal if successful, an error code otherwise. If an error code
* is returned, the presentation state has the same state as before the call
* to this method.
*/
OFCondition attachImage(DcmFileFormat *fileformat, OFBool transferOwnership);
/** detaches and frees the image (incl. preview) attached to the presentation state.
*/
void detachImage();
/** checks whether image is inverse (shape, plut or mono1).
* @return OFTrue if image is inverse, OFFalse otherwise.
*/
OFBool isInverse();
/** inverts image by changing presentation state LUT or presentation state LUT shape.
* Pixel data has to be re-get after this transformation.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition invertImage();
/** applies presentation state to attached image and returns image bitmap.
* This method sets all parameter required to correctly render the pixel data
* in the image attached to the presentation state and then creates the
* required pixel data which contains all grayscale transformations but none
* of the none-grayscale transformations of the presentation state "burned in"
* into the pixel data. The pixel data returned is already corrected by a
* display transform for the current display device and can be mapped directly
* to digital driving levels of the graphics board. The pointer to the pixel
* data remains valid until the next call to this function, or until the
* image is detached or the presentation state is deleted.
* @param pixelData in this parameter a pointer to the pixel data is returned
* (array of 8 bit values). The storage area allocated for this pointer must
* not be freed by the caller. If the return value is an error code,
* no valid pixel data pointer may be assumed.
* @param width returns the width of the bitmap in pixels
* @param height returns the height of the bitmap in pixels
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getPixelData(
const void *&pixelData,
unsigned long &width,
unsigned long &height);
/** same as method above apart from the fact that the storage area is handled
* externally.
* @param pixelData pointer to storage area where the pixel data is copied to
* (array of 8 bit values). The storage area must be allocated and deleted
* from the calling method.
* @param size specifies size of the storage area in bytes.
* @return EC_Normal upon success, an error code otherwise.
*/
OFCondition getPixelData(
void *pixelData,
unsigned long size);
/** returns the SOP Class UID of the currently attached image.
* @return SOP class UID of current image, NULL if absent
*/
const char *getAttachedImageSOPClassUID();
/** returns the SOP Instance UID of the currently attached image.
* @return SOP instance UID of current image, NULL if absent
*/
const char *getAttachedImageSOPInstanceUID();
/** gets the width of the attached image.
* The rotation status of the presentation state is not taken
* into account, i.e. the width of an unrotated image is returned.
* This method may only be called when an image is attached to the
* presentation state.
* @param width upon success, the image width (pixels) is returned in this parameter.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getImageWidth(unsigned long &width);
/** gets the height of the attached image.
* The rotation status of the presentation state is not taken
* into account, i.e. the height of an unrotated image is returned.
* This method may only be called when an image is attached to the
* presentation state.
* @param height upon success, the image height (pixels) is returned in this parameter.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getImageHeight(unsigned long &height);
/** gets number of bytes used for the print bitmap.
* (depends on width, height and depth)
* @return number of bytes used for the print bitmap
*/
unsigned long getPrintBitmapSize();
/** sets the minimum print bitmap width and height.
* Smaller images are scaled up by an appropriate integer factor. Both maximum
* values need to be twice greater than the maximum of the minimum values.
* @param width minimum width of print bitmap (in pixels)
* @param height minimum height of print bitmap (in pixels)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition setMinimumPrintBitmapWidthHeight(unsigned long width,
unsigned long height);
/** sets the maximum print bitmap width and height.
* Larger images are scaled down by an appropriate integer factor. Both maximum
* values need to be twice greater than the maximum of the minimum values.
* @param width maximum width of print bitmap (in pixels)
* @param height maximum height of print bitmap (in pixels)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition setMaximumPrintBitmapWidthHeight(unsigned long width,
unsigned long height);
/** gets width and height of print bitmap.
* Bitmap size depends on implicit scaling, a heuristic is used for very small images.
* The return values depend on the current minimum/maximum print bitmap width/height values!
* @param width upon success, the bitmap width (in pixels) is returned in this parameter
* @param height upon success, the bitmap height (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintBitmapWidthHeight(unsigned long &width,
unsigned long &height);
/** gets width of print bitmap.
* Bitmap size depends on implicit scaling, a heuristic is used for very small images.
* The return value depends on the current minimum/maximum print bitmaps width/height values!
* @param width upon success, the image width (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintBitmapWidth(unsigned long &width);
/** gets height of print bitmap.
* bitmap size depends on implicit scaling, a heuristic is used for very small images
* The return value depends on the current minimum/maximum print bitmaps width/height values!
* @param height upon success, the image height (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintBitmapHeight(unsigned long &height);
/** gets the presentation pixel aspect ratio for the print bitmap.
* Pixel aspect ratio is defined here as the width of a pixel divided
* by the height of a pixel (x/y). The related image is already rotated and flipped!
* @return pixel aspect ratio
*/
double getPrintBitmapPixelAspectRatio();
/** gets requested image size for print bitmap.
* If the presentation state mode is DVPSD_trueSize, this method computes
* the true physical width (in mm) of the print image (under consideration of the
* rotation status) and writes it to the requestedImageSize string.
* @param requestedImageSize requested image size is written to this parameter upon
* successful return. Otherwise string is empty upon return.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintBitmapRequestedImageSize(OFString& requestedImageSize);
/** writes the bitmap data into the given buffer.
* The bitmap has the format: 12 bits stored and 16 bits allocated. This method is used
* to create the preformatted bitmap where the annotations are later burned in.
* Implicit scaling is performed if the bitmap is too small (see minimum bitmap size).
* The storage area must be allocated and deleted from the calling method.
* @param bitmap pointer to storage area where the pixel data is copied to.
* @param size specifies size of the storage area in bytes
* @param inversePLUT render inverse PLUT into bitmap if OFTrue (optional)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPrintBitmap(void *bitmap,
unsigned long size,
OFBool inversePLUT = OFFalse);
/** creates a new preview image based on the current image and pstate.
* The maximum size of this image is specified by the two parameters maxWidth and maxHeight.
* The actual size should be determined using one of the following appropriate methods (e.g.
* getPreviewImageWidthHeight) since the original pixel aspect ratio is alsways considered.
* The preview image includes all grayscale and spatial transformations performed on the
* current image so far. The method renderPixelData also renders the preview image (if existing).
* Therefore the preview image is always held consistent with the current image.
* Overlays, bitmapped shutters and any other annotations are not rendered into the preview image.
* @param maxWidth the maximum width used to create the preview image
* @param maxHeight the maximum height used to create the preview image
* @param clipMode specifies whether to clip the preview image to the displayed area (not implemented!)
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition createPreviewImage(unsigned long maxWidth,
unsigned long maxHeight,
OFBool clipMode = OFFalse);
/** deletes and disables the current preview image.
*/
void deletePreviewImage();
/** gets number of bytes used for the preview image bitmap.
* (depends on width and height)
* @return number of bytes used for the preview image bitmap
*/
unsigned long getPreviewImageSize();
/** gets current width and height of the preview image.
* @param width upon success, the image width (in pixels) is returned in this parameter
* @param height upon success, the image height (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPreviewImageWidthHeight(unsigned long &width,
unsigned long &height);
/** gets current width of the preview image.
* @param width upon success, the image width (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPreviewImageWidth(unsigned long &width);
/** gets current height of the preview image.
* @param height upon success, the image height (in pixels) is returned in this parameter
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPreviewImageHeight(unsigned long &height);
/** writes the bitmap data of the preview image into the given buffer.
* The storage area must be allocated and deleted from the calling method.
* @param bitmap pointer to storage area where the pixel data is copied to (array of 8 bit values)
* @param size specifies size of the storage area in bytes
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getPreviewImageBitmap(void *bitmap,
unsigned long size);
/** gets smallest and biggest possible pixel value in the attached image.
* These values are defined as the smallest and biggest number that
* could possibly be contained in the image after application of the Modality transform,
* but before any VOI, Presentation or display transform.
* This method may only be called when an image is attached to the
* presentation state.
* @param minValue upon success, the smallest value is returned in this parameter.
* @param maxValue upon success, the biggest value is returned in this parameter.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getImageMinMaxPixelRange(double &minValue, double& maxValue);
/** gets smallest and biggest occuring pixel value in the attached image.
* These values are defined as the smallest and biggest number that
* are actually contained in the image after application of the Modality transform,
* but before any VOI, Presentation or display transform.
* This method may only be called when an image is attached to the
* presentation state.
* @param minValue upon success, the smallest value is returned in this parameter.
* @param maxValue upon success, the biggest value is returned in this parameter.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getImageMinMaxPixelValue(double &minValue, double& maxValue);
/** gets the number of frames of the current (attached) image.
* This method may only be called when an image is attached to the
* presentation state.
* @param frames upon success, the number of frames is returned in this parameter.
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition getImageNumberOfFrames(unsigned long &frames);
/** selects one frame of a multiframe image. This affects the image bitmap
* that is rendered, the overlay bitmaps and the visibility of graphic and text objects.
* This method may only be called when an image is attached to the
* presentation state.
* @param frame frame number in the range [1..getImageNumberOfFrames()]
* @return EC_Normal upon success, an error code otherwise
*/
OFCondition selectImageFrameNumber(unsigned long frame);
/** gets the index of the currently selected frame in a multi-frame image.
* @return index of the currently selected frame, 0 if an error occurred
*/
unsigned long getSelectedImageFrameNumber();
/** gets the currently selected display transform.
* Display transform will only be performed if switched on _and_
* a valid monitor characteristics description exists.
* Default after creation of a presentation state is "on".
* @return current display transform if on, DVPSD_none if off.
*/
DVPSDisplayTransform getDisplayTransform() { return displayTransform; }
/** activates or deactivates display correction.
* Display transform will only be performed if switched on
* _and_ a valid display function object exists.
* @param transform display transform to be set, DVPSD_none to switch off.
*/
void setDisplayTransform(DVPSDisplayTransform transform) { displayTransform = transform; }
/** converts a 16-bit P-Value to an 8-bit DDL value for on-sceen display.
* If a display function is set and enabled (see setDisplayTransform()),
* the DDL is corrected for the nonlinearity of the display, otherwise
* a simple linear mapping is performed. For 12-bit DDL values (hardcopy)
* the display function is automatically disabled.
* @param pvalue P-Value 0..0xFFFF
* @param bits number of bits used for the output DDL value (8 = softcopy, 12 = hardcopy)
* @return display driving level (DDL), 0..0xFF (8 bit) / 0..0xFFF (12 bit)
*/
Uint16 convertPValueToDDL(Uint16 pvalue, unsigned int bits = 8);
/** writes the patient module attributes and a source image sequence
* for a grayscale hardcopy image.
* Copies of the DICOM elements managed by this object are inserted into
* the DICOM dataset.
* @param dset the dataset to which the data is written
* @return EC_Normal if successful, an error code otherwise.
*/
OFCondition writeHardcopyImageAttributes(DcmItem &dset);
/** gets the modality of the attached image.
* @return modality string if it exists, NULL or empty string otherwise.
*/
const char *getCurrentImageModality();
/** tries to find an overlay repeating group that is not used in the
* presentation state or the attached image. If that does not exist,
* it returns a group number that is unused in the presentation state
* but used in the image.
* @param currentGroup the current group number of the overlay
* to be changed (if any)
* @return group number 0x6000..0x601F if found, 0 otherwise.
*/
Uint16 findOverlayGroup(Uint16 currentGroup=0);
/** prepares pixel data for image and overlays for access.
* This method is called internally before any image pixel data
* or overlay bitmaps is created. It makes sure that the following settings
* of the presentation state are reflected in the dcmimage-based
* image processing routines: VOI transformation, Presentation LUT,
* rotation, flip, overlay activation.
* @param display use current display function if OFTrue, don't use otherwise
*/
void renderPixelData(OFBool display = OFTrue);
/** attempts to find the displayed area selection for the
* current image and frame. If not found, creates a default.
* @return displayed area selection item. If creation of a default failed
* or no image is attached to the presentation state, returns NULL.
*/
DVPSDisplayedArea *getDisplayedAreaSelection();
/** attempts to find the Softcopy VOI LUT item for the
* current image and frame. If not found, returns NULL.
* @return softcopy VOI LUT item for current image and frame if found, NULL otherwise
*/
DVPSSoftcopyVOI *getCurrentSoftcopyVOI();
private:
/** helper method that activates the given overlay in the given image
* @param ovl overlay to activate
* @param image image to be rendered
* @param asShutter true if overlay should be used as bitmap shutter
* @param pvalue pvalue for overlay foreground
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition activateOverlayHelper(
DVPSOverlay& ovl,
DicomImage &image,
OFBool asShutter = OFFalse,
Uint16 pvalue = 0);
/* connection with dcmimage */
/** a pointer to the DICOM dataset comprising the image
* to which the presentation state is currently applied
*/
DcmDataset *currentImageDataset;
/** a pointer to the fileformat (if it exists) of the
* DICOM dataset comprising the image to which the
* presentation state is currently applied
*/
DcmFileFormat *currentImageFileformat;
/** a pointer to the dcmimage representation of the
* image to which the presentation state is currently applied
*/
DicomImage *currentImage;
/** a pointer to the dcmimage representation of the (smaller) preview
* image to which the presentation state is currently applied
*/
DicomImage *previewImage;
/** contains the width of the attached image without consideration of rotation.
*/
unsigned long currentImageWidth;
/** contains the height of the attached image without consideration of rotation.
*/
unsigned long currentImageHeight;
/** contains the width of the attached image after pixel data have been rendered (w/o clipping).
*/
unsigned long renderedImageWidth;
/** contains the height of the attached image after pixel data have been rendered (w/o clipping).
*/
unsigned long renderedImageHeight;
/** contains the top hand corner of the attached image after pixel data have been rendered.
*/
signed long renderedImageTop;
/** contains the left hand corner of the attached image after pixel data have been rendered.
* (the following equation is always true: renderedImageTop <= renderedImageBottom)
*/
signed long renderedImageLeft;
/** contains the bottom hand corner of the attached image after pixel data have been rendered.
* (the following equation is always true: renderedImageLeft <= renderedImageRight)
*/
signed long renderedImageBottom;
/** contains the right hand corner of the attached image after pixel data have been rendered.
*/
signed long renderedImageRight;
/** contains the SOP Class UID of the attached image
*/
char *currentImageSOPClassUID;
/** contains the SOP Instance UID of the attached image
*/
char *currentImageSOPInstanceUID;
/** contains the current selected frame number of the attached image.
* Frame numbers are counted from 1 (like in DICOM, unlike dcmimgle).
*/
unsigned long currentImageSelectedFrame;
/** a flag describing whether the presentation state is owner of
* the DICOM dataset in currentImageDataset/currentImageFileformat.
* If the presentation state is owner, it will delete the dataset
* upon its own destruction or attachment of a different image.
*/
OFBool currentImageOwned;
/** a flag describing whether the VOI settings in currentImage
* match the ones in the presentation state.
*/
OFBool currentImageVOIValid;
/** a flag describing whether the presentation LUT settings
* in currentImage match the ones in the presentation state.
*/
OFBool currentImagePLUTValid;
/** a flag describing whether currentImage has been flipped
*/
OFBool currentImageFlip;
/** a flag describing the current rotation angle of currentImage
*/
DVPSRotationType currentImageRotation;
/** a flag describing whether the Overlay settings in
* currentImage match the ones in the presentation state.
* values: 0=invalid, 1=invalid, but no external overlay added, 2=valid
*/
int currentImageOverlaysValid;
/** list of curves of the currently attached image
*/
DVPSCurve_PList currentImageCurveList;
/** list of VOI LUTs of the currently attached image
*/
DVPSVOILUT_PList currentImageVOILUTList;
/** list of VOI Windows of the currently attached image
*/
DVPSVOIWindow_PList currentImageVOIWindowList;
/** modality of currently attached image (if any)
*/
DcmCodeString currentImageModality;
/** true if attached image is MONOCHROME1
*/
OFBool currentImageMonochrome1;
/** flag indicating the currently selected display transform
* DVPSD_none if switched off
*/
DVPSDisplayTransform displayTransform;
/** a flag describing whether current image is inverse
*/
OFBool imageInverse;
/** reference to list of display functions if existing
*/
DiDisplayFunction **displayFunction;
/** minimum width of print bitmap (used for implicit scaling)
*/
unsigned long minimumPrintBitmapWidth;
/** minimum height of print bitmap (used for implicit scaling)
*/
unsigned long minimumPrintBitmapHeight;
/** maximum width of print bitmap (used for implicit scaling)
*/
unsigned long maximumPrintBitmapWidth;
/** maximum height of print bitmap (used for implicit scaling)
*/
unsigned long maximumPrintBitmapHeight;
/** maximum width of (optional) preview image
*/
unsigned long maximumPreviewImageWidth;
/** maximum height of (optional) preview image
*/
unsigned long maximumPreviewImageHeight;
};
#endif
/*
* $Log: dvpstat.h,v $
* Revision 1.47 2010-10-14 13:16:37 joergr
* Updated copyright header. Added reference to COPYRIGHT file.
*
* Revision 1.46 2009-11-24 14:12:58 uli
* Switched to logging mechanism provided by the "new" oflog module.
*
* Revision 1.45 2009-05-28 10:55:38 joergr
* Fixed various Doxygen API documentation issues.
*
* Revision 1.44 2005/12/08 16:04:07 meichel
* Changed include path schema for all DCMTK header files
*
* Revision 1.43 2003/09/05 14:30:06 meichel
* Introduced new API methods that allow Displayed Areas to be queried
* and set either relative to the image (ignoring rotation and flip) or
* in absolute values as defined in the standard. Rotate and flip methods
* now adjust displayed areas in the presentation state.
*
* Revision 1.42 2003/08/27 14:57:19 meichel
* Splitted class DVPresentationState into a base class DcmPresentationState
* that does not depend on module dcmimgle and current derived class with
* public API identical to the previous version.
*
* Revision 1.41 2002/12/09 13:29:49 joergr
* Renamed parameter/local variable to avoid name clashes with global
* declaration left and/or right (used for as iostream manipulators).
*
* Revision 1.40 2001/09/26 15:36:17 meichel
* Adapted dcmpstat to class OFCondition
*
* Revision 1.39 2001/06/01 15:50:23 meichel
* Updated copyright header
*
* Revision 1.38 2000/11/13 15:50:43 meichel
* Added dcmpstat support methods for creating image references
* in SR documents.
*
* Revision 1.37 2000/07/04 15:58:03 joergr
* Added support for overriding the presentation LUT settings made for the
* image boxes.
*
* Revision 1.36 2000/06/09 10:14:12 joergr
* Added support for rendering inverse presentation LUT into print bitmaps.
*
* Revision 1.35 2000/06/08 17:36:51 joergr
* Corrected bug in addImageReferenceToPState().
*
* Revision 1.34 2000/06/02 16:00:53 meichel
* Adapted all dcmpstat classes to use OFConsole for log and error output
*
* Revision 1.33 2000/05/30 14:21:24 joergr
* Renamed some variables to avoid compiler warnings (reported by gcc 2.9x with
* additional compiler flags).
*
* Revision 1.32 2000/05/30 13:47:03 joergr
* Added support for multi-frame images and multiple references from a single
* presentation to a number of images.
* Removed methods which were already marked as "retired".
* Added new function allowing to set a VOILUT created from a given gamma
* value.
*
* Revision 1.31 2000/03/08 16:28:57 meichel
* Updated copyright header.
*
* Revision 1.30 2000/02/29 12:16:16 meichel
* Fixed bug in dcmpstat library that caused Monochrome1 images
* to be printed inverse if a Presentation LUT was applied.
*
* Revision 1.29 1999/11/15 19:02:16 joergr
* Changed behaviour of method getOverlayData(): parameter 'transp' replaced by
* 'fore' to specify the foreground color used for the overlay plane.
*
* Revision 1.28 1999/11/03 10:36:32 joergr
* Enhanced comments for methods dealing with arrays of pixel data.
*
* Revision 1.27 1999/10/20 10:49:20 joergr
* Enhanced method getOverlayData to support 12 bit data for print.
* Enhanced method convertPValueToDDL to support 12 bit data for print.
* Added support for a down-scaled preview image of the current DICOM image
* (e.g. useful for online-windowing or print preview).
*
* Revision 1.26 1999/10/19 16:24:50 meichel
* Corrected handling of MONOCHROME1 images when used with P-LUTs
*
* Revision 1.25 1999/10/13 14:11:57 meichel
* Added config file entries and access methods
* for user-defined VOI presets, log directory, verbatim logging
* and an explicit list of image display formats for each printer.
*
* Revision 1.24 1999/10/07 17:21:51 meichel
* Reworked management of Presentation LUTs in order to create tighter
* coupling between Softcopy and Print.
*
* Revision 1.23 1999/09/10 12:46:48 meichel
* Added implementations for a number of print API methods.
*
* Revision 1.22 1999/09/10 09:02:32 joergr
* Added support for CIELAB display function. New methods to handle display
* functions. Old methods are marked as retired and should be removed asap.
*
* Revision 1.21 1999/09/07 09:04:37 joergr
* Completed support for getting a print bitmap out of a pstate object.
*
* Revision 1.20 1999/09/01 16:14:42 meichel
* Added support for requested image size to print routines
*
* Revision 1.19 1999/08/27 15:57:58 meichel
* Added methods for saving hardcopy images and stored print objects
* either in file or in the local database.
*
* Revision 1.18 1999/08/25 16:48:01 joergr
* Added minimal support to get a print bitmap out of a pstate object.
*
* Revision 1.17 1999/07/30 13:34:51 meichel
* Added new classes managing Stored Print objects
*
* Revision 1.16 1999/07/22 16:39:13 meichel
* Adapted dcmpstat data structures and API to supplement 33 letter ballot text.
*
* Revision 1.15 1999/05/04 12:28:11 meichel
* Removed carriage returns
*
* Revision 1.14 1999/04/27 11:23:57 joergr
* Added method to check whether current image is inverse or not.
*
* Revision 1.13 1999/03/22 09:05:35 joergr
* Added parameter to get value of (transparent) background color for method
* getOverlayData.
*
* Revision 1.12 1999/03/03 13:26:06 joergr
* Added method to invert an image by changing the presentation state LUT or
* shape.
* Moved method 'isBartenTransformPossible()' from presentation state class to
* interface class.
*
* Revision 1.11 1999/03/02 13:01:02 joergr
* Added method to presentation state class that checks whether Barten
* transformation is possible or not.
*
* Revision 1.10 1999/02/25 18:40:08 joergr
* Added method to fill pixel data into an externally handled storage area.
*
* Revision 1.9 1999/02/18 11:36:38 meichel
* Added new method convertPValueToDDL() to DVPresentationState
* that maps P-Values to DDLs.
*
* Revision 1.8 1999/02/17 10:05:32 meichel
* Moved creation of Display Function object from DVPresentationState to
* DVInterface to avoid unnecessary re-reads.
*
* Revision 1.7 1999/02/09 15:58:57 meichel
* Implemented bitmap shutter activation amd method for
* exchanging graphic layers.
*
* Revision 1.6 1999/02/05 17:45:36 meichel
* Added config file entry for monitor characteristics file. Monitor charac-
* teristics are passed to dcmimage if present to activate Barten transform.
*
* Revision 1.5 1999/01/15 17:33:05 meichel
* added methods to DVPresentationState allowing to access the image
* references in the presentation state. Also added methods allowing to
* get the width and height of the attached image.
*
* Revision 1.4 1999/01/11 13:35:49 meichel
* added new methods getImageAspectRatio, getImageMinMaxPixelRange and
* getImageMinMaxPixelValue to class DVPresentationState.
*
* Revision 1.3 1998/12/22 17:57:07 meichel
* Implemented Presentation State interface for overlays,
* VOI LUTs, VOI windows, curves. Added test program that
* allows to add curve data to DICOM images.
*
* Revision 1.2 1998/12/14 16:10:35 meichel
* Implemented Presentation State interface for graphic layers,
* text and graphic annotations, presentation LUTs.
*
* Revision 1.1 1998/11/27 14:50:34 meichel
* Initial Release.
*
*
*/
|