]> Creatis software - gdcm.git/blobdiff - src/gdcmDicomDir.cxx
On the way to gdcm2 ...
[gdcm.git] / src / gdcmDicomDir.cxx
index 2af9aaf2b5825d8b469ea27fb8c5420f4dbef67d..1226e49598d9b3ca02ef9a6a7d47d7f3d0d8f9ff 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDir.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/06/03 16:08:16 $
-  Version:   $Revision: 1.140 $
+  Date:      $Date: 2005/07/07 16:37:40 $
+  Version:   $Revision: 1.144 $
   
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -164,11 +164,52 @@ DicomDir::~DicomDir()
 //-----------------------------------------------------------------------------
 // Public
 
+/**
+ * \brief   Loader. use SetLoadMode(), SetFileName() before !  
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
+bool DicomDir::Load( ) 
+{
+   // We should clean out anything that already exists.
+   Initialize();  // sets all private fields to NULL
+
+   if (!ParseDir)
+   {
+      if ( ! this->Document::Load( ) )
+         return false;
+   }
+    return DoTheLoadingJob( );   
+}
+
+/**
+ * \brief   Loader. (DEPRECATED : not to break the API)
+ * @param   fileName file to be open for parsing
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
 bool DicomDir::Load(std::string const &fileName ) 
 {
-   Filename = fileName;
    // We should clean out anything that already exists.
+   Initialize();  // sets all private fields to NULL
+
+   SetFileName( fileName );
+   if (!ParseDir)
+   {
+      if ( ! this->Document::Load( ) )
+         return false;
+   }
+   return DoTheLoadingJob( );
+}
 
+/**
+ * \brief   Does the Loading Job (internal use only)
+ * @return false if file cannot be open or no swap info was found,
+ *         or no tag was found.
+ */
+bool DicomDir::DoTheLoadingJob( ) 
+{
+   // We should clean out anything that already exists.
    Initialize();  // sets all private fields to NULL
 
    if (!ParseDir)
@@ -180,10 +221,14 @@ bool DicomDir::Load(std::string const &fileName )
       {
          return false;
       }
-      Document::Load(fileName);
+      if (!Document::Load() )
+      {
+         return false;
+      }
+
       if ( GetFirstEntry() == 0 ) // when user passed a Directory to parse
       {
-         gdcmWarningMacro( "Entry HT empty for file: "<< fileName);
+         gdcmWarningMacro( "Entry HT empty for file: "<< GetFileName());
          return false;
       }
       // Directory record sequence
@@ -191,7 +236,7 @@ bool DicomDir::Load(std::string const &fileName )
       if ( !e )
       {
          gdcmWarningMacro( "NO 'Directory record sequence' (0x0004,0x1220)"
-                          << " in file " << fileName);
+                          << " in file " << GetFileName());
          return false;
       }
       else
@@ -201,7 +246,7 @@ bool DicomDir::Load(std::string const &fileName )
    {
    // Only if user passed a root directory
    // ------------------------------------
-      if ( fileName == "." )
+      if ( GetFileName() == "." )
       {
          // user passed '.' as Name
          // we get current directory name
@@ -210,8 +255,8 @@ bool DicomDir::Load(std::string const &fileName )
          SetFileName( dummy ); // will be converted into a string
       }
       NewMeta();
-      gdcmWarningMacro( "Parse directory and create the DicomDir : " << Filename );
-
+      gdcmWarningMacro( "Parse directory and create the DicomDir : " 
+                         << GetFileName() );
       ParseDirectory();
    }
    return true;
