1 /*=========================================================================
4 Module: $RCSfile: gdcmDicomDir.cxx,v $
6 Date: $Date: 2005/01/21 11:40:55 $
7 Version: $Revision: 1.112 $
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"
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
60 * \brief Constructor : creates an empty DicomDir
65 Initialize(); // sets all private fields to NULL
70 * \brief Constructor Parses recursively the directory and creates the DicomDir
71 * or uses an already built DICOMDIR, depending on 'parseDir' value.
72 * @param fileName name
73 * - of the root directory (parseDir = true)
74 * - of the DICOMDIR (parseDir = false)
75 * @param parseDir boolean
76 * - true if user passed an entry point
77 * and wants to explore recursively the directories
78 * - false if user passed an already built DICOMDIR file
81 DicomDir::DicomDir(std::string const &fileName, bool parseDir ):
84 // At this step, Document constructor is already executed,
85 // whatever user passed (a root directory or a DICOMDIR)
86 // and whatever the value of parseDir was.
87 // (nothing is cheked in Document constructor, to avoid overhead)
89 Initialize(); // sets all private fields to NULL
91 // if user passed a root directory, sure we didn't get anything
92 if ( TagHT.begin() == TagHT.end() ) // when user passed a Directory to parse
95 gdcmVerboseMacro( "Entry HT empty for file: "<<fileName);
97 // Only if user passed a root directory
98 // ------------------------------------
99 if ( fileName == "." )
101 // user passed '.' as Name
102 // we get current directory name
104 getcwd(dummy, (size_t)1000);
105 SetFileName( dummy ); // will be converted into a string
108 if ( parseDir ) // user asked for a recursive parsing of a root directory
112 gdcmVerboseMacro( "Parse directory and create the DicomDir");
117 /// \todo if parseDir == false, it should be tagged as an error
118 // NO ! user may just call ParseDirectory() *after* constructor
121 // Only if user passed a DICOMDIR
122 // ------------------------------
125 // Directory record sequence
126 DocEntry *e = GetDocEntry(0x0004, 0x1220);
129 gdcmVerboseMacro( "NO 'Directory record sequence' (0x0004,0x1220)"
130 << " in file " << fileName);
131 /// \todo FIXME : what do we do when the parsed file IS NOT a
140 * \brief Canonical destructor
142 DicomDir::~DicomDir()
144 SetStartMethod(NULL);
145 SetProgressMethod(NULL);
148 for(ListDicomDirPatient::iterator cc = Patients.begin();
160 //-----------------------------------------------------------------------------
163 * \brief Canonical Printer
165 void DicomDir::Print(std::ostream &os, std::string const & )
169 MetaElems->SetPrintLevel(PrintLevel);
170 MetaElems->Print(os);
172 for(ListDicomDirPatient::iterator cc = Patients.begin();
173 cc != Patients.end();
176 (*cc)->SetPrintLevel(PrintLevel);
181 //-----------------------------------------------------------------------------
184 * \brief This predicate, based on hopefully reasonable heuristics,
185 * decides whether or not the current document was properly parsed
186 * and contains the mandatory information for being considered as
187 * a well formed and usable DicomDir.
188 * @return true when Document is the one of a reasonable DicomDir,
191 bool DicomDir::IsReadable()
193 if( Filetype == Unknown)
195 gdcmVerboseMacro( "Wrong filetype");
200 gdcmVerboseMacro( "Meta Elements missing in DicomDir");
203 if( Patients.size() <= 0 )
205 gdcmVerboseMacro( "NO Patient in DicomDir");
213 * \brief fills the whole structure, starting from a root Directory
215 void DicomDir::ParseDirectory()
217 CreateDicomDirChainedList( GetFileName() );
222 * \brief Set the start method to call when the parsing of the
224 * @param method Method to call
225 * @param arg Argument to pass to the method
226 * @param argDelete Argument
227 * \warning In python : the arg parameter isn't considered
229 void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg,
230 DicomDir::Method *argDelete )
232 if( StartArg && StartMethodArgDelete )
234 StartMethodArgDelete( StartArg );
237 StartMethod = method;
239 StartMethodArgDelete = argDelete;
243 * \brief Set the method to delete the argument
244 * The argument is destroyed when the method is changed or when the
246 * @param method Method to call to delete the argument
248 void DicomDir::SetStartMethodArgDelete( DicomDir::Method *method )
250 StartMethodArgDelete = method;
254 * \brief Set the progress method to call when the parsing of the
256 * @param method Method to call
257 * @param arg Argument to pass to the method
258 * @param argDelete Argument
259 * \warning In python : the arg parameter isn't considered
261 void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg,
262 DicomDir::Method *argDelete )
264 if( ProgressArg && ProgressMethodArgDelete )
266 ProgressMethodArgDelete( ProgressArg );
269 ProgressMethod = method;
271 ProgressMethodArgDelete = argDelete;
275 * \brief Set the method to delete the argument
276 * The argument is destroyed when the method is changed or when the
278 * @param method Method to call to delete the argument
280 void DicomDir::SetProgressMethodArgDelete( DicomDir::Method *method )
282 ProgressMethodArgDelete = method;
286 * \brief Set the end method to call when the parsing of the directory ends
287 * @param method Method to call
288 * @param arg Argument to pass to the method
289 * @param argDelete Argument
290 * \warning In python : the arg parameter isn't considered
292 void DicomDir::SetEndMethod( DicomDir::Method *method, void *arg,
293 DicomDir::Method *argDelete )
295 if( EndArg && EndMethodArgDelete )
297 EndMethodArgDelete( EndArg );
302 EndMethodArgDelete = argDelete;
306 * \brief Set the method to delete the argument
307 * The argument is destroyed when the method is changed or when
308 * the class is destroyed
309 * @param method Method to call to delete the argument
311 void DicomDir::SetEndMethodArgDelete( DicomDir::Method *method )
313 EndMethodArgDelete = method;
317 * \brief Get the first entry while visiting the DicomDirPatients
318 * \return The first DicomDirPatient if found, otherwhise NULL
320 DicomDirPatient *DicomDir::GetFirstPatient()
322 ItPatient = Patients.begin();
323 if ( ItPatient != Patients.end() )
329 * \brief Get the next entry while visiting the DicomDirPatients
330 * \note : meaningfull only if GetFirstEntry already called
331 * \return The next DicomDirPatient if found, otherwhise NULL
333 DicomDirPatient *DicomDir::GetNextPatient()
335 gdcmAssertMacro (ItPatient != Patients.end());
338 if ( ItPatient != Patients.end() )
345 * \brief writes on disc a DICOMDIR
346 * \ warning does NOT add the missing elements in the header :
347 * it's up to the user doing it !
348 * \todo : to be re-written using the DICOMDIR tree-like structure
349 * *not* the chained list
350 * (does NOT exist if the DICOMDIR is user-forged !)
351 * @param fileName file to be written to
352 * @return false only when fail to open
355 bool DicomDir::WriteDicomDir(std::string const &fileName)
358 uint16_t sq[4] = { 0x0004, 0x1220, 0xffff, 0xffff };
359 uint16_t sqt[4]= { 0xfffe, 0xe0dd, 0xffff, 0xffff };
361 std::ofstream *fp = new std::ofstream(fileName.c_str(),
362 std::ios::out | std::ios::binary);
365 gdcmVerboseMacro("Failed to open(write) File: " << fileName.c_str());
369 char filePreamble[128];
370 memset(filePreamble, 0, 128);
371 fp->write(filePreamble, 128); //FIXME
372 binary_write( *fp, "DICM");
374 DicomDirMeta *ptrMeta = GetMeta();
375 ptrMeta->WriteContent(fp, ExplicitVR);
377 // force writing 0004|1220 [SQ ], that CANNOT exist within DicomDirMeta
380 binary_write(*fp, sq[i]);
383 for(ListDicomDirPatient::iterator cc = Patients.begin();
384 cc != Patients.end();
387 (*cc)->WriteContent( fp, ExplicitVR );
390 // force writing Sequence Delimitation Item
393 binary_write(*fp, sqt[i]); // fffe e0dd ffff ffff
402 //-----------------------------------------------------------------------------
406 * \brief create a Document-like chained list from a root Directory
407 * @param path entry point of the tree-like structure
409 void DicomDir::CreateDicomDirChainedList(std::string const & path)
412 DirList dirList(path,1); // gets recursively the file list
413 unsigned int count = 0;
417 DirListType fileList = dirList.GetFilenames();
419 for( DirListType::iterator it = fileList.begin();
420 it != fileList.end();
423 Progress = (float)(count+1)/(float)fileList.size();
424 CallProgressMethod();
430 header = new File( it->c_str() );
433 gdcmVerboseMacro( "Failure in new gdcm::File " << it->c_str() );
437 if( header->IsReadable() )
439 // Add the file to the chained list:
440 list.push_back(header);
441 gdcmVerboseMacro( "Readable " << it->c_str() );
449 // sorts Patient/Study/Serie/
450 std::sort(list.begin(), list.end(), DicomDir::HeaderLessThan );
452 std::string tmp = dirList.GetDirName();
453 //for each File 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<File *>(*itDoc);
466 * \brief adds *the* Meta to a partially created DICOMDIR
469 DicomDirMeta * DicomDir::NewMeta()
475 if ( TagHT.begin() != TagHT.end() ) // after Document Parsing
477 MetaElems = new DicomDirMeta(true);
479 TagDocEntryHT::iterator lastOneButSequence = TagHT.end();
480 lastOneButSequence --;
481 // ALL the 'out of Sequence' Tags belong to Meta Elems
482 // (we skip 0004|1220 [Directory record sequence] )
483 for ( TagDocEntryHT::iterator cc = TagHT.begin();
484 cc != lastOneButSequence;
487 MetaElems->AddEntry( cc->second );
490 else // after root directory parsing
492 MetaElems = new DicomDirMeta(false);
494 MetaElems->SetSQItemNumber(0); // To avoid further missprinting
499 * \brief adds a new Patient (with the basic elements) to a partially created DICOMDIR
501 DicomDirPatient *DicomDir::NewPatient()
503 DicomDirPatient *p = new DicomDirPatient();
504 AddPatientToEnd( p );
509 * \brief adds to the HTable
510 * the Entries (Dicom Elements) corresponding to the given type
511 * @param path full path file name (only used when type = GDCM_DICOMDIR_IMAGE
512 * @param type DicomDirObject type to create (GDCM_DICOMDIR_PATIENT,
513 * GDCM_DICOMDIR_STUDY, GDCM_DICOMDIR_SERIE ...)
514 * @param header Header of the current file
516 void DicomDir::SetElement(std::string const &path, DicomDirType type,
519 ListDicomDirElem elemList; //FIXME this is going to be a by copy operation
520 ListDicomDirElem::const_iterator it;
521 uint16_t tmpGr, tmpEl;
522 DictEntry *dictEntry;
529 case GDCM_DICOMDIR_IMAGE:
530 elemList = Global::GetDicomDirElements()->GetDicomDirImageElements();
531 si = new DicomDirImage(true);
532 if( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
535 gdcmErrorMacro( "Add ImageToEnd failed");
538 case GDCM_DICOMDIR_SERIE:
539 elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements();
540 si = new DicomDirSerie(true);
541 if( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
544 gdcmErrorMacro( "Add SerieToEnd failed");
547 case GDCM_DICOMDIR_STUDY:
548 elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements();
549 si = new DicomDirStudy(true);
550 if( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
553 gdcmErrorMacro( "Add StudyToEnd failed");
556 case GDCM_DICOMDIR_PATIENT:
557 elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements();
558 si = new DicomDirPatient(true);
559 if( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
562 gdcmErrorMacro( "Add PatientToEnd failed");
565 case GDCM_DICOMDIR_META:
566 elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements();
567 si = new DicomDirMeta(true);
571 gdcmErrorMacro( "MetaElements already exist, they will be destroyed");
573 MetaElems = static_cast<DicomDirMeta *>(si);
578 // removed all the seems-to-be-useless stuff about Referenced Image Sequence
579 // to avoid further troubles
580 // imageElem 0008 1140 "" // Referenced Image Sequence
581 // imageElem fffe e000 "" // 'no length' item : length to be set to 0xffffffff later
582 // imageElem 0008 1150 "" // Referenced SOP Class UID : to be set/forged later
583 // imageElem 0008 1155 "" // Referenced SOP Instance UID : to be set/forged later
584 // imageElem fffe e00d "" // Item delimitation : length to be set to ZERO later
585 // for all the relevant elements found in their own spot of the DicomDir.dic
586 // FIXME : troubles found when it's a SeqEntry
588 for( it = elemList.begin(); it != elemList.end(); ++it)
592 dictEntry = GetPubDict()->GetDictEntry(tmpGr, tmpEl);
594 entry = new ValEntry( dictEntry ); // Be sure it's never a BinEntry !
596 entry->SetOffset(0); // just to avoid further missprinting
600 // NULL when we Build Up (ex nihilo) a DICOMDIR
601 // or when we add the META elems
602 val = header->GetEntry(tmpGr, tmpEl);
609 if( val == GDCM_UNFOUND)
611 if( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID
613 // force to the *end* File Name
614 val = Util::GetName( path );
616 else if( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image
618 if( header->GetFileName().substr(0, path.length()) != path )
620 gdcmVerboseMacro( "The base path of file name is incorrect");
621 val = header->GetFileName();
625 val = &(header->GetFileName().c_str()[path.length()]);
635 if ( header->GetEntryLength(tmpGr,tmpEl) == 0 )
639 entry->SetValue( val ); // troubles expected when vr=SQ ...
641 if ( type == GDCM_DICOMDIR_META ) // fusible : should never print !
643 gdcmVerboseMacro("GDCM_DICOMDIR_META ?!? should never print that");
649 //-----------------------------------------------------------------------------
651 * \brief CallStartMethod
653 void DicomDir::CallStartMethod()
659 StartMethod( StartArg );
663 //-----------------------------------------------------------------------------
665 * \brief CallProgressMethod
667 void DicomDir::CallProgressMethod()
671 ProgressMethod( ProgressArg );
675 //-----------------------------------------------------------------------------
677 * \brief CallEndMethod
679 void DicomDir::CallEndMethod()
688 //-----------------------------------------------------------------------------
691 * \brief Sets all fields to NULL
693 void DicomDir::Initialize()
696 ProgressMethod = NULL;
698 StartMethodArgDelete = NULL;
699 ProgressMethodArgDelete = NULL;
700 EndMethodArgDelete = NULL;
712 * \brief create a 'DicomDir' from a DICOMDIR Header
714 void DicomDir::CreateDicomDir()
716 // The list is parsed.
717 // When a DicomDir tag ("PATIENT", "STUDY", "SERIE", "IMAGE") is found :
718 // 1 - we save the beginning iterator
719 // 2 - we continue to parse
720 // 3 - we find an other tag
721 // + we create the object for the precedent tag
724 // Directory record sequence
725 DocEntry *e = GetDocEntry(0x0004, 0x1220);
728 gdcmVerboseMacro( "NO Directory record sequence (0x0004,0x1220)");
729 /// \todo FIXME: what to do when the parsed file IS NOT a DICOMDIR file ?
733 SeqEntry *s = dynamic_cast<SeqEntry *>(e);
736 gdcmVerboseMacro( "No SeqEntry present");
737 // useless : (0x0004,0x1220) IS a Sequence !
743 //ListSQItem listItems = s->GetSQItems();
749 SQItem *tmpSI=s->GetFirstSQItem();
752 d = tmpSI->GetDocEntry(0x0004, 0x1430); // Directory Record Type
753 if ( ValEntry* valEntry = dynamic_cast<ValEntry *>(d) )
755 v = valEntry->GetValue();
759 gdcmVerboseMacro( "Not a ValEntry.");
763 if( v == "PATIENT " )
765 si = new DicomDirPatient(true);
766 if( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) )
770 gdcmErrorMacro( "Add PatientToEnd failed");
773 else if( v == "STUDY " )
775 si = new DicomDirStudy(true);
776 if( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) )
780 gdcmErrorMacro( "Add AddStudyToEnd failed");
783 else if( v == "SERIES" )
785 si = new DicomDirSerie(true);
786 if( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
790 gdcmErrorMacro( "Add AddSerieToEnd failed");
793 else if( v == "IMAGE " )
795 si = new DicomDirImage(true);
796 if( !AddImageToEnd( static_cast<DicomDirImage *>(si)) )
800 gdcmErrorMacro( "Add AddImageToEnd failed");
805 // It was not a 'PATIENT', nor a 'STUDY', nor a 'SERIE',
806 // neither an 'IMAGE' SQItem. Skip to next item.
811 MoveSQItem(si,tmpSI);
813 tmpSI=s->GetNextSQItem();
819 * \brief AddPatientToEnd
820 * @param dd SQ Item to enqueue to the DicomPatient chained List
822 bool DicomDir::AddPatientToEnd(DicomDirPatient *dd)
824 Patients.push_back(dd);
829 * \brief AddStudyToEnd
830 * @param dd SQ Item to enqueue to the DicomDirStudy chained List
832 bool DicomDir::AddStudyToEnd(DicomDirStudy *dd)
834 if( Patients.size() > 0 )
836 ListDicomDirPatient::iterator itp = Patients.end();
838 (*itp)->AddStudy(dd);
845 * \brief AddSerieToEnd
846 * @param dd SQ Item to enqueue to the DicomDirSerie chained List
848 bool DicomDir::AddSerieToEnd(DicomDirSerie *dd)
850 if( Patients.size() > 0 )
852 ListDicomDirPatient::iterator itp = Patients.end();
855 DicomDirStudy *study = (*itp)->GetLastStudy();
861 /* if( (*itp)->GetDicomDirStudies().size() > 0 )
863 ListDicomDirStudy::const_iterator itst =
864 (*itp)->GetDicomDirStudies().end();
866 (*itst)->AddSerie(dd);
874 * \brief AddImageToEnd
875 * @param dd SQ Item to enqueue to the DicomDirImage chained List
877 bool DicomDir::AddImageToEnd(DicomDirImage *dd)
879 if( Patients.size() > 0 )
881 ListDicomDirPatient::iterator itp = Patients.end();
884 DicomDirStudy *study = (*itp)->GetLastStudy();
887 DicomDirSerie *serie = study->GetLastSerie();
894 /* if( (*itp)->GetDicomDirStudies().size() > 0 )
896 ListDicomDirStudy::const_iterator itst =
897 (*itp)->GetDicomDirStudies().end();
900 if( (*itst)->GetDicomDirSeries().size() > 0 )
902 ListDicomDirSerie::const_iterator its = (*itst)->GetDicomDirSeries().end();
904 (*its)->AddImage(dd);
913 * \brief for each Header of the chained list, add/update the Patient/Study/Serie/Image info
914 * @param path path of the root directory
915 * @param list chained list of Headers
917 void DicomDir::SetElements(std::string const & path, VectDocument const &list)
922 std::string patPrevName = "", patPrevID = "";
923 std::string studPrevInstanceUID = "", studPrevID = "";
924 std::string serPrevInstanceUID = "", serPrevID = "";
926 std::string patCurName, patCurID;
927 std::string studCurInstanceUID, studCurID;
928 std::string serCurInstanceUID, serCurID;
931 for( VectDocument::const_iterator it = list.begin();
932 it != list.end(); ++it )
934 // get the current file characteristics
935 patCurName = (*it)->GetEntry(0x0010,0x0010);
936 patCurID = (*it)->GetEntry(0x0010,0x0011);
937 studCurInstanceUID = (*it)->GetEntry(0x0020,0x000d);
938 studCurID = (*it)->GetEntry(0x0020,0x0010);
939 serCurInstanceUID = (*it)->GetEntry(0x0020,0x000e);
940 serCurID = (*it)->GetEntry(0x0020,0x0011);
942 if( patCurName != patPrevName || patCurID != patPrevID || first )
944 SetElement(path, GDCM_DICOMDIR_PATIENT, *it);
948 // if new Study Deal with 'STUDY' Elements
949 if( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID
952 SetElement(path, GDCM_DICOMDIR_STUDY, *it);
956 // if new Serie Deal with 'SERIE' Elements
957 if( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID
960 SetElement(path, GDCM_DICOMDIR_SERIE, *it);
964 // Always Deal with 'IMAGE' Elements
965 SetElement(path, GDCM_DICOMDIR_IMAGE, *it);
967 patPrevName = patCurName;
968 patPrevID = patCurID;
969 studPrevInstanceUID = studCurInstanceUID;
970 studPrevID = studCurID;
971 serPrevInstanceUID = serCurInstanceUID;
972 serPrevID = serCurID;
978 * \brief Move the content of the source SQItem to the destination SQItem
979 * Only DocEntry's are moved
980 * @param dst destination SQItem
981 * @param src source SQItem
983 void DicomDir::MoveSQItem(SQItem *dst,SQItem *src)
987 entry = src->GetFirstEntry();
990 src->RemoveEntryNoDestroy(entry);
991 dst->AddEntry(entry);
992 // we destroyed -> the current iterator is not longer valid
993 entry = src->GetFirstEntry();
998 * \brief compares two dgcmHeaders
1000 bool DicomDir::HeaderLessThan(Document *header1, Document *header2)
1002 return *header1 < *header2;
1005 } // end namespace gdcm
1007 //-----------------------------------------------------------------------------