]> Creatis software - gdcm.git/blobdiff - src/gdcmSerieHelper.cxx
ENH: Adding feature for user to refine the search of dicom file within a directory...
[gdcm.git] / src / gdcmSerieHelper.cxx
index 4c62a8f074ec948580d204acd53d9888d55e036a..1d85f6ace2edcf00e2131affec114accb354dff0 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/05/11 17:15:18 $
-  Version:   $Revision: 1.6 $
+  Date:      $Date: 2005/05/27 21:19:03 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -20,6 +20,7 @@
 #include "gdcmDirList.h"
 #include "gdcmFile.h"
 #include "gdcmDebug.h"
+#include "gdcmUtil.h"
 
 #include <math.h>
 #include <vector>
@@ -36,13 +37,13 @@ namespace gdcm
 SerieHelper::SerieHelper()
 {
    // For all the File lists of the gdcm::Serie
-   GdcmFileList *l = GetFirstCoherentFileList();
+   FileList *l = GetFirstCoherentFileList();
    while (l)
    { 
       // For all the files of a File list
-      for (GdcmFileList::iterator it  = l->begin();
-                                  it != l->end(); 
-                                ++it)
+      for (FileList::iterator it  = l->begin();
+                              it != l->end(); 
+                            ++it)
       {
          delete *it;
       }
@@ -58,13 +59,13 @@ SerieHelper::SerieHelper()
 SerieHelper::~SerieHelper()
 {
    // For all the Coherent File lists of the gdcm::Serie
-   GdcmFileList *l = GetFirstCoherentFileList();
+   FileList *l = GetFirstCoherentFileList();
    while (l)
    { 
       // For all the files of a Coherent File list
-      for (GdcmFileList::iterator it  = l->begin();
-                                  it != l->end(); 
-                                ++it)
+      for (FileList::iterator it  = l->begin();
+                              it != l->end(); 
+                            ++it)
       {
          delete *it;
       }
@@ -85,23 +86,50 @@ SerieHelper::~SerieHelper()
  */
 void SerieHelper::AddFileName(std::string const &filename)
 {
-   //directly use string and not const char*:
+   // Create a DICOM file
    File *header = new File( filename ); 
    if( header->IsReadable() )
    {
-      // 0020 000e UI REL Series Instance UID
-      std::string uid =  header->GetEntryValue (0x0020, 0x000e);
-      // if uid == GDCM_UNFOUND then consistently we should find GDCM_UNFOUND
-      // no need here to do anything special
+      int allrules = 1;
+      // First step the user has defined s 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:
+      {
+         // Alright ! we have a found a DICOM that match the user expectation. 
+         // Let's add it !
+
+         // 0020 000e UI REL Series Instance UID
+         const std::string &uid = header->GetEntryValue (0x0020, 0x000e);
+         // if uid == GDCM_UNFOUND then consistently we should find GDCM_UNFOUND
+         // no need here to do anything special
 
-      if ( CoherentGdcmFileListHT.count(uid) == 0 )
+         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 );
+      }
+      else
       {
-         gdcmWarningMacro(" New Serie UID :[" << uid << "]");
-         // create a std::list in 'uid' position
-         CoherentGdcmFileListHT[uid] = new GdcmFileList;
+         // at least one rule was unmatch we need to deallocate the file:
+         delete header;
       }
-      // Current Serie UID and DICOM header seems to match add the file:
-      CoherentGdcmFileListHT[uid]->push_back( header );
    }
    else
    {
@@ -109,6 +137,20 @@ void SerieHelper::AddFileName(std::string const &filename)
       delete header;
    }
 }
+/**
+ * \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
+ * directory which would have a particular EchoTime==4.0.
+ * This method is a user level, value is not required to be formatted as a DICOM
+ * string
+ */
+void SerieHelper::AddRestriction(TagKey const &key, std::string const &value)
+{
+   Rule r;
+   r.first = key;
+   r.second = value;
+   Restrictions.push_back( r ); 
+}
 
 /**
  * \brief Sets the root Directory
@@ -133,30 +175,30 @@ void SerieHelper::SetDirectory(std::string const &dir, bool recursive)
  *          But as I don't know how to do it, I leave it this way
  *          BTW, this is also a Strategy, I don't know this is the best approach :)
  */
-void SerieHelper::OrderGdcmFileList(GdcmFileList *CoherentGdcmFileList)
+void SerieHelper::OrderFileList(FileList *CoherentFileList)
 {
-   if( ImagePositionPatientOrdering( CoherentGdcmFileList ) )
+   if( ImagePositionPatientOrdering( CoherentFileList ) )
    {
       return ;
    }
-   else if( ImageNumberOrdering(CoherentGdcmFileList ) )
+   else if( ImageNumberOrdering(CoherentFileList ) )
    {
       return ;
    }
    else  
    {
-      FileNameOrdering(CoherentGdcmFileList );
+      FileNameOrdering(CoherentFileList );
    }
 }
 
 /**
  * \brief   Get the first List while visiting the CoherentFileListHT
- * @return  The first GdcmFileList if found, otherwhise NULL
+ * @return  The first FileList if found, otherwhise NULL
  */
-GdcmFileList *SerieHelper::GetFirstCoherentFileList()
+FileList *SerieHelper::GetFirstCoherentFileList()
 {
-   ItListHt = CoherentGdcmFileListHT.begin();
-   if( ItListHt != CoherentGdcmFileListHT.end() )
+   ItListHt = CoherentFileListHT.begin();
+   if( ItListHt != CoherentFileListHT.end() )
       return ItListHt->second;
    return NULL;
 }
@@ -164,14 +206,14 @@ GdcmFileList *SerieHelper::GetFirstCoherentFileList()
 /**
  * \brief   Get the next List while visiting the CoherentFileListHT
  * \note : meaningfull only if GetFirstCoherentFileList already called
- * @return  The next GdcmFileList if found, otherwhise NULL
+ * @return  The next FileList if found, otherwhise NULL
  */
-GdcmFileList *SerieHelper::GetNextCoherentFileList()
+FileList *SerieHelper::GetNextCoherentFileList()
 {
-   gdcmAssertMacro (ItListHt != CoherentGdcmFileListHT.end());
+   gdcmAssertMacro (ItListHt != CoherentFileListHT.end());
   
    ++ItListHt;
-   if ( ItListHt != CoherentGdcmFileListHT.end() )
+   if ( ItListHt != CoherentFileListHT.end() )
       return ItListHt->second;
    return NULL;
 }
@@ -181,11 +223,11 @@ GdcmFileList *SerieHelper::GetNextCoherentFileList()
  * @param SerieUID SerieUID
  * \return  pointer to the Coherent Filseslist if found, otherwhise NULL
  */
-GdcmFileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
+FileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
 {
-   if ( CoherentGdcmFileListHT.count(SerieUID) == 0 )
+   if ( CoherentFileListHT.count(SerieUID) == 0 )
       return 0;     
-   return CoherentGdcmFileListHT[SerieUID];
+   return CoherentFileListHT[SerieUID];
 }
 
 //-----------------------------------------------------------------------------
@@ -202,7 +244,7 @@ GdcmFileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
  * @param fileList Coherent File list (same Serie UID) to sort
  * @return false only if the header is bugged !
  */
-bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
+bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
 //based on Jolinda's algorithm
 {
    //iop is calculated based on the file file
@@ -216,7 +258,7 @@ bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
    std::vector<float> distlist;
 
    //!\todo rewrite this for loop.
-   for ( GdcmFileList::const_iterator 
+   for ( FileList::const_iterator 
          it = fileList->begin();
          it != fileList->end(); ++it )
    {
@@ -270,10 +312,10 @@ bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
    // Then I order the slices according to the value "dist". Finally, once
    // I've read in all the slices, I calculate the z-spacing as the difference
    // between the "dist" values for the first two slices.
-   GdcmFileVector CoherentGdcmFileVector(n);
-   // CoherentGdcmFileVector.reserve( n );
-   CoherentGdcmFileVector.resize( n );
-   // gdcmAssertMacro( CoherentGdcmFileVector.capacity() >= n );
+   FileVector CoherentFileVector(n);
+   // CoherentFileVector.reserve( n );
+   CoherentFileVector.resize( n );
+   // gdcmAssertMacro( CoherentFileVector.capacity() >= n );
 
    // Find out if min/max are coherent
    if( min == max )
@@ -287,7 +329,7 @@ bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
    n = 0;
     
    //VC++ don't understand what scope is !! it -> it2
-   for (GdcmFileList::const_iterator it2  = fileList->begin();
+   for (FileList::const_iterator it2  = fileList->begin();
         it2 != fileList->end(); ++it2, ++n)
    {
       //2*n sort algo !!
@@ -298,8 +340,8 @@ bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
       // and images may have differents directions
       // -> More than one may have the same 'pos'
       // Sorting has then NO meaning !
-      if (CoherentGdcmFileVector[pos]==NULL)
-         CoherentGdcmFileVector[pos] = *it2;
+      if (CoherentFileVector[pos]==NULL)
+         CoherentFileVector[pos] = *it2;
       else
       {
          gdcmWarningMacro( "2 files same position");
@@ -310,14 +352,14 @@ bool SerieHelper::ImagePositionPatientOrdering( GdcmFileList *fileList )
    fileList->clear();  // doesn't delete list elements, only node
   
    //VC++ don't understand what scope is !! it -> it3
-   for (GdcmFileVector::const_iterator it3  = CoherentGdcmFileVector.begin();
-        it3 != CoherentGdcmFileVector.end(); ++it3)
+   for (FileVector::const_iterator it3  = CoherentFileVector.begin();
+        it3 != CoherentFileVector.end(); ++it3)
    {
       fileList->push_back( *it3 );
    }
 
    distlist.clear();
-   CoherentGdcmFileVector.clear();
+   CoherentFileVector.clear();
 
    return true;
 }
@@ -335,12 +377,12 @@ bool SerieHelper::ImageNumberLessThan(File *file1, File *file2)
  * @param fileList Coherent File list (same Serie UID) to sort 
  * @return false if non nona fide stuff encountered
  */
-bool SerieHelper::ImageNumberOrdering(GdcmFileList *fileList) 
+bool SerieHelper::ImageNumberOrdering(FileList *fileList) 
 {
    int min, max, pos;
    int n = fileList->size();
 
-   GdcmFileList::const_iterator it = fileList->begin();
+   FileList::const_iterator it = fileList->begin();
    min = max = (*it)->GetImageNumber();
 
    for (; it != fileList->end(); ++it, ++n)
@@ -369,7 +411,7 @@ bool SerieHelper::FileNameLessThan(File *file1, File *file2)
  * @param fileList Coherent File list (same Serie UID) to sort
  * @return false only if the header is bugged !
  */
-bool SerieHelper::FileNameOrdering(GdcmFileList *fileList)
+bool SerieHelper::FileNameOrdering(FileList *fileList)
 {
    std::sort(fileList->begin(), fileList->end(), SerieHelper::FileNameLessThan);
    return true;
@@ -383,18 +425,18 @@ bool SerieHelper::FileNameOrdering(GdcmFileList *fileList)
 void SerieHelper::Print(std::ostream &os, std::string const & indent)
 {
    // For all the Coherent File lists of the gdcm::Serie
-   CoherentFileListmap::iterator itl = CoherentGdcmFileListHT.begin();
-   if ( itl == CoherentGdcmFileListHT.end() )
+   CoherentFileListmap::iterator itl = CoherentFileListHT.begin();
+   if ( itl == CoherentFileListHT.end() )
    {
       gdcmWarningMacro( "No Coherent File list found" );
       return;
    }
-   while (itl != CoherentGdcmFileListHT.end())
+   while (itl != CoherentFileListHT.end())
    { 
       os << "Serie UID :[" << itl->first << "]" << std::endl;
 
       // For all the files of a Coherent File list
-      for (GdcmFileList::iterator it =  (itl->second)->begin();
+      for (FileList::iterator it =  (itl->second)->begin();
                                   it != (itl->second)->end(); 
                                 ++it)
       {