@@ -227,17 +272,17 @@ bool DicomDir::Load(std::string const &fileName )
  */
 bool DicomDir::IsReadable()
 {
-   if( Filetype == Unknown)
+   if ( Filetype == Unknown )
    {
       gdcmWarningMacro( "Wrong filetype");
       return false;
    }
-   if( !MetaElems )
+   if ( !MetaElems )
    {
       gdcmWarningMacro( "Meta Elements missing in DicomDir");
       return false;
    }
-   if( Patients.size() <= 0 )
+   if ( Patients.size() <= 0 )
    {
       gdcmWarningMacro( "NO Patient in DicomDir");
       return false;
@@ -251,18 +296,18 @@ bool DicomDir::IsReadable()
  */  
 DicomDirMeta *DicomDir::NewMeta()
 {
-   if( MetaElems )
+   if ( MetaElems )
       delete MetaElems;
 
    DocEntry *entry = GetFirstEntry();
-   if( entry )
+   if ( entry )
    { 
-      MetaElems = new DicomDirMeta(true);
+      MetaElems = new DicomDirMeta(true); // true = empty
 
       entry = GetFirstEntry();
       while( entry )
       {
-         if( dynamic_cast<SeqEntry *>(entry) )
+         if ( dynamic_cast<SeqEntry *>(entry) )
             break;
 
          RemoveEntryNoDestroy(entry);
@@ -273,7 +318,7 @@ DicomDirMeta *DicomDir::NewMeta()
    }
    else  // after root directory parsing
    {
-      MetaElems = new DicomDirMeta(false);
+      MetaElems = new DicomDirMeta(false); // false = not empty
    }
    MetaElems->SetSQItemNumber(0); // To avoid further missprinting
    return MetaElems;  
@@ -351,7 +396,7 @@ void DicomDir::ParseDirectory()
 void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg, 
                                DicomDir::Method *argDelete )
 {
-   if( StartArg && StartMethodArgDelete )
+   if ( StartArg && StartMethodArgDelete )
    {
       StartMethodArgDelete( StartArg );
    }
@@ -373,7 +418,7 @@ void DicomDir::SetStartMethod( DicomDir::Method *method, void *arg,
 void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg, 
                                   DicomDir::Method *argDelete )
 {
-   if( ProgressArg && ProgressMethodArgDelete )
+   if ( ProgressArg && ProgressMethodArgDelete )
    {
       ProgressMethodArgDelete( ProgressArg );
    }
@@ -393,7 +438,7 @@ void DicomDir::SetProgressMethod( DicomDir::Method *method, void *arg,
 void DicomDir::SetEndMethod( DicomDir::Method *method, void *arg, 
                              DicomDir::Method *argDelete )
 {
-   if( EndArg && EndMethodArgDelete )
+   if ( EndArg && EndMethodArgDelete )
    {
       EndMethodArgDelete( EndArg );
    }
@@ -452,7 +497,7 @@ bool DicomDir::WriteDicomDir(std::string const &fileName)
 
    std::ofstream *fp = new std::ofstream(fileName.c_str(),  
                                          std::ios::out | std::ios::binary);
-   if( !fp ) 
+   if ( !fp ) 
    {
       gdcmWarningMacro("Failed to open(write) File: " << fileName.c_str());
       return false;
@@ -552,7 +597,7 @@ void DicomDir::CreateDicomDirChainedList(std::string const &path)
    {
       Progress = (float)(count+1)/(float)fileList.size();
       CallProgressMethod();
-      if( Abort )
+      if ( Abort )
       {
          break;
       }
@@ -561,13 +606,13 @@ void DicomDir::CreateDicomDirChainedList(std::string const &path)
    f->SetLoadMode(LoadMode); // we allow user not to load Sequences...
    f->Load( it->c_str() );
 
-//     if( !f )
+//     if ( !f )
 //     {
 //         gdcmWarningMacro( "Failure in new gdcm::File " << it->c_str() );
 //         continue;
 //      }
       
-      if( f->IsReadable() )
+      if ( f->IsReadable() )
       {
          // Add the file to the chained list:
          list.push_back(f);
@@ -602,7 +647,7 @@ void DicomDir::CallStartMethod()
 {
    Progress = 0.0f;
    Abort    = false;
-   if( StartMethod )
+   if ( StartMethod )
    {
       StartMethod( StartArg );
    }
@@ -613,7 +658,7 @@ void DicomDir::CallStartMethod()
  */
 void DicomDir::CallProgressMethod()
 {
-   if( ProgressMethod )
+   if ( ProgressMethod )
    {
       ProgressMethod( ProgressArg );
    }
@@ -625,7 +670,7 @@ void DicomDir::CallProgressMethod()
 void DicomDir::CallEndMethod()
 {
    Progress = 1.0f;
-   if( EndMethod )
+   if ( EndMethod )
    {
       EndMethod( EndArg );
    }
@@ -702,53 +747,63 @@ void DicomDir::CreateDicomDir()
          continue;
       }
 
-      if( v == "PATIENT " )
+      // A decent DICOMDIR has much more images than series,
+      // more series than studies, and so on.
+      // This is the right order to preform the tests
+
+      if ( v == "IMAGE " ) 
       {
-         si = new DicomDirPatient(true);
-         if( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) )
+         si = new DicomDirImage(true);
+         if ( !AddImageToEnd( static_cast<DicomDirImage *>(si)) )
          {
             delete si;
             si = NULL;
-            gdcmErrorMacro( "Add PatientToEnd failed");
+            gdcmErrorMacro( "Add AddImageToEnd failed");
          }
       }
-      else if( v == "STUDY " )
+      else if ( v == "SERIES" )
       {
-         si = new DicomDirStudy(true);
-         if( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) )
+         si = new DicomDirSerie(true);
+         if ( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
          {
             delete si;
             si = NULL;
-            gdcmErrorMacro( "Add AddStudyToEnd failed");
+            gdcmErrorMacro( "Add AddSerieToEnd failed");
          }
       }
-      else if( v == "SERIES" )
+      else if ( v == "STUDY " )
       {
-         si = new DicomDirSerie(true);
-         if( !AddSerieToEnd( static_cast<DicomDirSerie *>(si)) )
+         si = new DicomDirStudy(true);
+         if ( !AddStudyToEnd( static_cast<DicomDirStudy *>(si)) )
          {
             delete si;
             si = NULL;
-            gdcmErrorMacro( "Add AddSerieToEnd failed");
+            gdcmErrorMacro( "Add AddStudyToEnd failed");
          }
       }
-      else if( v == "IMAGE " ) 
+      else if ( v == "PATIENT " )
       {
-         si = new DicomDirImage(true);
-         if( !AddImageToEnd( static_cast<DicomDirImage *>(si)) )
+         si = new DicomDirPatient(true);
+         if ( !AddPatientToEnd( static_cast<DicomDirPatient *>(si)) )
          {
             delete si;
             si = NULL;
-            gdcmErrorMacro( "Add AddImageToEnd failed");
+            gdcmErrorMacro( "Add PatientToEnd failed");
          }
       }
       else
       {
-         // It was not a 'PATIENT', nor a 'STUDY', nor a 'SERIE',
-         // neither an 'IMAGE' SQItem. Skip to next item.
-         continue;
+         // It was neither a 'PATIENT', nor a 'STUDY', nor a 'SERIE',
+         // nor an 'IMAGE' SQItem. Skip to next item.
+         gdcmWarningMacro( " -------------------------------------------"
+         << "a non PATIENT/STUDY/SERIE/IMAGE SQItem was found : "
+         << v);
+
+        // FIXME : deal with other item types !
+        tmpSI=s->GetNextSQItem(); // To avoid infinite loop
+        continue;
       }
-      if( si )
+      if ( si )
          MoveSQItem(si,tmpSI);
 
       tmpSI=s->GetNextSQItem();
@@ -772,7 +827,7 @@ bool DicomDir::AddPatientToEnd(DicomDirPatient *dd)
  */
 bool DicomDir::AddStudyToEnd(DicomDirStudy *dd)
 {
-   if( Patients.size() > 0 )
+   if ( Patients.size() > 0 )
    {
       ListDicomDirPatient::iterator itp = Patients.end();
       itp--;
@@ -788,13 +843,13 @@ bool DicomDir::AddStudyToEnd(DicomDirStudy *dd)
  */
 bool DicomDir::AddSerieToEnd(DicomDirSerie *dd)
 {
-   if( Patients.size() > 0 )
+   if ( Patients.size() > 0 )
    {
       ListDicomDirPatient::iterator itp = Patients.end();
       itp--;
 
       DicomDirStudy *study = (*itp)->GetLastStudy();
-      if( study )
+      if ( study )
       {
          study->AddSerie(dd);
          return true;
@@ -809,16 +864,16 @@ bool DicomDir::AddSerieToEnd(DicomDirSerie *dd)
  */
 bool DicomDir::AddImageToEnd(DicomDirImage *dd)
 {
-   if( Patients.size() > 0 )
+   if ( Patients.size() > 0 )
    {
       ListDicomDirPatient::iterator itp = Patients.end();
       itp--;
 
       DicomDirStudy *study = (*itp)->GetLastStudy();
-      if( study )
+      if ( study )
       {
          DicomDirSerie *serie = study->GetLastSerie();
-         if( serie )
+         if ( serie )
          {
             serie->AddImage(dd);
             return true;
@@ -860,22 +915,22 @@ void DicomDir::SetElements(std::string const &path, VectDocument const &list)
       serCurInstanceUID  = (*it)->GetEntryValue(0x0020,0x000e);
       serCurID           = (*it)->GetEntryValue(0x0020,0x0011);
 
-      if( patCurName != patPrevName || patCurID != patPrevID || first )
+      if ( patCurName != patPrevName || patCurID != patPrevID || first )
       {
          SetElement(path, GDCM_DICOMDIR_PATIENT, *it);
          first = true;
       }
 
-      // if new Study Deal with 'STUDY' Elements   
-      if( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID 
+      // if new Study, deal with 'STUDY' Elements   
+      if ( studCurInstanceUID != studPrevInstanceUID || studCurID != studPrevID 
          || first )
       {
          SetElement(path, GDCM_DICOMDIR_STUDY, *it);
          first = true;
       }
 
-      // if new Serie Deal with 'SERIE' Elements   
-      if( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID
+      // if new Serie, deal with 'SERIE' Elements   
+      if ( serCurInstanceUID != serPrevInstanceUID || serCurID != serPrevID
          || first )
       {
          SetElement(path, GDCM_DICOMDIR_SERIE, *it);
@@ -918,7 +973,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
       case GDCM_DICOMDIR_IMAGE:
          elemList = Global::GetDicomDirElements()->GetDicomDirImageElements();
          si = new DicomDirImage(true);
-         if( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
+         if ( !AddImageToEnd(static_cast<DicomDirImage *>(si)) )
          {
             delete si;
             gdcmErrorMacro( "Add ImageToEnd failed");
@@ -927,7 +982,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
       case GDCM_DICOMDIR_SERIE:
          elemList = Global::GetDicomDirElements()->GetDicomDirSerieElements();
          si = new DicomDirSerie(true);
-         if( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
+         if ( !AddSerieToEnd(static_cast<DicomDirSerie *>(si)) )
          {
             delete si;
             gdcmErrorMacro( "Add SerieToEnd failed");
@@ -936,7 +991,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
       case GDCM_DICOMDIR_STUDY:
          elemList = Global::GetDicomDirElements()->GetDicomDirStudyElements();
          si = new DicomDirStudy(true);
-         if( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
+         if ( !AddStudyToEnd(static_cast<DicomDirStudy *>(si)) )
          {
             delete si;
             gdcmErrorMacro( "Add StudyToEnd failed");
@@ -945,7 +1000,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
       case GDCM_DICOMDIR_PATIENT:
          elemList = Global::GetDicomDirElements()->GetDicomDirPatientElements();
          si = new DicomDirPatient(true);
-         if( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
+         if ( !AddPatientToEnd(static_cast<DicomDirPatient *>(si)) )
          {
             delete si;
             gdcmErrorMacro( "Add PatientToEnd failed");
@@ -954,7 +1009,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
       case GDCM_DICOMDIR_META:
          elemList = Global::GetDicomDirElements()->GetDicomDirMetaElements();
          si = new DicomDirMeta(true);
-         if( MetaElems )
+         if ( MetaElems )
          {
             delete MetaElems;
             gdcmErrorMacro( "MetaElements already exist, they will be destroyed");
@@ -985,7 +1040,7 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
 
       entry->SetOffset(0); // just to avoid further missprinting
 
-      if( header )
+      if ( header )
       {
          // NULL when we Build Up (ex nihilo) a DICOMDIR
          //   or when we add the META elems
@@ -996,16 +1051,16 @@ void DicomDir::SetElement(std::string const &path, DicomDirType type,
          val = GDCM_UNFOUND;
       }
 
-      if( val == GDCM_UNFOUND) 
+      if ( val == GDCM_UNFOUND) 
       {
-         if( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID
+         if ( tmpGr == 0x0004 && tmpEl == 0x1130 ) // File-set ID
          {
            // force to the *end* File Name
            val = Util::GetName( path );
          }
-         else if( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image
+         else if ( tmpGr == 0x0004 && tmpEl == 0x1500 ) // Only used for image
          {
-            if( header->GetFileName().substr(0, path.length()) != path )
+            if ( header->GetFileName().substr(0, path.length()) != path )
             {
                gdcmWarningMacro( "The base path of file name is incorrect");
                val = header->GetFileName();
@@ -1073,7 +1128,7 @@ bool DicomDir::HeaderLessThan(Document *header1, Document *header2)
  */
 void DicomDir::Print(std::ostream &os, std::string const & )
 {
-   if( MetaElems )
+   if ( MetaElems )
    {
       MetaElems->SetPrintLevel(PrintLevel);
       MetaElems->Print(os);