1 /*=========================================================================
4 Module: $RCSfile: gdcmDicomDir.cxx,v $
6 Date: $Date: 2004/12/16 13:46:36 $
7 Version: $Revision: 1.90 $
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.
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.
17 =========================================================================*/
19 #include "gdcmDicomDir.h"
20 #include "gdcmDicomDirStudy.h"
21 #include "gdcmDicomDirSerie.h"
22 #include "gdcmDicomDirImage.h"
23 #include "gdcmDicomDirPatient.h"
24 #include "gdcmDicomDirMeta.h"
25 #include "gdcmDicomDirElement.h"
26 #include "gdcmDirList.h"
28 #include "gdcmDebug.h"
29 #include "gdcmGlobal.h"
30 #include "gdcmHeader.h"
31 #include "gdcmSeqEntry.h"
32 #include "gdcmSQItem.h"
33 #include "gdcmValEntry.h"
38 #include <sys/types.h>
41 #define getcwd _getcwd
44 #if defined( _MSC_VER) || defined(__BORLANDC__)
53 //-----------------------------------------------------------------------------
54 // For full DICOMDIR description, see:
55 // PS 3.3-2003, pages 731-750
56 //-----------------------------------------------------------------------------
57 // Constructor / Destructor
61 * \brief Constructor : creates an empty DicomDir
66 Initialize(); // sets all private fields to NULL
67 MetaElems = NewMeta();
71 * \brief Constructor Parses recursively the directory and creates the DicomDir
72 * or uses an already built DICOMDIR, depending on 'parseDir' value.
73 * @param fileName name
74 * - of the root directory (parseDir = true)
75 * - of the DICOMDIR (parseDir = false)
76 * @param parseDir boolean
77 * - true if user passed an entry point
78 * and wants to explore recursively the directories
79 * - false if user passed an already built DICOMDIR file
82 DicomDir::DicomDir(std::string const & fileName, bool parseDir ):
85 // Whatever user passed (a root directory or a DICOMDIR)
86 // and whatever the value of parseDir was,
87 // Document is already executed
88 Initialize(); // sets all private fields to NULL
90 // if user passed a root directory, sure we didn't get anything
91 if ( TagHT.begin() == TagHT.end() ) // when user passed a Directory to parse
93 dbg.Verbose(0, "DicomDir::DicomDir : entry HT empty");
95 if ( fileName.size() == 1 && fileName[0] == '.' )
97 // user passed '.' as Name
98 // we get current directory name
100 getcwd(dummy, (size_t)1000);
101 SetFileName( dummy ); // will be converted into a string
104 if ( parseDir ) // user asked for a recursive parsing of a root directory
106 MetaElems = NewMeta();
108 dbg.Verbose(0, "DicomDir::DicomDir : Parse directory"
109 " and create the DicomDir");
114 /// \todo if parseDir == false, it should be tagged as an error
115 // NON ! il suffit d'appeler ParseDirectory()
116 // apres le constructeur
119 else // Only if user passed a DICOMDIR
121 // Directory record sequence
122 DocEntry *e = GetDocEntryByNumber(0x0004, 0x1220);
125 dbg.Verbose(0, "DicomDir::DicomDir : NO Directory record"
126 " sequence (0x0004,0x1220)");
127 /// \todo FIXME : what do we do when the parsed file IS NOT a
136 * \brief Canonical destructor
138 DicomDir::~DicomDir()
140 SetStartMethod(NULL);
141 SetProgressMethod(NULL);
144 for(ListDicomDirPatient::iterator cc = Patients.begin();
156 //-----------------------------------------------------------------------------
159 * \brief Canonical Printer
161 void DicomDir::Print(std::ostream &os)
165 MetaElems->SetPrintLevel(PrintLevel);
166 MetaElems->Print(os);
168 for(ListDicomDirPatient::iterator cc = Patients.begin();
169 cc != Patients.end();
172 (*cc)->SetPrintLevel(PrintLevel);
177 //-----------------------------------------------------------------------------
180 * \brief This predicate, based on hopefully reasonable heuristics,
181 * decides whether or not the current header was properly parsed
182 * and contains the mandatory information for being considered as
183 * a well formed and usable DicomDir.
184 * @return true when Document is the one of a reasonable DicomDir,
187 bool DicomDir::IsReadable()
189 if( !Document::IsReadable() )
197 if( Patients.size() <= 0 )
206 * \brief Sets all fields to NULL
209 void DicomDir::Initialize()
212 ProgressMethod = NULL;
214 StartMethodArgDelete = NULL;
215 ProgressMethodArgDelete = NULL;
216 EndMethodArgDelete = NULL;
230 * \brief fills the whole structure, starting from a root Directory
232 void DicomDir::ParseDirectory()
234 CreateDicomDirChainedList( GetFileName() );
240 * \brief Set the start method to call when the parsing of the
242 * @param method Method to call
243 * @param arg Argument to pass to the method
244 * @param argDelete Argument
245 * \warning In python : the arg parameter isn't considered
247 void DicomDir::SetStartMethod( DicomDir::Method* method, void* arg,
248 DicomDir::Method* argDelete )
250 if( StartArg && StartMethodArgDelete )
252 StartMethodArgDelete( StartArg );
255 StartMethod = method;
257 StartMethodArgDelete = argDelete;
262 * \brief Set the method to delete the argument
263 * The argument is destroyed when the method is changed or when the
265 * @param method Method to call to delete the argument
267 void DicomDir::SetStartMethodArgDelete( DicomDir::Method* method )
269 StartMethodArgDelete = method;
274 * \brief Set the progress method to call when the parsing of the
276 * @param method Method to call
277 * @param arg Argument to pass to the method
278 * @param argDelete Argument
279 * \warning In python : the arg parameter isn't considered
281 void DicomDir::SetProgressMethod( DicomDir::Method* method, void* arg,
282 DicomDir::Method* argDelete )
284 if( ProgressArg && ProgressMethodArgDelete )
286 ProgressMethodArgDelete( ProgressArg );
289 ProgressMethod = method;
291 ProgressMethodArgDelete = argDelete;
296 * \brief Set the method to delete the argument
297 * The argument is destroyed when the method is changed or when the
299 * @param method Method to call to delete the argument
301 void DicomDir::SetProgressMethodArgDelete( DicomDir::Method* method )
303 ProgressMethodArgDelete = method;
308 * \brief Set the end method to call when the parsing of the directory ends
309 * @param method Method to call
310 * @param arg Argument to pass to the method
311 * @param argDelete Argument
312 * \warning In python : the arg parameter isn't considered
314 void DicomDir::SetEndMethod( DicomDir::Method* method, void* arg,
315 DicomDir::Method* argDelete )
317 if( EndArg && EndMethodArgDelete )
319 EndMethodArgDelete( EndArg );
324 EndMethodArgDelete = argDelete;
329 * \brief Set the method to delete the argument
330 * The argument is destroyed when the method is changed or when
331 * the class is destroyed
332 * @param method Method to call to delete the argument
334 void DicomDir::SetEndMethodArgDelete( DicomDir::Method* method )
336 EndMethodArgDelete = method;
341 * \brief writes on disc a DICOMDIR
342 * \ warning does NOT add the missing elements in the header :
343 * it's up to the user doing it !
344 * \todo : to be re-written using the DICOMDIR tree-like structure
345 * *not* the chained list
346 * (does NOT exist if the DICOMDIR is user-forged !)
347 * @param fileName file to be written to
348 * @return false only when fail to open
351 bool DicomDir::WriteDicomDir(std::string const& fileName)
354 uint16_t sq[4] = { 0x0004, 0x1220, 0xffff, 0xffff };
355 uint16_t sqt[4]= { 0xfffe, 0xe0dd, 0xffff, 0xffff };
357 std::ofstream* fp = new std::ofstream(fileName.c_str(),
358 std::ios::out | std::ios::binary);
361 dbg.Verbose(2, "Failed to open(write) File: ", fileName.c_str());
365 char filePreamble[128];
366 memset(filePreamble, 0, 128);
367 fp->write(filePreamble, 128); //FIXME
368 binary_write( *fp, "DICM");
370 DicomDirMeta *ptrMeta = GetDicomDirMeta();
371 ptrMeta->WriteContent(fp, ExplicitVR);
373 // force writing 0004|1220 [SQ ], that CANNOT exist within DicomDirMeta
376 binary_write(*fp, sq[i]);
379 for(ListDicomDirPatient::iterator cc = Patients.begin();
380 cc != Patients.end();
383 (*cc)->WriteContent( fp, ExplicitVR );
386 // force writing Sequence Delimitation Item
389 binary_write(*fp, sqt[i]); // fffe e0dd ffff ffff
398 //-----------------------------------------------------------------------------
403 * \brief create a Document-like chained list from a root Directory
404 * @param path entry point of the tree-like structure
406 void DicomDir::CreateDicomDirChainedList(std::string const & path)
409 DirList fileList(path,1); // gets recursively the file list
410 unsigned int count = 0;
414 for( DirList::iterator it = fileList.begin();
415 it != fileList.end();
418 Progress = (float)(count+1)/(float)fileList.size();
419 CallProgressMethod();
425 header = new Header( it->c_str() );
429 "DicomDir::CreateDicomDirChainedList: "
430 "failure in new Header ",
435 if( header->IsReadable() )
437 // Add the file header to the chained list:
438 list.push_back(header);
440 "DicomDir::CreateDicomDirChainedList: readable ",
449 // sorts Patient/Study/Serie/
450 std::sort(list.begin(), list.end(), DicomDir::HeaderLessThan );
452 std::string tmp = fileList.GetDirName();
453 //for each Header of the chained list, add/update the Patient/Study/Serie/Image info
454 SetElements(tmp, list);
457 for(VectDocument::iterator itDoc=list.begin();
461 delete dynamic_cast<Header *>(*itDoc);
467 * \brief adds *the* Meta to a partially created DICOMDIR
470 DicomDirMeta * DicomDir::NewMeta()
472 DicomDirMeta *m = new DicomDirMeta();
474 if ( TagHT.begin() != TagHT.end() ) // after Document Parsing
476 TagDocEntryHT::iterator lastOneButSequence = TagHT.end();
477 lastOneButSequence --;
478 // ALL the 'out of Sequence' Tags belong to Meta Elems
479 // (we skip 0004|1220 [Directory record sequence] )
480 for ( TagDocEntryHT::iterator cc = TagHT.begin();
481 cc != lastOneButSequence;
484 m->AddEntry( cc->second );
487 else // after root directory parsing
489 ListDicomDirMetaElem const & elemList =
490 Global::GetDicomDirElements()->GetDicomDirMetaElements();
491 m->FillObject(elemList);
493 m->SetSQItemNumber(0); // To avoid further missprinting
498 * \brief adds a new Patient (with the basic elements) to a partially created DICOMDIR
500 DicomDirPatient * DicomDir::NewPatient()
502 ListDicomDirPatientElem::const_iterator it;
503 uint16_t tmpGr,tmpEl;
504 DictEntry *dictEntry;
507 ListDicomDirPatientElem const & elemList =
508 Global::GetDicomDirElements()->GetDicomDirPatientElements();
509 DicomDirPatient *p = new DicomDirPatient();
511 // for all the DicomDirPatient Elements
512 for( it = elemList.begin(); it != elemList.end(); ++it )
516 dictEntry = GetPubDict()->GetDictEntryByNumber(tmpGr, tmpEl);
517 entry = new ValEntry( dictEntry );
518 entry->SetOffset(0); // just to avoid further missprinting
519 entry->SetValue( it->Value );
521 p->AddEntry( entry );
524 Patients.push_front( p );
530 * \brief adds to the HTable
531 * the Entries (Dicom Elements) corresponding to the given type
532 * @param path full path file name (only used when type = GDCM_DICOMDIR_IMAGE
533 * @param type DicomDirObject type to create (GDCM_DICOMDIR_PATIENT,
534 * GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE ...)
535 * @param header Header of the current file
537 void DicomDir::SetElement(std::string const & path, DicomDirType type,
540 ListDicomDirElem elemList; //FIXME this is going to be a by copy operation
541 ListDicomDirElem::const_iterator it;
542 uint16_t tmpGr, tmpEl;
543 DictEntry *dictEntry;
550 case GDCM_DICOMDIR_IMAGE:
551 elemList = Global::GetDicomDirElements()->GetDicomDirImageElements();
552 si = new DicomDirImage();
553 if( !AddDicomDirImageToEnd(static_cast<DicomDirImage *>(si)) )
555 dbg.Verbose(0,"DicomDir::SetElement:",
556 "Add DicomDirImageToEnd failed");
559 case GDCM_DICOMDIR_SERIE:
560 elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements();
561 si = new DicomDirSerie();
562 if( !AddDicomDirSerieToEnd(static_cast<DicomDirSerie *>(si)) )
564 dbg.Verbose(0,"DicomDir::SetElement:",
565 "Add DicomDirSerieToEnd failed");
568 case GDCM_DICOMDIR_STUDY:
569 elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements();
570 si = new DicomDirStudy();
571 if( !AddDicomDirStudyToEnd(static_cast<DicomDirStudy *>(si)) )
573 dbg.Verbose(0,"DicomDir::SetElement:",
574 "Add DicomDirStudyToEnd failed");
577 case GDCM_DICOMDIR_PATIENT:
578 elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements();
579 si = new DicomDirPatient();
580 if( !AddDicomDirPatientToEnd(static_cast<DicomDirPatient *>(si)) )
582 dbg.Verbose(0,"DicomDir::SetElement:",
583 "Add DicomDirPatientToEnd failed");
586 case GDCM_DICOMDIR_META:
587 elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements();
588 si = new DicomDirMeta();
591 dbg.Verbose(0,"DicomDir::SetElement:",
592 "MetaElements already exist, they will be destroyed");
595 MetaElems = static_cast<DicomDirMeta *>(si);
600 // removed all the seems-to-be-useless stuff about Referenced Image Sequence
601 // to avoid further troubles
602 // imageElem 0008 1140 "" // Referenced Image Sequence
603 // imageElem fffe e000 "" // 'no length' item : length to be set to 0xffffffff later
604 // imageElem 0008 1150 "" // Referenced SOP Class UID : to be set/forged later
605 // imageElem 0008 1155 "" // Referenced SOP Instance UID : to be set/forged later
606 // imageElem fffe e00d "" // Item delimitation : length to be set to ZERO later
607 // for all the relevant elements found in their own spot of the DicomDir.dic
608 // FIXME : troubles found when it's a SeqEntry
610 for( it = elemList.begin(); it != elemList.end(); ++it)
614 dictEntry = GetPubDict()->GetDictEntryByNumber(tmpGr, tmpEl);
616 entry = new ValEntry( dictEntry ); // Be sure it's never a BinEntry !
618 entry->SetOffset(0); // just to avoid further missprinting
622 // NULL when we Build Up (ex nihilo) a DICOMDIR
623 // or when we add the META elems
624 val = header->GetEntryByNumber(tmpGr, tmpEl);
631 if( val == GDCM_UNFOUND)
633 if( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID
635 // force to the *end* File Name
636 val = Util::GetName( path );
638 else if( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image
640 if( header->GetFileName().substr(0, path.length()) != path )
642 dbg.Verbose(0, "DicomDir::SetElement : the base path"
643 " of file name is incorrect");
644 val = header->GetFileName();
648 val = &(header->GetFileName().c_str()[path.length()]);
658 if ( header->GetEntryLengthByNumber(tmpGr,tmpEl) == 0 )
662 entry->SetValue( val ); // troubles expected when vr=SQ ...
664 if ( type == GDCM_DICOMDIR_META ) // fusible : should never print !
666 std::cout << "GDCM_DICOMDIR_META ?!? should never print that"
673 //-----------------------------------------------------------------------------
675 * \brief CallStartMethod
677 void DicomDir::CallStartMethod()
683 StartMethod( StartArg );
687 //-----------------------------------------------------------------------------
690 * \brief CallProgressMethod
692 void DicomDir::CallProgressMethod()
696 ProgressMethod( ProgressArg );
700 //-----------------------------------------------------------------------------
703 * \brief CallEndMethod
705 void DicomDir::CallEndMethod()
714 //-----------------------------------------------------------------------------
718 * \brief create a 'DicomDir' from a DICOMDIR Header
720 void DicomDir::CreateDicomDir()
722 // The list is parsed.
723 // When a DicomDir tag ("PATIENT", "STUDY", "SERIE", "IMAGE") is found :
724 // 1 - we save the beginning iterator
725 // 2 - we continue to parse
726 // 3 - we find an other tag
727 // + we create the object for the precedent tag
730 // Directory record sequence
731 DocEntry *e = GetDocEntryByNumber(0x0004, 0x1220);
734 dbg.Verbose(0, "DicomDir::DicomDir : NO Directory record"
735 " sequence (0x0004,0x1220)");
736 /// \todo FIXME: what to do when the parsed file IS NOT a DICOMDIR file ?
740 SeqEntry* s = dynamic_cast<SeqEntry*>(e);
743 dbg.Verbose(0, "DicomDir::CreateDicomDir: no SeqEntry present");
744 // useless : (0x0004,0x1220) IS a Sequence !
748 DicomDirType type; // = DicomDir::GDCM_DICOMDIR_META;
749 MetaElems = NewMeta();
751 ListSQItem listItems = s->GetSQItems();
756 for( ListSQItem::iterator i = listItems.begin();
757 i !=listItems.end(); ++i )
759 d = (*i)->GetDocEntryByNumber(0x0004, 0x1430); // Directory Record Type
760 if ( ValEntry* valEntry = dynamic_cast< ValEntry* >(d) )
762 v = valEntry->GetValue();
766 dbg.Verbose(0, "DicomDir::CreateDicomDir: not a ValEntry.");
770 if( v == "PATIENT " )
772 si = new DicomDirPatient();
773 AddDicomDirPatientToEnd( static_cast<DicomDirPatient *>(si) );
774 type = DicomDir::GDCM_DICOMDIR_PATIENT;
776 else if( v == "STUDY " )
778 si = new DicomDirStudy();
779 AddDicomDirStudyToEnd( static_cast<DicomDirStudy *>(si) );
780 type = DicomDir::GDCM_DICOMDIR_STUDY;
782 else if( v == "SERIES" )
784 si = new DicomDirSerie();
785 AddDicomDirSerieToEnd( static_cast<DicomDirSerie *>(si) );
786 type = DicomDir::GDCM_DICOMDIR_SERIE;
788 else if( v == "IMAGE " )
790 si = new DicomDirImage();
791 AddDicomDirImageToEnd( static_cast<DicomDirImage *>(si) );
792 type = DicomDir::GDCM_DICOMDIR_IMAGE;
796 // It was not a 'PATIENT', nor a 'STUDY', nor a 'SERIE',
797 // neither an 'IMAGE' SQItem. Skip to next item.
807 * \brief Well ... there is only one occurence
809 bool DicomDir::AddDicomDirMeta()
815 MetaElems = new DicomDirMeta();
821 * \brief AddDicomDirPatientToEnd
822 * @param s SQ Item to enqueue to the DicomPatient chained List
824 bool DicomDir::AddDicomDirPatientToEnd(DicomDirPatient *dd)
826 Patients.push_back(dd);
832 * \brief AddDicomDirStudyToEnd
833 * @param s SQ Item to enqueue to the DicomDirStudy chained List
835 bool DicomDir::AddDicomDirStudyToEnd(DicomDirStudy *dd)
837 if( Patients.size() > 0 )
839 ListDicomDirPatient::iterator itp = Patients.end();
841 (*itp)->AddDicomDirStudy(dd);
849 * \brief AddDicomDirSerieToEnd
850 * @param s SQ Item to enqueue to the DicomDirSerie chained List
852 bool DicomDir::AddDicomDirSerieToEnd(DicomDirSerie *dd)
854 if( Patients.size() > 0 )
856 ListDicomDirPatient::iterator itp = Patients.end();
859 if( (*itp)->GetDicomDirStudies().size() > 0 )
861 ListDicomDirStudy::const_iterator itst =
862 (*itp)->GetDicomDirStudies().end();
864 (*itst)->AddDicomDirSerie(dd);
873 * \brief AddDicomDirImageToEnd
874 * @param s SQ Item to enqueue to the DicomDirImage chained List
876 bool DicomDir::AddDicomDirImageToEnd(DicomDirImage *dd)
878 if( Patients.size() > 0 )
880 ListDicomDirPatient::iterator itp = Patients.end();
883 if( (*itp)->GetDicomDirStudies().size() > 0 )
885 ListDicomDirStudy::const_iterator itst =
886 (*itp)->GetDicomDirStudies().end();
889 if( (*itst)->GetDicomDirSeries().size() > 0 )
891 ListDicomDirSerie::const_iterator its = (*itst)->GetDicomDirSeries().end();
893 (*its)->AddDicomDirImage(dd);
903 * \brief for each Header of the chained list, add/update the Patient/Study/Serie/Image info
904 * @param path path of the root directory
905 * @param list chained list of Headers
907 void DicomDir::SetElements(std::string const & path, VectDocument const &list)
912 std::string patPrevName = "", patPrevID = "";
913 std::string studPrevInstanceUID = "", studPrevID = "";
914 std::string serPrevInstanceUID = "", serPrevID = "";
916 std::string patCurName, patCurID;
917 std::string studCurInstanceUID, studCurID;
918 std::string serCurInstanceUID, serCurID;
921 for( VectDocument::const_iterator it = list.begin();
922 it != list.end(); ++it )
924 // get the current file characteristics
925 patCurName = (*it)->GetEntryByNumber(0x0010,0x0010);
926 patCurID = (*it)->GetEntryByNumber(0x0010,0x0011);
927 studCurInstanceUID = (*it)->GetEntryByNumber(0x0020,0x000d);
928 studCurID = (*it)->GetEntryByNumber(0x0020,0x0010);
929 serCurInstanceUID = (*it)->GetEntryByNumber(0x0020,0x000e);
930 serCurID = (*it)->GetEntryByNumber(0x0020,0x0011);
932 if( patCurName != patPrevName || patCurID != patPrevID || first )
934 SetElement(path, GDCM_DICOMDIR_PATIENT, *it);
938 // if new Study Deal with 'STUDY' Elements
939 if( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID
942 SetElement(path, GDCM_DICOMDIR_STUDY, *it);
946 // if new Serie Deal with 'SERIE' Elements
947 if( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID
950 SetElement(path, GDCM_DICOMDIR_SERIE, *it);
954 // Always Deal with 'IMAGE' Elements
955 SetElement(path, GDCM_DICOMDIR_IMAGE, *it);
957 patPrevName = patCurName;
958 patPrevID = patCurID;
959 studPrevInstanceUID = studCurInstanceUID;
960 studPrevID = studCurID;
961 serPrevInstanceUID = serCurInstanceUID;
962 serPrevID = serCurID;
969 * \brief Move the content of the src SQItem to the dst SQItem
970 * Only DocEntry's are moved
973 void DicomDir::MoveSQItem(SQItem* dst,SQItem *src)
978 entry = src->GetNextEntry();
981 src->RemoveEntryNoDestroy(entry);
982 dst->AddEntry(entry);
985 entry = src->GetNextEntry();
991 * \brief compares two dgcmHeaders
993 bool DicomDir::HeaderLessThan(Document *header1, Document *header2)
995 return *header1 < *header2;
997 } // end namespace gdcm
999 //-----------------------------------------------------------------------------