/usr/include/dcmtk/dcmiod/iodutil.h is in libdcmtk-dev 3.6.1~20160216-4.
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 | /*
*
* Copyright (C) 2015, Open Connections GmbH
* All rights reserved. See COPYRIGHT file for details.
*
* This software and supporting documentation are maintained by
*
* OFFIS e.V.
* R&D Division Health
* Escherweg 2
* D-26121 Oldenburg, Germany
*
*
* Module: dcmiod
*
* Author: Michael Onken
*
* Purpose: Static helper functionality for dcmiod module
*
*/
#ifndef IODUTIL_H
#define IODUTIL_H
#include "dcmtk/config/osconfig.h"
#include "dcmtk/ofstd/oftraits.h" // for OFremove_pointer
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/dcmdata/dcelem.h"
#include "dcmtk/dcmdata/dcsequen.h"
#include "dcmtk/dcmdata/dcdatset.h"
#include "dcmtk/dcmdata/dcdatutl.h"
#include "dcmtk/dcmiod/ioddef.h"
#include "dcmtk/dcmiod/iodrules.h"
#include "dcmtk/dcmiod/iodtypes.h"
/** Class with helper functions used within the dcmiod module (and beyond)
*/
class DCMTK_DCMIOD_EXPORT DcmIODUtil
{
public:
/** Get element from dataset and check it for correct value multiplicity
* and type.
* @param dataset DICOM dataset from which the element should be retrieved.
* (Would be 'const' if the methods from 'dcmdata' would also
* (be 'const'.)
* @param delem DICOM element used to store the value (always creates
* a copy of the dataset element's value)
* @param vm Value multiplicity (according to the data dictionary) to be
* checked for. (See DcmElement::checkVM() for a list of valid
* values.) Interpreted as cardinality (number of items) for
* sequence attributes.
* @param type Value type (valid value: "1", "1C", "2", something else
* which is not checked)
* @param moduleName Optional module name to be printed (NULL: no module
* printed at all)
* @return EC_Normal if element could be retrieved and value is correct,
* an error code otherwise
*/
static OFCondition getAndCheckElementFromDataset(DcmItem &dataset,
DcmElement &delem,
const OFString &vm,
const OFString &type,
const char *moduleName = NULL);
/** Get element from dataset and check it for correct value multiplicity and
* type.
* @param dataset DICOM dataset from which the element should be retrieved.
* (Would be 'const' if the methods from 'dcmdata' would also
* be 'const')
* @param tagKey Tag key of the element to get
* @param delem DICOM element that is set to a copy of the dataset's
* orinal element
* @param vm Value multiplicity (according to the data dictionary) to be
* checked for. (See DcmElement::checkVM() for a list of valid
* values.) Interpreted as cardinality (number of items) for
* sequence attributes.
* @param type Value type (valid value: "1", "1C", "2", something else
* which is not checked)
* @param moduleName Optional module name to be printed (NULL: no module
* printed at all)
* @return EC_Normal if element could be retrieved and value is correct, an
* error code otherwise
*/
static OFCondition getAndCheckElementFromDataset(DcmItem &dataset,
const DcmTagKey& tagKey,
DcmElement*& delem,
const OFString &vm,
const OFString &type,
const char *moduleName = NULL);
/** Get element from dataset and check it for correct value multiplicity
* and type.
* @param dataset DICOM dataset from which the element should be retrieved.
* (Would be 'const' if the methods from 'dcmdata' would also
* be 'const'.)
* @param delem DICOM element used to store the value (always creates
* a copy of the value from the original element)
* @param rule Rule describing parameters to be checked on element
* @return EC_Normal if element could be retrieved and value is correct, an
* error code otherwise
*/
static OFCondition getAndCheckElementFromDataset(DcmItem &dataset,
DcmElement &delem,
const IODRule* rule);
/** Get element from dataset and check it for correct value multiplicity
* and type.
* @param dataset DICOM dataset from which the element should be retrieved.
* (Would be 'const' if the methods from 'dcmdata' would also
* be 'const')
* @param delem DICOM element that is set to a copy of the dataset's
* orinal element
* @param rule Rule describing parameters to be checked on element.
* @return EC_Normal if element could be retrieved and value is correct, an
* error code otherwise
*/
static OFCondition getAndCheckElementFromDataset(DcmItem &dataset,
DcmElement*& delem,
const IODRule* rule);
/** Get current date in DICOM 'DA' format (YYYYMMDD)
* @param dateString String used to store the current date.
* (empty string if current date could not be retrieved)
* @return Resulting character string
*/
static const OFString& currentDate(OFString &dateString);
/** Get current time in DICOM 'TM' format (HHMMSS)
* The optional UTC notation (e.g.\ +0100) is currently not supported.
* @param timeString String used to store the current time
* (empty string if current time could not be retrieved)
* @return Resulting character string, empty if time could not be retrieved
*/
static const OFString& currentTime(OFString &timeString);
/** Copy given element to the dataset
* The element is only added if 'result' is EC_Normal. A copy of the given
* element is created, i.e.\ the caller is responsible for deleting the
* original element handed to this function (if desired).
* @param result Reference to status variable (checked before adding and
* updated afterwards!)
* @param dataset Reference to DICOM dataset to which the element should
* be added
* @param delem Reference to DICOM element which should be added; a
* copy is created so caller is responsible for deleting delem (if
* desired).
* @param vm Value multiplicity (according to the data dictionary) to be
* checked for. (See DcmElement::checkVM() for a list of valid
* values.). Interpreted as cardinality (number of items) for
* sequence attributes.
* @param type Value type (valid value: "1", "2" or something else which
* is not checked)
* @param moduleName Optional module name to be printed (NULL: no module
* printed at all)
* @return Current value of 'result', EC_Normal if successful,
* an error code otherwise
*/
static OFCondition copyElementToDataset(OFCondition &result,
DcmItem &dataset,
const DcmElement &delem,
const OFString &vm,
const OFString &type,
const char *moduleName = NULL);
/** Copy given element to the dataset. The element is only added if 'result'
* is EC_Normal.
* @param result reference to status variable (checked before adding and
* updated afterwards!)
* @param dataset reference to DICOM dataset to which the element
* should be added
* @param delem reference to DICOM element which should be added; the value
* is copied from the original dataset's element
* @param rule Rule describing parameters to be checked on element.
* @return Current value of 'result', EC_Normal if successful, an error code
* otherwise
*/
static OFCondition copyElementToDataset(OFCondition &result,
DcmItem &dataset,
const DcmElement &delem,
const IODRule* rule);
/** Add given element to the dataset
* The element is only added if 'result' is EC_Normal and the 'delem'
* pointer is not NULL.
* @param result Reference to status variable (checked before adding and
* updated afterwards!)
* @param dataset Reference to DICOM dataset to which the element should
* be added
* @param delem Pointer to DICOM element which should be added. The element
* is always consumed by this function, i.e.\ insertion was succesful
* and therefore ownership is transferred to the dataset, or the
* element is deleted from memory if it could not be inserted.
* @param rule Rule describing parameters to be checked on element.
* @return Current value of 'result', EC_Normal if successful, an error code otherwise
*/
static OFCondition addElementToDataset(OFCondition &result,
DcmItem &dataset,
DcmElement *delem,
const IODRule* rule);
/** Check element value for correct value multiplicity and type.
* @param delem Pointer to DICOM element to be checked (might be NULL)
* @param tagKey DICOM tag of the DICOM element the parameter 'delem' points to
* @param vm Value multiplicity (according to the data dictionary) to be checked for.
* (See DcmElement::checkVM() for a list of valid values.)
* Interpreted as cardinality (number of items) for sequence attributes.
* @param type Value type (valid value: "1", "1C", "2", something else)
* @param searchCond Optional flag indicating the status of a previous 'search' function call
* @param moduleName Optional module name to be printed (default: "IOD" if NULL)
* @return EC_Normal if element value is correct, error otherwise
*/
static OFCondition checkElementValue(const DcmElement *delem,
const DcmTagKey &tagKey,
const OFString &vm,
const OFString &type,
const OFCondition &searchCond = EC_Normal,
const char *moduleName = NULL);
/** Check element value for correct value multiplicity and type.
* @param delem DICOM element to be checked
* @param vm Value multiplicity (according to the data dictionary) to be checked for.
* (See DcmElement::checkVM() for a list of valid values.)
* Interpreted as cardinality (number of items) for sequence attributes.
* @param type Value type (valid value: "1", "1C", "2", something else)
* @param searchCond Optional flag indicating the status of a previous 'search' function call
* @param moduleName Optional module name to be printed (default: "IOD" if NULL)
* @return EC_Normal if element value is correct, error otherwise
*/
static OFCondition checkElementValue(const DcmElement &delem,
const OFString &vm,
const OFString &type,
const OFCondition &searchCond = EC_Normal,
const char *moduleName = NULL);
/** Get string value from element
* @param delem DICOM element from which the string value should be retrieved
* @param stringValue Reference to variable in which the result should be stored.
* (This parameter is automatically cleared if an error occurs.)
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getStringValueFromElement(const DcmElement &delem,
OFString &stringValue,
const signed long pos);
/** Get string value from item
* @param key The tag key of the attribute whose value should be retrieved
* @param item The item to search the attribute in
* @param result Reference to variable in which the result should be stored.
* (This parameter is automatically cleared if an error occurs.)
* @param pos Index of the value to get (0..vm-1), -1 for all components
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getStringValueFromItem(const DcmTagKey& key,
DcmItem& item,
OFString& result,
const signed long& pos);
/** Get Float64 value from item
* @param key The tag key of the attribute whose value should be retrieved
* @param item The item to search the attribute in
* @param result Reference to variable in which the result should be stored.
* @param pos Index of the value to get (0..vm-1)
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getFloat64ValueFromItem(const DcmTagKey& key,
DcmItem& item,
Float64& result,
const unsigned long& pos);
/** Get Float64 values from item
* @param key The tag key of the attribute whose value should be retrieved
* @param item The item to search the attribute in
* @param result Reference to variable in which the result should be stored.
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getFloat64ValuesFromItem(const DcmTagKey& key,
DcmItem& item,
OFVector<Float64>& result);
/** Get Float64 value from element
* @param delem The element whose value should be retrieved
* @param result Reference to variable in which the result should be stored.
* @param pos Index of the value to get (0..vm-1)
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getFloat64ValueFromElement(const DcmElement &delem,
Float64& result,
const unsigned long pos);
/** Get Float64 values from element
* @param delem The element to get the value from
* @param result Reference to variable in which the result should be stored.
* @return EC_Normal if successful, an error code otherwise
*/
static OFCondition getFloat64ValuesFromElement(const DcmElement &delem,
OFVector<Float64>& result);
/** Set a DcmElement's content from Uint16 vector
* @param delem DICOM element to be filled
* @param values Vector use as a source for the values
* @param vm Value multiplicity (according to the data dictionary) to be
* checked for. (See DcmElement::checkVM() for a list of
* valid values.)
* @param check If OFTrue, then it is checked whether number of values
* conforms to the value provided by the vm parameter.
* @return Dtatus, EC_Normal if successful, an error code otherwise
*/
static OFCondition setUint16ValuesOnElement(DcmElement &delem,
const OFVector<Uint16>& values,
const OFString& vm,
const OFBool check);
/** Get Uint16 values from DcmElement
* @param delem DICOM element to read from
* @param values Vector used as destination for the values
* @return Status EC_Normal if successful, an error code otherwise
*/
static OFCondition getUint16ValuesFromElement(DcmElement &delem,
OFVector<Uint16>& values);
/** Returns single item from given sequence. Returns error number of items
* is 0 or more than 1.
* @param seq Sequence to read from.
* @param item The resulting item, NULL in case of error
* @param checkKey If given it is checked whether the given seq parameter
* matches the tag key provided in the checkKey parameter. If
* not, an error is returned.
* @return Status EC_Normal if successful, an error code otherwise
*/
static OFCondition getAndCheckSingleItem(DcmSequenceOfItems& seq,
DcmItem*& item,
const DcmTagKey& checkKey = DCM_UndefinedTagKey);
/** Copies Uint8 values from given element to destination container
* (must support push_back() method).
* @param elem the element to read from. If NULL, an error is returned.
* @param destination the container to store the Uint8 values to
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static OFCondition copyFromUint8Array(DcmElement* elem,
Container& destination)
{
if (elem == NULL)
return EC_IllegalParameter;
size_t vm = elem->getVM();
OFCondition result;
for (size_t count = 0; (count < vm) && result.good(); count ++)
{
Uint8 value;
result = elem->getUint8(value, count);
if ( result.good() )
{
destination.push_back(value);
}
}
if ( result.bad() )
{
destination.clear();
}
return result;
}
/** Check whether SOP Sclass UID matches the expected value
* @param item Item to read from. NULL value causes error return value.
* @param desiredSOPClass The value that is expected
* @param valueFound The value actually found (empty if no value could
* be retrieved)
* @return EC_Normal if value could be found and equals exptected value,
* EC_TagNotFound if SOP Class UID is not found in dataset,
* EC_InvalidValue if SOP class differs from expected value.
*/
static OFCondition checkSOPClass(DcmItem* item,
const OFString& desiredSOPClass,
OFString& valueFound);
/** Check whether given tag is a sequence tag
* @param key the tag key to be checked
* @param privateCreator The private creator to check for if tag is private
* @return OFTrue if given tag is a sequence tag, OFFalse otherwise
*/
static OFBool isSequenceTag(const DcmTagKey& key,
const OFString& privateCreator = "");
/** Reads items from DICOM sequence into container by creating a dedicated
* container item for each DICOM item. The container must support
* push_back(T) function and the container's element type T must support
* the read(DcmItem*) function.
* @param source The source sequence to read items from
* @param seqKey The sequence's tag key that is expected
* @param destination The destination container to read into
* @param cardinality Expected number of items.
* See DcmElement::checkVM() for a list of valid values.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Name of the module/macro this sequence is contained in. Used
* for error messages and can also be left empty.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static OFCondition readSubSequence(DcmSequenceOfItems* source,
const DcmTagKey& seqKey,
Container& destination,
const OFString& cardinality,
const OFString& type,
const OFString& module)
{
OFCondition result;
OFCondition exists = EC_Normal;
if (!source)
exists = EC_TagNotFound;
/* Check sequence and report errors as warnings, read anyway */
checkElementValue(source, seqKey, cardinality, type, exists, module.c_str());
if (source)
{
const unsigned long card = source->card();
for (unsigned long count = 0; count < card; count++)
{
DcmItem *item = source->getItem(count);
if (item != NULL)
{
// define the element type
typedef typename OFremove_pointer<typename Container::value_type>::type Element;
Element *newElem = new Element();
// read into container item (clears old data first)
if ( newElem != NULL)
{
result = (newElem)->read(*item, OFFalse /* no need to delete anything */);
if ( result.good() )
{
destination.push_back(newElem);
}
else
{
delete newElem;
DCMIOD_WARN("Could not read item #" << count << " from " << DcmTag(source->getTag()).getTagName() << " (skipping item): " << result.text() );
}
}
else
{
DCMIOD_ERROR("Could not store data from item #" << count << " from " << DcmTag(source->getTag()).getTagName() << " (skipping item): Memory exhausted?");
}
}
else
{
DCMIOD_WARN("Could not get item #" << count << " from " << DcmTag(source->getTag()).getTagName() << " (malformed data or internal error), skipping item");
}
}
}
else
{
result = EC_IllegalParameter;
}
return result;
}
/** Reads DICOM sequence into container by creating a dedicated container element
* for each DICOM item. The container must support push_back(T) function
* and the container's element type T must support the read(DcmItem*) function.
* @param source The source DICOM item read the sequence from
* @param seqKey The tag key of the sequence to be read
* @param destination The destination container to read into
* @param cardinality Eexpected number of items.
* See DcmElement::checkVM() for a list of valid values.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Nname of the module/macro this sequence is contained in. Used
* for error messages and can also be left empty.
* @return status EC_Normal if successful, an error code otherwise
*/
template <class Container>
static OFCondition readSubSequence(DcmItem& source,
const DcmTagKey& seqKey,
Container& destination,
const OFString& cardinality,
const OFString& type,
const OFString& module)
{
OFCondition result;
DcmSequenceOfItems *seq = NULL;
/* Get sequence and read it */
source.findAndGetSequence(seqKey, seq);
result = readSubSequence(seq, seqKey, destination, cardinality, type, module );
return result;
}
/** Reads DICOM sequence into container by creating a dedicated container
* element for each DICOM item. The container must support the
* push_back(T) function and the container's element type T must support
* the read(DcmItem*) function.
* @param source The source DICOM item read the sequence from
* @param seqKey The tag key of the sequence to be read
* @param destination The destination container to read into
* @param rule The rule for reading this sequence. If NULL, an error is returned.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static OFCondition readSubSequence(DcmItem& source,
const DcmTagKey& seqKey,
Container& destination,
IODRule *rule)
{
if (rule == NULL)
{
DCMIOD_ERROR("Cannot read sequence " << seqKey << " (no rule supplied)");
return IOD_EC_NoSuchRule;
}
return readSubSequence<Container>(source, seqKey, destination, rule->getVM(), rule->getType(), rule->getModule());
}
/** Reads single DICOM item from a specific sequence into a destination class.
* The container must support the read(DcmItem) function. If a single item
* (i.e.\ the first item of the specified sequence) cannot be read, an error
* is returned.
* @param source The source DICOM item read the sequence from
* @param seqKey The tag key of the sequence to be read
* @param destination The destination container to read into
* See DcmElement::checkVM() for a list of valid values.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Name of the module/macro this sequence is contained in.
* Used for error messages and can also be left empty.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static OFCondition readSingleItem(DcmItem& source,
const DcmTagKey& seqKey,
Container& destination,
const OFString& type,
const OFString& module)
{
OFCondition result;
/* Check sequence, reports cardinality and type errors as warnings */
checkSubSequence(result, source, seqKey, "1", type, module);
/* Try to read sequence into internal data (ignore errors as nuch as possible) */
DcmItem* item = NULL;
result = source.findAndGetSequenceItem(seqKey, item, 0);
if (item != NULL)
{
// read into Code Sequence Macro (clears old data first)
result = destination.read(*item, OFTrue /* clear old data */);
}
return result;
}
/** Reads single DICOM item from a specific sequence into a destination class.
* The container must support the read(DcmItem) function. If a single item
* (i.e.\ the first item of the specified sequence) cannot be read, an error
* is returned.
* @param source The source DICOM item read the sequence from
* @param seqKey The tag key of the sequence to be read
* @param destination The destination container to read into
* See DcmElement::checkVM() for a list of valid values.
* @param rule The rule (for the sequence) used for reading.
* @return EC_Normal if successful, an error code otherwise. If the rule
* equlas NULL, then nothing is read at all and an error is returned
* (IOD_EC_NoSuchRule), but no error is reported to the logger.
*/
template <class Container>
static OFCondition readSingleItem(DcmItem& source,
const DcmTagKey& seqKey,
Container& destination,
IODRule *rule = NULL)
{
if (rule == NULL)
{
DCMIOD_DEBUG("Will not read sequence " << seqKey << ": No rule supplied");
return IOD_EC_NoSuchRule;
}
return readSingleItem(source, seqKey, destination, rule->getType(), rule->getModule());
}
/** Write given container into a DICOM sequence that is created within the
* given item. The sequence is created from scratch, i.e.\ any old sequence
* (and its items) will be overwritten.
* @param result If writing is successful, result will contain EC_Normal.
* Otherwise an error code is set.
* @param seqKey The tag key of the sequence to be write
* @param source The source container to read from. Must support the
* write(DcmItem*) function.
* @param destination The DICOM destination item to write the sequence to
* See DcmElement::checkVM() for a list of valid values.
* @param cardinality Expected number of items (i.e.\ expected number of
* elements in source container). See DcmElement::checkVM() for a
* list of valid values.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Name of the module/macro this sequence is contained in. Used
* for error messages and can also be left empty.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static void writeSubSequence(OFCondition& result,
const DcmTagKey& seqKey,
Container& source,
DcmItem& destination,
const OFString& cardinality,
const OFString& type,
const OFString& module)
{
if ( result.good() )
{
// Delete old data
destination.findAndDeleteElement(seqKey);
// If we have meaningful data, write it
OFBool haveData = source.size() > 0;
if (haveData)
{
destination.insertEmptyElement(seqKey);
Uint32 count = 0;
typename Container::iterator it = source.begin();
while ( it != source.end() && result.good() )
{
if ( (*it) != NULL)
{
DcmItem *localItem = NULL;
// If item is NULL result.bad() is always true.
result = destination.findOrCreateSequenceItem(seqKey, localItem, -2 /* append new */);
if ( result.good() )
{
result = (*it)->write(*localItem);
if ( result.bad() )
{
destination.findAndDeleteSequenceItem(seqKey, -1 /* last */);
}
}
else
{
DCMIOD_ERROR("Could not insert item data #" << count << " of " << DcmTag(seqKey).getTagName() << " (internal error), ignoring");
}
}
else
{
DCMIOD_ERROR("Found uninitialized container item (NULL value) for sequence " << DcmTag(seqKey).getTagName() << " (internal error, skipping)");
}
count++;
it++;
}
}
// If we do not have data, create empty sequence if type 2
else if (type == "2")
{
destination.insertEmptyElement(seqKey);
}
// Check result
checkSubSequence(result, destination, seqKey, cardinality, type, module);
// Clean up if we did not have success */
if (result.bad())
{
destination.findAndDeleteElement(seqKey);
}
}
}
/** Write given container into a DICOM sequence that is created within the given item.
* The container. The sequence is created from scratch, i.e.\ any old sequence
* (and its items) will be overwritten.
* @param result If writing is successful, result will contain EC_Normal. Otherwise
* an error code is set.
* @param seqKey The tag key of the sequence to be write
* @param source The source container to read from. Must support the write(DcmItem*)
* function.
* @param destination The DICOM destination item to write the sequence to
* @param rule Rule describing the requirements for this sequence. If NULL
* an error is returned (IOD_EC_NoSuchRule), but no error error is reported
* to the logger.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static void writeSubSequence(OFCondition& result,
const DcmTagKey& seqKey,
Container& source,
DcmItem& destination,
IODRule* rule)
{
if ( result.good() )
{
if (rule == NULL)
{
DCMIOD_DEBUG("Will not write sequence " << seqKey << ": No rule supplied");
result = IOD_EC_NoSuchRule;
}
else
{
writeSubSequence<Container>(result, rule->getTagKey(), source, destination, rule->getVM(), rule->getType(), rule->getModule());
}
}
}
/** Writes given container into a DICOM item of a specific sequence. The
* sequence is created from scratch so that any old information will be lost.
* @param result If writing is successful, result will contain EC_Normal.
* Otherwise an error code is set.
* @param seqKey The tag key of the sequence to be written
* @param source The source container to read from. Must support the write(DcmItem*)
* function.
* @param destination The DICOM item that should hold the sequence
* (with a single item) in the end.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Name of the module/macro this sequence is contained in.
* Used for error messages and can also be left empty.
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static void writeSingleItem(OFCondition& result,
const DcmTagKey& seqKey,
Container& source,
DcmItem& destination,
const OFString& type,
const OFString& module)
{
if ( result.good() )
{
// Delete old data
destination.findAndDeleteElement(seqKey);
/* If we have data, write it */
OFCondition haveData = source.check(OFTrue /* Be quiet */);
if (haveData.good())
{
DcmItem *localItem = NULL;
// If item is NULL result.bad() is always true.
result = destination.findOrCreateSequenceItem(seqKey, localItem, 0);
if ( result.good() )
{
result = source.write(*localItem);
// It can happen that check() returns OK but no elements have to be
// written at all (e.g.\ if it contains only type 3 attributes). In that
// case a sequence with a single empty item is written which must be removed
// afterwards.
if (result.good() && (localItem->card() == 0) )
{
destination.findAndDeleteElement(seqKey);
}
}
}
/* If we do not have data, insert empty for type 2 */
else if (type == "2")
{
destination.insertEmptyElement(seqKey);
}
else if (type == "1C")
{
DCMIOD_TRACE("Skipping type 1C sequence " << seqKey << ": No data or imcomplete data available");
}
}
/* Check outcome */
checkSubSequence(result, destination, seqKey, "1", type, module);
}
/** Writes given container into a DICOM item of a specific sequence.
* The sequence is created from scratch so that any old information
* will be lost.
* @param result If writing is successful, result will contain EC_Normal.
* Otherwise an error code is set.
* @param seqKey The tag key of the sequence to be written
* @param source The source container to read from. Must support the
* write(DcmItem*) function.
* @param destination The DICOM item that should hold the sequence
* (with a single item) in the end.
* @param rule The rule for writing the given sequence
* @return EC_Normal if successful, an error code otherwise
*/
template <class Container>
static void writeSingleItem(OFCondition& result,
const DcmTagKey& seqKey,
Container& source,
DcmItem& destination,
IODRule *rule)
{
if (rule == NULL)
{
DCMIOD_ERROR("Cannot write sequence " << seqKey << " (no rule supplied)");
result = EC_CannotCheck;
}
writeSingleItem(result, seqKey, source, destination, rule->getType(), rule->getModule());
}
/** Check whether a given sequence exists in a given item and whether it conforms to
* to its requirement type
* @param result If sequence is valid, result is set to EC_Normal, otherwise
* to an error.
* @param surroundingItem The item that should contain the given sequence.
* @param seqKey The sequence to look for
* @param cardinality Expected number of items (i.e.\ expected number of
* elements in source container). See DcmElement::checkVM() for a
* list of valid values.
* @param type The sequence type as noted in part 3 of the DICOM standard,
* i.e.\ "1,1C,2,2C or 3".
* @param module Name of the module/macro this sequence is contained in.
* Used for error messages and can also be left empty.
* @return EC_Normal if successful, an error code otherwise
*/
static void checkSubSequence(OFCondition& result,
DcmItem& surroundingItem,
const DcmTagKey& seqKey,
const OFString& cardinality,
const OFString& type,
const OFString& module);
/** Deletes all elements from given container and calls "delete" on each
* of them to clear memory.
* @param container The container that should be cleared. Must contain
* pointers to objects that are allocated on the heap.
*/
template<class Container>
static void freeContainer(Container& container)
{
typename Container::iterator it = container.begin();
while (it != container.end())
{
delete *it;
it++;
}
container.clear();
}
/** Clones and copies all elements from source to destination container by
* copy constructing all elements.
* @param src The container that should be copied. Must contain pointers
* to objects that are allocated on the heap, and that are
* copy-constructable
* @param dst The container to copy the cloned elements to.
*/
template<class Container>
static void copyContainer(const Container& src, Container& dst)
{
typedef typename OFremove_pointer<typename Container::value_type>::type Element;
typename Container::const_iterator it = src.begin();
while (it != src.end())
{
if (*it != NULL)
{
Element *elem = new Element(**it);
dst.push_back ( elem );
}
else
{
DCMIOD_ERROR("Could not copy element while copying container: Element is NULL, skipping");
}
it++;
}
}
/** Function that takes a string representation of a tag key and
* converts it to a tag key instance if possible
* @param keyString String of the format "(gggg,eeee)"
* @return The tag key if it could be parsed, DCM_UndefinedTagKey is returned
* instead (0xffff,0xffff)
*/
static const DcmTagKey parseTagKey(const OFString& keyString);
/** Decompress given dataset if possible. Decompression codecs have to be
* registered beforehand.
* @param dset The dataset to decompress
* @return EC_Normal if decompression works, error otherwise
*/
static OFCondition decompress(DcmDataset& dset);
/** Create new Unique Identifier (UID)
* @param level 0: instance level, 1: Series level, >=2: Study level.
* Calling always with level=0 is not an error but will result
* in unique values, too.
* @return The UID created.
*/
static OFString createUID(const Uint8 level = 0);
private:
// We only have static functions so we do not need an instance of
// this class so far.
/** Undefined default constructor (only static functions)
*/
DcmIODUtil();
/** Undefined desctructor
*/
~DcmIODUtil();
};
#endif // IODUTIL_H
|