]> Creatis software - gdcm.git/blobdiff - src/gdcmSerieHelper.cxx
Fix comments
[gdcm.git] / src / gdcmSerieHelper.cxx
index 9ac3369398b74da8fdcf28759746825f0eea2d3d..030e1d8b8af6a93dc69acc562ed4031d5f76285b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/06/24 10:55:59 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/07/19 09:04:58 $
+  Version:   $Revision: 1.13 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -41,7 +41,7 @@ SerieHelper::SerieHelper()
    while (l)
    { 
       // For all the files of a File list
-      for (FileList::iterator it  = l->begin();
+      for (gdcm::FileList::iterator it  = l->begin();
                               it != l->end(); 
                             ++it)
       {
@@ -87,11 +87,16 @@ SerieHelper::~SerieHelper()
 void SerieHelper::AddFileName(std::string const &filename)
 {
    // Create a DICOM file
-   File *header = new File( filename ); 
+   File *header = new File ();
+   header->SetLoadMode(LoadMode);
+   header->SetFileName( filename ); 
+   header->Load();
+   //File *header = new File( filename ); // Deprecated old style 
    if ( header->IsReadable() )
    {
       int allrules = 1;
-      // First step the user has defined s set of rules for the DICOM he is looking for
+      // First step the user has defined a set of rules for the DICOM 
+      // he is looking for.
       // make sure the file correspond to his set of rules:
       for(SerieRestrictions::iterator it = Restrictions.begin();
           it != Restrictions.end();
@@ -108,7 +113,7 @@ void SerieHelper::AddFileName(std::string const &filename)
       }
       if ( allrules ) // all rules are respected:
       {
-         // Alright ! we have a found a DICOM that match the user expectation. 
+         // Allright ! we have a found a DICOM that match the user expectation. 
          // Let's add it !
 
          // 0020 000e UI REL Series Instance UID
@@ -122,7 +127,7 @@ void SerieHelper::AddFileName(std::string const &filename)
             // create a std::list in 'uid' position
             CoherentFileListHT[uid] = new FileList;
          }
-         // Current Serie UID and DICOM header seems to match add the file:
+         // Current Serie UID and DICOM header seems to match; add the file:
          CoherentFileListHT[uid]->push_back( header );
       }
       else
@@ -137,6 +142,61 @@ void SerieHelper::AddFileName(std::string const &filename)
       delete header;
    }
 }
+
+/**
+ * \brief add a gdcm::File to the first (and supposed to be unique) list
+ *        of the gdcm::SerieHelper.
+ * \warning : this method should be used by aware users only!
+ *            User is supposed to know the files he want to deal with
+ *           and consider them they belong to the same Serie
+ *           (even if their Serie UID is different)
+ *           user will probabely OrderFileList() this list (actually, ordering
+ *           user choosen gdm::File is the sole interest of this method)
+ *           Moreover, using vtkGdcmReader::SetCoherentFileList() will avoid
+ *           vtkGdcmReader parsing twice the same files. 
+ *           *no* coherence check is performed, but those specified
+ *           by SerieHelper::AddRestriction()
+ * @param   header gdcm::File* of the file to deal with
+ */
+void SerieHelper::AddGdcmFile(File *header)
+{
+      int allrules = 1;
+      // First step the user has defined a set of rules for the DICOM 
+      // he is looking for.
+      // make sure the file correspond to his set of rules:
+      for(SerieRestrictions::iterator it = Restrictions.begin();
+          it != Restrictions.end();
+          ++it)
+      {
+         const Rule &r = *it;
+         const std::string s;// = header->GetEntryValue( r.first );
+         if ( !Util::DicomStringEqual(s, r.second.c_str()) )
+         {
+           // Argh ! This rule is unmatch let's just quit
+           allrules = 0;
+           break;
+         }
+      }
+      if ( allrules ) // all rules are respected:
+      {
+         // Allright ! we have a found a DICOM that match the user expectation. 
+         // Let's add it !
+
+         const std::string &uid = "0";
+         // Serie UID of the gdcm::File* may be different.
+         // User is supposed to know what he wants
+
+         if ( CoherentFileListHT.count(uid) == 0 )
+         {
+            gdcmDebugMacro(" New Serie UID :[" << uid << "]");
+            // create a std::list in 'uid' position
+            CoherentFileListHT[uid] = new FileList;
+         }
+         // Current Serie UID and DICOM header seems to match; add the file:
+         CoherentFileListHT[uid]->push_back( header );
+      }
+         // Even if a rule was unmatch we don't deallocate the gdcm::File:
+}
 /**
  * \brief add a rules for restricting a DICOM file to be in the serie we are
  * trying to find. For example you can select only the DICOM file from a
@@ -205,7 +265,7 @@ FileList *SerieHelper::GetFirstCoherentFileList()
 
 /**
  * \brief   Get the next List while visiting the CoherentFileListHT
- * \note : meaningfull only if GetFirstCoherentFileList already called
+ * \note : meaningfull only if GetFirstCoherentFileList() already called
  * @return  The next FileList if found, otherwhise NULL
  */
 FileList *SerieHelper::GetNextCoherentFileList()
@@ -246,7 +306,7 @@ FileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
  * @return false only if the header is bugged !
  */
 bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
-//based on Jolinda's algorithm
+//based on Jolinda Smith's algorithm
 {
    //iop is calculated based on the file file
    float cosines[6];
@@ -321,7 +381,8 @@ bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
    // Find out if min/max are coherent
    if ( min == max )
      {
-     gdcmWarningMacro( "Looks like all images have the exact same image position...");
+     gdcmWarningMacro( "Looks like all images have the exact same image position."
+                       << "No PositionPatientOrdering sort performed" );
      return false;
      }
 
@@ -345,12 +406,12 @@ bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
          CoherentFileVector[pos] = *it2;
       else
       {
-         gdcmWarningMacro( "2 files same position");
+         gdcmWarningMacro( "At least 2 files with same position. No PositionPatientOrdering sort performed");
          return false;
       }
    }
 
-   fileList->clear();  // doesn't delete list elements, only node
+   fileList->clear();  // doesn't delete list elements, only nodes
   
    //VC++ don't understand what scope is !! it -> it3
    for (FileVector::const_iterator it3  = CoherentFileVector.begin();
@@ -376,7 +437,7 @@ bool SerieHelper::ImageNumberLessThan(File *file1, File *file2)
  *                                      corresponding to an integer)
  *             within a bona fide serie (i.e image numbers are consecutive)
  * @param fileList Coherent File list (same Serie UID) to sort 
- * @return false if non nona fide stuff encountered
+ * @return false if non bona fide stuff encountered
  */
 bool SerieHelper::ImageNumberOrdering(FileList *fileList) 
 {
@@ -395,8 +456,10 @@ bool SerieHelper::ImageNumberOrdering(FileList *fileList)
 
    // Find out if image numbers are coherent (consecutive)
    if ( min == max || max == 0 || max >= (n+min) )
+   {
+      gdcmWarningMacro( " 'Image numbers' not coherent. No ImageNumberOrdering sort performed.");
       return false;
-
+   }
    std::sort(fileList->begin(), fileList->end(), SerieHelper::ImageNumberLessThan );
 
    return true;