src/gdcmDicomDir.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDicomDir.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/08/19 13:15:05 $
   7   Version:   $Revision: 1.153 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 //-----------------------------------------------------------------------------
  20 //  For full DICOMDIR description, see:
  21 //  PS 3.3-2003, pages 731-750
  22 //-----------------------------------------------------------------------------
  23 #include "gdcmDicomDir.h"
  24 #include "gdcmDicomDirObject.h"
  25 #include "gdcmDicomDirStudy.h"
  26 #include "gdcmDicomDirSerie.h"
  27 #include "gdcmDicomDirVisit.h"
  28 #include "gdcmDicomDirImage.h"
  29 #include "gdcmDicomDirPatient.h"
  30 #include "gdcmDicomDirMeta.h"
  31 #include "gdcmDicomDirElement.h"
  32 #include "gdcmDirList.h"
  33 #include "gdcmUtil.h"
  34 #include "gdcmDebug.h"
  35 #include "gdcmGlobal.h"
  36 #include "gdcmFile.h"
  37 #include "gdcmSeqEntry.h"
  38 #include "gdcmSQItem.h"
  39 #include "gdcmValEntry.h"
  40
  41 #include <fstream>
  42 #include <string>
  43 #include <algorithm>
  44 #include <sys/types.h>
  45
  46 #ifdef _MSC_VER
  47 #   define getcwd _getcwd
  48 #endif
  49
  50 #if defined(_MSC_VER) || defined(__BORLANDC__)
  51 #   include <direct.h>
  52 #else
  53 #   include <unistd.h>
  54 #endif
  55 // ----------------------------------------------------------------------------
  56 //         Note for future developpers
  57 // ----------------------------------------------------------------------------
  58 //
  59 //  Dicom PS 3.3 describes the relationship between Directory Records, as follow
  60 //    (see also PS 4.3, 2004, page 50 for Entity-Relationship model)
  61 //
  62 //  Directory Record Type      Directory Record Types which may be included
  63 //                                in the next lower-level directory Entity
  64 //
  65 // (Root directory Entity)     PATIENT, TOPIC, PRIVATE
  66 //
  67 // PATIENT                     STUDY, PRIVATE
  68 //
  69 // STUDY                       SERIES, VISIT, RESULTS, STUDY COMPONENT, PRIVATE
  70 //
  71 // SERIES                      IMAGE, OVERLAYS, MODALITY LUT, VOI LUT,
  72 //                             CURVE, STORED PRINT, RT DOSE, RT STRUCTURE SET
  73 //                             RT PLAN, RT TREAT RECORD, PRESENTATION, WAVEFORM,
  74 //                             SR DOCUMENT, KEY OBJECT DOC, SPECTROSCOPY,
  75 //                             RAW DATA, REGISTRATION, FIDUCIAL, PRIVATE,
  76 //                             ENCAP DOC
  77 // IMAGE
  78 // OVERLAY
  79 // MODALITY LUT
  80 // VOI LUT
  81 // CURVE
  82 // STORED PRINT
  83 // RT DOSE
  84 // RT STRUCTURE SET
  85 // RT PLAN
  86 // RT TREAT RECORD
  87 // PRESENTATION
  88 // WAVEFORM
  89 // SR DOCUMENT
  90 // KEY OBJECT DOC
  91 // SPECTROSCOPY
  92 // RAW DATA
  93 // REGISTRATION
  94 // FIDUCIAL
  95 // PRIVATE
  96 // ENCAP DOC
  97 //
  98 // ----------------------
  99 // The current gdcm version only deals with :
 100 //
 101 // (Root directory Entity)     PATIENT
 102 // PATIENT                     STUDY
 103 // STUDY                       SERIES
 104 // STUDY                       VISIT
 105 // SERIES                      IMAGE
 106 // IMAGE                       /
 107 //
 108 // DicomDir::CreateDicomDir will have to be completed
 109 // Treelike structure management will have to be upgraded
 110 // ----------------------------------------------------------------------------
 111
 112 namespace gdcm
 113 {
 114 //-----------------------------------------------------------------------------
 115 // Constructor / Destructor
 116 /**
 117  * \brief   Constructor : creates an empty DicomDir
 118  */
 119 DicomDir::DicomDir()
 120          :Document( )
 121 {
 122    Initialize();  // sets all private fields to NULL
 123    ParseDir = false;
 124    NewMeta();
 125 }
 126
 127 #ifndef GDCM_LEGACY_REMOVE
 128 /**
 129  * \brief Constructor Parses recursively the directory and creates the DicomDir
 130  *        or uses an already built DICOMDIR, depending on 'parseDir' value.
 131  * @param fileName  name
 132  *                      - of the root directory (parseDir = true)
 133  *                      - of the DICOMDIR       (parseDir = false)
 134  * @param parseDir boolean
 135  *                      - true if user passed an entry point
 136  *                        and wants to explore recursively the directories
 137  *                      - false if user passed an already built DICOMDIR file
 138  *                        and wants to use it
 139  * @deprecated use : new DicomDir() + [ SetLoadMode(lm) + ] SetDirectoryName(name)
 140  *              or : new DicomDir() + SetFileName(name)
 141  */
 142 DicomDir::DicomDir(std::string const &fileName, bool parseDir ):
 143    Document( )
 144 {
 145    // At this step, Document constructor is already executed,
 146    // whatever user passed (either a root directory or a DICOMDIR)
 147    // and whatever the value of parseDir was.
 148    // (nothing is cheked in Document constructor, to avoid overhead)
 149
 150    ParseDir = parseDir;
 151    SetLoadMode (0x00000000); // concerns only dicom files
 152    SetFileName( fileName );
 153    Load( );
 154 }
 155 #endif
 156
 157 /**
 158  * \brief  Canonical destructor
 159  */
 160 DicomDir::~DicomDir()
 161 {
 162    SetStartMethod(NULL);
 163    SetProgressMethod(NULL);
 164    SetEndMethod(NULL);
 165
 166    ClearPatient();
 167    if ( MetaElems )
 168    {
 169       delete MetaElems;
 170    }
 171 }
 172
 173 //-----------------------------------------------------------------------------
 174 // Public
 175
 176 /**
 177  * \brief   Loader. use SetFileName(fn)
 178  *                  or SetLoadMode(lm) + SetDirectoryName(dn)  before !
 179  * @return false if file cannot be open or no swap info was found,
 180  *         or no tag was found.
 181  */
 182 bool DicomDir::Load( )
 183 {
 184    // We should clean out anything that already exists.
 185    Initialize();  // sets all private fields to NULL
 186
 187    if (!ParseDir)
 188    {
 189       if ( ! this->Document::Load( ) )
 190          return false;
 191    }
 192     return DoTheLoadingJob( );
 193 }
 194
 195  #ifndef GDCM_LEGACY_REMOVE
 196 /**
 197  * \brief   Loader. (DEPRECATED : kept not to break the API)
 198  * @param   fileName file to be open for parsing
 199  * @return false if file cannot be open or no swap info was found,
 200  *         or no tag was found.
 201  * @deprecated use SetFileName(n) + Load() instead
 202  */
 203 bool DicomDir::Load(std::string const &fileName )
 204 {
 205    // We should clean out anything that already exists.
 206    Initialize();  // sets all private fields to NULL
 207
 208    SetFileName( fileName );
 209    if (!ParseDir)
 210    {
 211       if ( ! this->Document::Load( ) )
 212          return false;
 213    }
 214    return DoTheLoadingJob( );
 215 }
 216
 217 /// DEPRECATED : use SetDirectoryName(dname) instead
 218 void DicomDir::SetParseDir(bool parseDir)
 219 {
 220    ParseDir = parseDir;
 221 }
 222 #endif
 223
 224 /**
 225  * \brief   Does the Loading Job (internal use only)
 226  * @return false if file cannot be open or no swap info was found,
 227  *         or no tag was found.
 228  */
 229 bool DicomDir::DoTheLoadingJob( )
 230 {
 231    // We should clean out anything that already exists.
 232    Initialize();  // sets all private fields to NULL
 233
 234    if (!ParseDir)
 235    {
 236    // Only if user passed a DICOMDIR
 237    // ------------------------------
 238       Fp = 0;
 239       if ( !OpenFile() )
 240       {
 241          return false;
 242       }
 243       if (!Document::Load() )
 244       {
 245          return false;
 246       }
 247
 248       if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse
 249       {
 250          gdcmWarningMacro( "Entry HT empty for file: "<< GetFileName());
 251          return false;
 252       }
 253       // Directory record sequence
 254       DocEntry *e = GetDocEntry(0x0004, 0x1220);
 255       if ( !e )
 256       {
 257          gdcmWarningMacro( "NO 'Directory record sequence' (0x0004,0x1220)"
 258                           << " in file " << GetFileName());
 259          return false;
 260       }
 261       else
 262          CreateDicomDir();
 263    }
 264    else
 265    {
 266    // Only if user passed a root directory
 267    // ------------------------------------
 268       if ( GetFileName() == "." )
 269       {
 270          // user passed '.' as Name
 271          // we get current directory name
 272          char dummy[1000];
 273          getcwd(dummy, (size_t)1000);
 274          SetFileName( dummy ); // will be converted into a string
 275       }
 276       NewMeta();
 277       gdcmWarningMacro( "Parse directory and create the DicomDir : "
 278                          << GetFileName() );
 279       ParseDirectory();
 280    }
 281    return true;
 282 }
 283
 284 /**
 285  * \brief  This predicate, based on hopefully reasonable heuristics,
 286  *         decides whether or not the current document was properly parsed
 287  *         and contains the mandatory information for being considered as
 288  *         a well formed and usable DicomDir.
 289  * @return true when Document is the one of a reasonable DicomDir,
 290  *         false otherwise.
 291  */
 292 bool DicomDir::IsReadable()
 293 {
 294    if ( Filetype == Unknown )
 295    {
 296       gdcmWarningMacro( "Wrong filetype");
 297       return false;
 298    }
 299    if ( !MetaElems )
 300    {
 301       gdcmWarningMacro( "Meta Elements missing in DicomDir");
 302       return false;
 303    }
 304    if ( Patients.size() <= 0 )
 305    {
 306       gdcmWarningMacro( "NO Patient in DicomDir");
 307       return false;
 308    }
 309
 310    return true;
 311 }
 312
 313 /**
 314  * \brief   adds *the* Meta to a partially created DICOMDIR
 315  */
 316 DicomDirMeta *DicomDir::NewMeta()
 317 {
 318    if ( MetaElems )
 319       delete MetaElems;
 320
 321    DocEntry *entry = GetFirstEntry();
 322    if ( entry )
 323    {
 324       MetaElems = new DicomDirMeta(true); // true = empty
 325
 326       entry = GetFirstEntry();
 327       while( entry )
 328       {
 329          if ( dynamic_cast<SeqEntry *>(entry) )
 330             break;
 331
 332          RemoveEntryNoDestroy(entry);
 333          MetaElems->AddEntry(entry);
 334
 335          entry = GetFirstEntry();
 336       }
 337    }
 338    else  // after root directory parsing
 339    {
 340       MetaElems = new DicomDirMeta(false); // false = not empty
 341    }
 342    MetaElems->SetSQItemNumber(0); // To avoid further missprinting
 343    return MetaElems;
 344 }
 345
 346 /**
 347  * \brief   adds a new Patient (with the basic elements) to a partially created
 348  *          DICOMDIR
 349  */
 350 DicomDirPatient *DicomDir::NewPatient()
 351 {
 352    DicomDirPatient *p = new DicomDirPatient();
 353    AddPatientToEnd( p );
 354    return p;
 355 }
 356
 357 /**
 358  * \brief   Remove all Patients
 359  */
 360 void DicomDir::ClearPatient()
 361 {
 362    for(ListDicomDirPatient::iterator cc = Patients.begin();
 363                                      cc!= Patients.end();
 364                                    ++cc)
 365    {
 366       delete *cc;
 367    }
 368    Patients.clear();
 369 }
 370
 371 /**
 372  * \brief   Get the first entry while visiting the DicomDirPatients
 373  * \return  The first DicomDirPatient if found, otherwhise NULL
 374  */
 375 DicomDirPatient *DicomDir::GetFirstPatient()
 376 {
 377    ItPatient = Patients.begin();
 378    if ( ItPatient != Patients.end() )
 379       return *ItPatient;
 380    return NULL;
 381 }
 382
 383 /**
 384  * \brief   Get the next entry while visiting the DicomDirPatients
 385  * \note : meaningfull only if GetFirstEntry already called
 386  * \return  The next DicomDirPatient if found, otherwhise NULL
 387  */
 388 DicomDirPatient *DicomDir::GetNextPatient()
 389 {
 390    gdcmAssertMacro (ItPatient != Patients.end());
 391
 392    ++ItPatient;
 393    if ( ItPatient != Patients.end() )
 394       return *ItPatient;
 395    return NULL;
 396 }
 397
 398 /**
 399  * \brief  fills the whole structure, starting from a root Directory
 400  */
 401 void DicomDir::ParseDirectory()
 402 {
 403    CreateDicomDirChainedList( GetFileName() );
 404    CreateDicomDir();
 405 }
 406
 407 /**
 408  * \brief   Set the start method to call when the parsing of the
 409  *          directory starts.
 410  * @param   method Method to call
 411  * @param   arg    Argument to pass to the method
 412  * @param   argDelete    Argument
 413  * \warning In python : the arg parameter isn't considered
 414  */
 415 void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg,
 416                                DicomDir::Method *argDelete )
 417 {
 418    if ( StartArg && StartMethodArgDelete )
 419    {
 420       StartMethodArgDelete( StartArg );
 421    }
 422
 423    StartMethod          = method;
 424    StartArg             = arg;
 425    StartMethodArgDelete = argDelete;
 426 }
 427
 428
 429 /**
 430  * \brief   Set the progress method to call when the parsing of the
 431  *          directory progress
 432  * @param   method Method to call
 433  * @param   arg    Argument to pass to the method
 434  * @param   argDelete    Argument
 435  * \warning In python : the arg parameter isn't considered
 436  */
 437 void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg,
 438                                   DicomDir::Method *argDelete )
 439 {
 440    if ( ProgressArg && ProgressMethodArgDelete )
 441    {
 442       ProgressMethodArgDelete( ProgressArg );
 443    }
 444
 445    ProgressMethod          = method;
 446    ProgressArg             = arg;
 447    ProgressMethodArgDelete = argDelete;
 448 }
 449
 450 /**
 451  * \brief   Set the end method to call when the parsing of the directory ends
 452  * @param   method Method to call
 453  * @param   arg    Argument to pass to the method
 454  * @param   argDelete    Argument
 455  * \warning In python : the arg parameter isn't considered
 456  */
 457 void DicomDir::SetEndMethod( DicomDir::Method *method, void *arg,
 458                              DicomDir::Method *argDelete )
 459 {
 460    if ( EndArg && EndMethodArgDelete )
 461    {
 462       EndMethodArgDelete( EndArg );
 463    }
 464
 465    EndMethod          = method;
 466    EndArg             = arg;
 467    EndMethodArgDelete = argDelete;
 468 }
 469
 470 /**
 471  * \brief   Set the method to delete the argument
 472  *          The argument is destroyed when the method is changed or when the
 473  *          class is destroyed
 474  * @param   method Method to call to delete the argument
 475  */
 476 void DicomDir::SetStartMethodArgDelete( DicomDir::Method *method )
 477 {
 478    StartMethodArgDelete = method;
 479 }
 480
 481 /**
 482  * \brief   Set the method to delete the argument
 483  *          The argument is destroyed when the method is changed or when the
 484  *          class is destroyed
 485  * @param   method Method to call to delete the argument
 486  */
 487 void DicomDir::SetProgressMethodArgDelete( DicomDir::Method *method )
 488 {
 489    ProgressMethodArgDelete = method;
 490 }
 491
 492 /**
 493  * \brief   Set the method to delete the argument
 494  *          The argument is destroyed when the method is changed or when
 495  *          the class is destroyed
 496  * @param   method Method to call to delete the argument
 497  */
 498 void DicomDir::SetEndMethodArgDelete( DicomDir::Method *method )
 499 {
 500    EndMethodArgDelete = method;
 501 }
 502
 503 /**
 504  * \brief    writes on disc a DICOMDIR
 505  * \ warning does NOT add the missing elements in the header :
 506  *           it's up to the user doing it !
 507  * @param  fileName file to be written to
 508  * @return false only when fail to open
 509  */
 510
 511 bool DicomDir::WriteDicomDir(std::string const &fileName)
 512 {
 513    int i;
 514    uint16_t sq[4] = { 0x0004, 0x1220, 0xffff, 0xffff };
 515    uint16_t sqt[4]= { 0xfffe, 0xe0dd, 0xffff, 0xffff };
 516
 517    std::ofstream *fp = new std::ofstream(fileName.c_str(),
 518                                          std::ios::out | std::ios::binary);
 519    if ( !fp )
 520    {
 521       gdcmWarningMacro("Failed to open(write) File: " << fileName.c_str());
 522       return false;
 523    }
 524
 525    char filePreamble[128];
 526    memset(filePreamble, 0, 128);
 527    fp->write(filePreamble, 128);
 528    binary_write( *fp, "DICM");
 529
 530    DicomDirMeta *ptrMeta = GetMeta();
 531    ptrMeta->WriteContent(fp, ExplicitVR);
 532
 533    // force writing 0004|1220 [SQ ], that CANNOT exist within DicomDirMeta
 534    for(i=0;i<4;++i)
 535    {
 536       binary_write(*fp, sq[i]);
 537    }
 538
 539    for(ListDicomDirPatient::iterator cc  = Patients.begin();
 540                                      cc != Patients.end();
 541                                    ++cc )
 542    {
 543       (*cc)->WriteContent( fp, ExplicitVR );
 544    }
 545
 546    // force writing Sequence Delimitation Item
 547    for(i=0;i<4;++i)
 548    {
 549       binary_write(*fp, sqt[i]);  // fffe e0dd ffff ffff
 550    }
 551
 552    fp->close();
 553    delete fp;
 554
 555    return true;
 556 }
 557
 558 /**
 559  * \brief    Anonymize a DICOMDIR
 560  * @return true
 561  */
 562
 563 bool DicomDir::AnonymizeDicomDir()
 564 {
 565    ValEntry *v;
 566    // Something clever to be found to forge the Patient names
 567    std::ostringstream s;
 568    int i = 1;
 569    for(ListDicomDirPatient::iterator cc = Patients.begin();
 570                                      cc!= Patients.end();
 571                                    ++cc)
 572    {
 573       s << i;
 574       v = (*cc)->GetValEntry(0x0010, 0x0010) ; // Patient's Name
 575       if (v)
 576       {
 577          v->SetValue(s.str());
 578       }
 579
 580       v = (*cc)->GetValEntry(0x0010, 0x0020) ; // Patient ID
 581       if (v)
 582       {
 583          v->SetValue(" ");
 584       }
 585
 586       v = (*cc)->GetValEntry(0x0010, 0x0030) ; // Patient's BirthDate
 587       if (v)
 588       {
 589          v->SetValue(" ");
 590       }
 591       s << "";
 592       i++;
 593    }
 594    return true;
 595 }
 596
 597 //-----------------------------------------------------------------------------
 598 // Protected
 599 /**
 600  * \brief create a Document-like chained list from a root Directory
 601  * @param path entry point of the tree-like structure
 602  */
 603 void DicomDir::CreateDicomDirChainedList(std::string const &path)
 604 {
 605    CallStartMethod();
 606    DirList dirList(path,1); // gets recursively the file list
 607    unsigned int count = 0;
 608    VectDocument list;
 609    File *f;
 610
 611    DirListType fileList = dirList.GetFilenames();
 612
 613    for( DirListType::iterator it  = fileList.begin();
 614                               it != fileList.end();
 615                               ++it )
 616    {
 617       Progress = (float)(count+1)/(float)fileList.size();
 618       CallProgressMethod();
 619       if ( Abort )
 620       {
 621          break;
 622       }
 623
 624    f = new File( );
 625    f->SetLoadMode(LoadMode); // we allow user not to load Sequences, or Shadow
 626                              //             groups, or ......
 627    f->SetFileName( it->c_str() );
 628    /*int res = */f->Load( );
 629
 630 //     if ( !f )
 631 //     {
 632 //         gdcmWarningMacro( "Failure in new gdcm::File " << it->c_str() );
 633 //         continue;
 634 //      }
 635
 636       if ( f->IsReadable() )
 637       {
 638          // Add the file to the chained list:
 639          list.push_back(f);
 640          gdcmWarningMacro( "Readable " << it->c_str() );
 641        }
 642        else
 643        {
 644           delete f;
 645        }
 646        count++;
 647    }
 648    // sorts Patient/Study/Serie/
 649    std::sort(list.begin(), list.end(), DicomDir::HeaderLessThan );
 650
 651    std::string tmp = dirList.GetDirName();
 652    //for each File of the chained list, add/update the Patient/Study/Serie/Image info
 653    SetElements(tmp, list);
 654    CallEndMethod();
 655
 656    for(VectDocument::iterator itDoc=list.begin();
 657        itDoc!=list.end();
 658        ++itDoc)
 659    {
 660       delete dynamic_cast<File *>(*itDoc);
 661    }
 662 }
 663
 664 /**
 665  * \brief   CallStartMethod
 666  */
 667 void DicomDir::CallStartMethod()
 668 {
 669    Progress = 0.0f;
 670    Abort    = false;
 671    if ( StartMethod )
 672    {
 673       StartMethod( StartArg );
 674    }
 675 }
 676
 677 /**
 678  * \brief   CallProgressMethod
 679  */
 680 void DicomDir::CallProgressMethod()
 681 {
 682    if ( ProgressMethod )
 683    {
 684       ProgressMethod( ProgressArg );
 685    }
 686 }
 687
 688 /**
 689  * \brief   CallEndMethod
 690  */
 691 void DicomDir::CallEndMethod()
 692 {
 693    Progress = 1.0f;
 694    if ( EndMethod )
 695    {
 696       EndMethod( EndArg );
 697    }
 698 }
 699
 700 //-----------------------------------------------------------------------------
 701 // Private
 702 /**
 703  * \brief Sets all fields to NULL
 704  */
 705 void DicomDir::Initialize()
 706 {
 707    StartMethod             = NULL;
 708    ProgressMethod          = NULL;
 709    EndMethod               = NULL;
 710    StartMethodArgDelete    = NULL;
 711    ProgressMethodArgDelete = NULL;
 712    EndMethodArgDelete      = NULL;
 713    StartArg                = NULL;
 714    ProgressArg             = NULL;
 715    EndArg                  = NULL;
 716
 717    Progress = 0.0;
 718    Abort = false;
 719
 720    MetaElems = NULL;
 721 }
 722
 723 /**
 724  * \brief create a 'gdcm::DicomDir' from a DICOMDIR Header
 725  */
 726 void DicomDir::CreateDicomDir()
 727 {
 728    // The SeqEntries of "Directory Record Sequence" are parsed.
 729    //  When a DicomDir tag ("PATIENT", "STUDY", "SERIE", "IMAGE") is found :
 730    //  1 - we save the beginning iterator
 731    //  2 - we continue to parse
 732    //  3 - we find an other tag
 733    //       + we create the object for the precedent tag
 734    //       + loop to 1 -
 735
 736    // Directory record sequence
 737    DocEntry *e = GetDocEntry(0x0004, 0x1220);
 738    if ( !e )
 739    {
 740       gdcmWarningMacro( "No Directory Record Sequence (0004,1220) found");
 741       return;
 742    }
 743
 744    SeqEntry *s = dynamic_cast<SeqEntry *>(e);
 745    if ( !s )
 746    {
 747       gdcmWarningMacro( "Element (0004,1220) is not a Sequence ?!?");
 748       return;
 749    }
 750
 751    NewMeta();
 752
 753    DocEntry *d;
 754    std::string v;
 755    SQItem *si;
 756
 757    SQItem *tmpSI=s->GetFirstSQItem();
 758    while(tmpSI)
 759    {
 760       d = tmpSI->GetDocEntry(0x0004, 0x1430); // Directory Record Type
 761       if ( ValEntry* valEntry = dynamic_cast<ValEntry *>(d) )
 762       {
 763          v = valEntry->GetValue();
 764       }
 765       else
 766       {
 767          gdcmWarningMacro( "(0004,1430) not a ValEntry ?!?");
 768          continue;
 769       }
 770
 771       // A decent DICOMDIR has much more images than series,
 772       // more series than studies, and so on.
 773       // This is the right order to preform the tests
 774
 775       if ( v == "IMAGE " )
 776       {
 777          si = new DicomDirImage(true);
 778          if ( !AddImageToEnd( static_cast<DicomDirImage *>(si)) )
 779          {
 780             delete si;
 781             si = NULL;
 782             gdcmErrorMacro( "Add AddImageToEnd failed");
 783          }
 784       }
 785       else if ( v == "SERIES" )
 786       {
 787          si = new DicomDirSerie(true);
 788          if ( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
 789          {
 790             delete si;
 791             si = NULL;
 792             gdcmErrorMacro( "Add AddSerieToEnd failed");
 793          }
 794       }
 795       else if ( v == "VISIT " )
 796       {
 797          si = new DicomDirVisit(true);
 798          if ( !AddVisitToEnd( static_cast<DicomDirVisit *>(si)) )
 799          {
 800             delete si;
 801             si = NULL;
 802             gdcmErrorMacro( "Add AddVisitToEnd failed");
 803          }
 804       }
 805       else if ( v == "STUDY " )
 806       {
 807          si = new DicomDirStudy(true);
 808          if ( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) )
 809          {
 810             delete si;
 811             si = NULL;
 812             gdcmErrorMacro( "Add AddStudyToEnd failed");
 813          }
 814       }
 815       else if ( v == "PATIENT " )
 816       {
 817          si = new DicomDirPatient(true);
 818          if ( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) )
 819          {
 820             delete si;
 821             si = NULL;
 822             gdcmErrorMacro( "Add PatientToEnd failed");
 823          }
 824       }
 825       else
 826       {
 827          // It was neither a 'PATIENT', nor a 'STUDY', nor a 'SERIE',
 828          // nor an 'IMAGE' SQItem. Skip to next item.
 829          gdcmWarningMacro( " -------------------------------------------"
 830          << "a non PATIENT/STUDY/SERIE/IMAGE SQItem was found : "
 831          << v);
 832
 833         // FIXME : deal with other item types !
 834         tmpSI=s->GetNextSQItem(); // To avoid infinite loop
 835         continue;
 836       }
 837       if ( si )
 838          //MoveSQItem(si,tmpSI); // Old code : Copies each Entry
 839                                  //  -and then removes the source-
 840          si->MoveObject(tmpSI);  // New code : Copies the List
 841
 842       tmpSI=s->GetNextSQItem();
 843    }
 844    ClearEntry();
 845 }
 846
 847 /**
 848  * \brief  AddPatientToEnd
 849  * @param   dd SQ Item to enqueue to the DicomPatient chained List
 850  */
 851 bool DicomDir::AddPatientToEnd(DicomDirPatient *dd)
 852 {
 853    Patients.push_back(dd);
 854    return true;
 855 }
 856
 857 /**
 858  * \brief  AddStudyToEnd
 859  * @param   dd SQ Item to enqueue to the DicomDirStudy chained List
 860  */
 861 bool DicomDir::AddStudyToEnd(DicomDirStudy *dd)
 862 {
 863    if ( Patients.size() > 0 )
 864    {
 865       ListDicomDirPatient::iterator itp = Patients.end();
 866       itp--;
 867       (*itp)->AddStudy(dd);
 868       return true;
 869    }
 870    return false;
 871 }
 872
 873 /**
 874  * \brief  AddSerieToEnd
 875  * @param   dd SQ Item to enqueue to the DicomDirSerie chained List
 876  */
 877 bool DicomDir::AddSerieToEnd(DicomDirSerie *dd)
 878 {
 879    if ( Patients.size() > 0 )
 880    {
 881       ListDicomDirPatient::iterator itp = Patients.end();
 882       itp--;
 883
 884       DicomDirStudy *study = (*itp)->GetLastStudy();
 885       if ( study )
 886       {
 887          study->AddSerie(dd);
 888          return true;
 889       }
 890    }
 891    return false;
 892 }
 893
 894 /**
 895  * \brief  AddVisitToEnd
 896  * @param   dd SQ Item to enqueue to the DicomDirVisit chained List
 897  */
 898 bool DicomDir::AddVisitToEnd(DicomDirVisit *dd)
 899 {
 900    if ( Patients.size() > 0 )
 901    {
 902       ListDicomDirPatient::iterator itp = Patients.end();
 903       itp--;
 904
 905       DicomDirStudy *study = (*itp)->GetLastStudy();
 906       if ( study )
 907       {
 908          study->AddVisit(dd);
 909          return true;
 910       }
 911    }
 912    return false;
 913 }
 914 /**
 915  * \brief   AddImageToEnd
 916  * @param   dd SQ Item to enqueue to the DicomDirImage chained List
 917  */
 918 bool DicomDir::AddImageToEnd(DicomDirImage *dd)
 919 {
 920    if ( Patients.size() > 0 )
 921    {
 922       ListDicomDirPatient::iterator itp = Patients.end();
 923       itp--;
 924
 925       DicomDirStudy *study = (*itp)->GetLastStudy();
 926       if ( study )
 927       {
 928          DicomDirSerie *serie = study->GetLastSerie();
 929          if ( serie )
 930          {
 931             serie->AddImage(dd);
 932             return true;
 933          }
 934       }
 935    }
 936    return false;
 937 }
 938
 939 /**
 940  * \brief  for each Header of the chained list,
 941  *         add/update the Patient/Study/Serie/Image info
 942  * @param   path path of the root directory
 943  * @param   list chained list of Headers
 944  */
 945 void DicomDir::SetElements(std::string const &path, VectDocument const &list)
 946 {
 947    ClearEntry();
 948    ClearPatient();
 949
 950    std::string patPrevName         = "", patPrevID  = "";
 951    std::string studPrevInstanceUID = "", studPrevID = "";
 952    std::string serPrevInstanceUID  = "", serPrevID  = "";
 953
 954    std::string patCurName,         patCurID;
 955    std::string studCurInstanceUID, studCurID;
 956    std::string serCurInstanceUID,  serCurID;
 957
 958    bool first = true;
 959    for( VectDocument::const_iterator it = list.begin();
 960                                      it != list.end();
 961                                    ++it )
 962    {
 963       // get the current file characteristics
 964       patCurName         = (*it)->GetEntryValue(0x0010,0x0010);
 965       patCurID           = (*it)->GetEntryValue(0x0010,0x0011);
 966       studCurInstanceUID = (*it)->GetEntryValue(0x0020,0x000d);
 967       studCurID          = (*it)->GetEntryValue(0x0020,0x0010);
 968       serCurInstanceUID  = (*it)->GetEntryValue(0x0020,0x000e);
 969       serCurID           = (*it)->GetEntryValue(0x0020,0x0011);
 970
 971       if ( patCurName != patPrevName || patCurID != patPrevID || first )
 972       {
 973          SetElement(path, GDCM_DICOMDIR_PATIENT, *it);
 974          first = true;
 975       }
 976
 977       // if new Study, deal with 'STUDY' Elements
 978       if ( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID
 979          || first )
 980       {
 981          SetElement(path, GDCM_DICOMDIR_STUDY, *it);
 982          first = true;
 983       }
 984
 985       // if new Serie, deal with 'SERIE' Elements
 986       if ( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID
 987          || first )
 988       {
 989          SetElement(path, GDCM_DICOMDIR_SERIE, *it);
 990       }
 991
 992       // Always Deal with 'IMAGE' Elements
 993       SetElement(path, GDCM_DICOMDIR_IMAGE, *it);
 994
 995       patPrevName         = patCurName;
 996       patPrevID           = patCurID;
 997       studPrevInstanceUID = studCurInstanceUID;
 998       studPrevID          = studCurID;
 999       serPrevInstanceUID  = serCurInstanceUID;
1000       serPrevID           = serCurID;
1001       first = false;
1002    }
1003 }
1004
1005 /**
1006  * \brief   adds to the HTable
1007  *          the Entries (Dicom Elements) corresponding to the given type
1008  * @param   path full path file name (only used when type = GDCM_DICOMDIR_IMAGE
1009  * @param   type DicomDirObject type to create (GDCM_DICOMDIR_PATIENT,
1010  *          GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE ...)
1011  * @param   header Header of the current file
1012  */
1013 void DicomDir::SetElement(std::string const &path, DicomDirType type,
1014                           Document *header)
1015 {
1016    ListDicomDirElem elemList;
1017    ListDicomDirElem::const_iterator it;
1018    uint16_t tmpGr, tmpEl;
1019    DictEntry *dictEntry;
1020    ValEntry *entry;
1021    std::string val;
1022    SQItem *si;
1023
1024    switch( type )
1025    {
1026       case GDCM_DICOMDIR_IMAGE:
1027          elemList = Global::GetDicomDirElements()->GetDicomDirImageElements();
1028          si = new DicomDirImage(true);
1029          if ( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
1030          {
1031             delete si;
1032             gdcmErrorMacro( "Add ImageToEnd failed");
1033          }
1034          break;
1035       case GDCM_DICOMDIR_SERIE:
1036          elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements();
1037          si = new DicomDirSerie(true);
1038          if ( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
1039          {
1040             delete si;
1041             gdcmErrorMacro( "Add SerieToEnd failed");
1042          }
1043          break;
1044       case GDCM_DICOMDIR_STUDY:
1045          elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements();
1046          si = new DicomDirStudy(true);
1047          if ( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
1048          {
1049             delete si;
1050             gdcmErrorMacro( "Add StudyToEnd failed");
1051          }
1052          break;
1053       case GDCM_DICOMDIR_PATIENT:
1054          elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements();
1055          si = new DicomDirPatient(true);
1056          if ( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
1057          {
1058             delete si;
1059             gdcmErrorMacro( "Add PatientToEnd failed");
1060          }
1061          break;
1062       case GDCM_DICOMDIR_META:
1063          elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements();
1064          si = new DicomDirMeta(true);
1065          if ( MetaElems )
1066          {
1067             delete MetaElems;
1068             gdcmErrorMacro( "MetaElements already exist, they will be destroyed");
1069          }
1070          MetaElems = static_cast<DicomDirMeta *>(si);
1071          break;
1072       default:
1073          return;
1074    }
1075    // removed all the seems-to-be-useless stuff about Referenced Image Sequence
1076    // to avoid further troubles
1077    // imageElem 0008 1140 "" // Referenced Image Sequence
1078    // imageElem fffe e000 "" // 'no length' item : length to be set to 0xffffffff later
1079    // imageElem 0008 1150 "" // Referenced SOP Class UID    : to be set/forged later
1080    // imageElem 0008 1155 "" // Referenced SOP Instance UID : to be set/forged later
1081    // imageElem fffe e00d "" // Item delimitation : length to be set to ZERO later
1082
1083    // FIXME : troubles found when it's a SeqEntry
1084
1085    // for all the relevant elements found in their own spot of the DicomDir.dic
1086    for( it = elemList.begin(); it != elemList.end(); ++it)
1087    {
1088       tmpGr     = it->Group;
1089       tmpEl     = it->Elem;
1090       dictEntry = GetPubDict()->GetEntry(tmpGr, tmpEl);
1091
1092       entry     = new ValEntry( dictEntry ); // Be sure it's never a BinEntry !
1093
1094       entry->SetOffset(0); // just to avoid further missprinting
1095
1096       if ( header )
1097       {
1098          // NULL when we Build Up (ex nihilo) a DICOMDIR
1099          //   or when we add the META elems
1100          val = header->GetEntryValue(tmpGr, tmpEl);
1101       }
1102       else
1103       {
1104          val = GDCM_UNFOUND;
1105       }
1106
1107       if ( val == GDCM_UNFOUND)
1108       {
1109          if ( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID
1110          {
1111            // force to the *end* File Name
1112            val = Util::GetName( path );
1113          }
1114          else if ( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image
1115          {
1116             if ( header->GetFileName().substr(0, path.length()) != path )
1117             {
1118                gdcmWarningMacro( "The base path of file name is incorrect");
1119                val = header->GetFileName();
1120             }
1121             else
1122             {
1123                val = &(header->GetFileName().c_str()[path.length()]);
1124             }
1125          }
1126          else
1127          {
1128             val = it->Value;
1129          }
1130       }
1131       else
1132       {
1133          if ( header->GetEntryLength(tmpGr,tmpEl) == 0 )
1134             val = it->Value;
1135       }
1136
1137       entry->SetValue( val ); // troubles expected when vr=SQ ...
1138
1139       if ( type == GDCM_DICOMDIR_META ) // fusible : should never print !
1140       {
1141          gdcmWarningMacro("GDCM_DICOMDIR_META ?!? should never print that");
1142       }
1143       si->AddEntry(entry);
1144    }
1145 }
1146
1147 /**
1148  * \brief   Move the content of the source SQItem to the destination SQItem
1149  *          Only DocEntry's are moved
1150  * @param dst destination SQItem
1151  * @param src source SQItem
1152  */
1153 void DicomDir::MoveSQItem(DocEntrySet *dst,DocEntrySet *src)
1154 {
1155    DocEntry *entry;
1156
1157    entry = src->GetFirstEntry();
1158    while(entry)
1159    {
1160       src->RemoveEntryNoDestroy(entry);
1161       dst->AddEntry(entry);
1162       // we destroyed -> the current iterator is not longer valid
1163       entry = src->GetFirstEntry();
1164    }
1165 }
1166
1167 /**
1168  * \brief   compares two files
1169  */
1170 bool DicomDir::HeaderLessThan(Document *header1, Document *header2)
1171 {
1172    return *header1 < *header2;
1173 }
1174
1175 //-----------------------------------------------------------------------------
1176 // Print
1177 /**
1178  * \brief  Canonical Printer
1179  * @param   os ostream we want to print in
1180  * @param indent Indentation string to be prepended during printing
1181  */
1182 void DicomDir::Print(std::ostream &os, std::string const & )
1183 {
1184    if ( MetaElems )
1185    {
1186       MetaElems->SetPrintLevel(PrintLevel);
1187       MetaElems->Print(os);
1188    }
1189    for(ListDicomDirPatient::iterator cc  = Patients.begin();
1190                                      cc != Patients.end();
1191                                    ++cc)
1192    {
1193      (*cc)->SetPrintLevel(PrintLevel);
1194      (*cc)->Print(os);
1195    }
1196 }
1197
1198 //-----------------------------------------------------------------------------
1199 } // end namespace gdcm