src/gdcmSerieHelper.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSerieHelper.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2006/02/16 20:06:15 $
   7   Version:   $Revision: 1.47 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #include "gdcmSerieHelper.h"
  20 #include "gdcmDirList.h"
  21 #include "gdcmFile.h"
  22 #include "gdcmDictEntry.h" // for TranslateToKey
  23 #include "gdcmDebug.h"
  24 #include "gdcmUtil.h"
  25
  26 #include <math.h>
  27 #include <vector>
  28 #include <algorithm>
  29 #include <map>
  30 #include <stdio.h>  //for sscanf
  31
  32 namespace gdcm
  33 {
  34
  35 //-----------------------------------------------------------------------------
  36 // Constructor / Destructor
  37 /**
  38  * \brief   Constructor from a given SerieHelper
  39  */
  40 SerieHelper::SerieHelper()
  41 {
  42    m_UseSeriesDetails = false;
  43    ClearAll();
  44    UserLessThanFunction = 0;
  45    DirectOrder = true;
  46 }
  47
  48 /**
  49  * \brief   Canonical destructor.
  50  */
  51 SerieHelper::~SerieHelper()
  52 {
  53    ClearAll();
  54 }
  55
  56 /**
  57  * \brief  Preventively, clear everything at constructor time.
  58  *         ( use it at destructor time.)
  59  */
  60 void SerieHelper::ClearAll()
  61 {
  62    // For all the 'Single SerieUID' Filesets that may already exist
  63    FileList *l = GetFirstSingleSerieUIDFileSet();
  64    while (l)
  65    {
  66       // For all the gdcm::File of a File set
  67       for (gdcm::FileList::iterator it  = l->begin();
  68                                     it != l->end();
  69                                   ++it)
  70       {
  71          (*it)->Delete(); // remove each entry
  72       }
  73       l->clear();
  74       delete l;     // remove the container
  75       l = GetNextSingleSerieUIDFileSet();
  76    }
  77    // Need to clear that too:
  78    SingleSerieUIDFileSetHT.clear();
  79 }
  80
  81 //-----------------------------------------------------------------------------
  82
  83 //-----------------------------------------------------------------------------
  84
  85 // Public
  86 /**
  87  * \brief add a gdcm::File to the Fileset corresponding to its Serie UID
  88  * @param   filename Name of the file to deal with
  89  */
  90 void SerieHelper::AddFileName(std::string const &filename)
  91 {
  92    // Create a DICOM file
  93    File *header = File::New();
  94    header->SetLoadMode(LoadMode);
  95    header->SetFileName( filename );
  96    header->Load();
  97
  98    if ( header->IsReadable() )
  99    {
 100       if ( !AddFile( header ) )
 101       {
 102          // at least one rule was unmatched we need to deallocate the file:
 103          header->Delete();
 104       }
 105    }
 106    else
 107    {
 108       gdcmWarningMacro("Could not read file: " << filename );
 109       header->Delete();
 110    }
 111 }
 112
 113 /**
 114  * \brief add a gdcm::File to the first (and supposed to be unique) file set
 115  *        of the gdcm::SerieHelper.
 116  * \warning : this method should be used by aware users only!
 117  *           Passing a gdcm::File* has the same effect than passing a file name!
 118  * \todo : decide which one is wrong (the method, or the commentary)!
 119  *           the following comment doesn't match the method :-(
 120  *            User is supposed to know the files he want to deal with
 121  *           and consider them they belong to the same Serie
 122  *           (even if their Serie UID is different)
 123  *           user will probabely OrderFileList() this list (actually, ordering
 124  *           user choosen gdm::File is the sole interest of this method)
 125  *           Moreover, using vtkGdcmReader::SetCoherentFileList() will avoid
 126  *           vtkGdcmReader parsing twice the same files.
 127  *           *no* coherence check is performed, but those specified
 128  *           by SerieHelper::AddRestriction()
 129  * @param   header gdcm::File* of the file to deal with
 130  * @return  true if file was added, false if file was rejected
 131  */
 132 bool SerieHelper::AddFile(File *header)
 133 {
 134    int allrules = 1;
 135    // First step the user has defined a set of rules for the DICOM
 136    // he is looking for.
 137    // make sure the file correspond to his set of rules:
 138
 139    std::string s;
 140    for(SerieExRestrictions::iterator it2 = ExRestrictions.begin();
 141      it2 != ExRestrictions.end();
 142      ++it2)
 143    {
 144       const ExRule &r = *it2;
 145       s = header->GetEntryString( r.group, r.elem );
 146       if ( !Util::CompareDicomString(s, r.value.c_str(), r.op) )
 147       {
 148          // Argh ! This rule is unmatched; let's just quit
 149          allrules = 0;
 150          break;
 151       }
 152    }
 153
 154    if ( allrules ) // all rules are respected:
 155    {
 156       // Allright! we have a found a DICOM that matches the user expectation.
 157       // Let's add it to the specific 'id' which by default is uid (Serie UID)
 158       // but can be `refined` by user with more paramater (see AddRestriction(g,e))
 159
 160       std::string id = CreateUniqueSeriesIdentifier( header );
 161       // if id == GDCM_UNFOUND then consistently we should find GDCM_UNFOUND
 162       // no need here to do anything special
 163
 164       if ( SingleSerieUIDFileSetHT.count(id) == 0 )
 165       {
 166          gdcmDebugMacro(" New Serie UID :[" << id << "]");
 167          // create a std::list in 'id' position
 168          SingleSerieUIDFileSetHT[id] = new FileList;
 169       }
 170       // Current Serie UID and DICOM header seems to match add the file:
 171       SingleSerieUIDFileSetHT[id]->push_back( header );
 172    }
 173    else
 174    {
 175       // one rule not matched, tell user:
 176       return false;
 177    }
 178    return true;
 179 }
 180
 181 /**
 182  * \brief add a rule for restricting a DICOM file to be in the serie we are
 183  * trying to find. For example you can select only the DICOM files from a
 184  * directory which would have a particular EchoTime==4.0.
 185  * This method is a user level, value is not required to be formatted as a DICOM
 186  * string
 187  * \todo find a trick to allow user to say if he wants the Rectrictions
 188  *       to be *ored* (and not only *anded*)
 189  * @param   key  Target tag we want restrict on a given value
 190  * @param value value to be checked to exclude File
 191  * @param op  operator we want to use to check
 192  */
 193 void SerieHelper::AddRestriction(TagKey const &key,
 194                                  std::string const &value, int op)
 195 {
 196    ExRule r;
 197    r.group = key[0];
 198    r.elem  = key[1];
 199    r.value = value;
 200    r.op    = op;
 201    ExRestrictions.push_back( r );
 202 }
 203
 204 void SerieHelper::AddRestriction(TagKey const &key)
 205 {
 206   ExRule r;
 207   r.group = key[0];
 208   r.elem  = key[1];
 209   ExRefine.push_back( r );
 210 }
 211
 212 #ifndef GDCM_LEGACY_REMOVE
 213 /**
 214  * \brief add a rule for restricting a DICOM file to be in the serie we are
 215  * trying to find. For example you can select only the DICOM files from a
 216  * directory which would have a particular EchoTime==4.0.
 217  * This method is a user level, value is not required to be formatted as a DICOM
 218  * string
 219  * @param   group tag group number we want restrict on a given value
 220  * @param   elem  tag element number we want restrict on a given value
 221  * @param value value to be checked to exclude File
 222  * @param op  operator we want to use to check
 223  * @deprecated use : AddRestriction(TagKey const &key,
 224  *                                 std::string const &value, int op);
 225  */
 226 void SerieHelper::AddRestriction(uint16_t group, uint16_t elem,
 227                                  std::string const &value, int op)
 228 {
 229   TagKey t(group, elem);
 230   AddRestriction(t, value, op);
 231 }
 232 #endif
 233
 234 /**
 235  * \brief add an extra  'SerieDetail' for building a 'Serie Identifier'
 236  *        that ensures (hope so) File constistency (Series Instance UID doesn't.
 237  * @param   group tag group number we want restrict on a given value
 238  * @param   elem  tag element number we want restrict on a given value
 239  * @param  convert wether we want 'convertion', to allow further ordering
 240  *         e.g : 100 would be *before* 20; 000020.00 vs 00100.00 : OK
 241  */
 242 void SerieHelper::AddSeriesDetail(uint16_t group, uint16_t elem, bool convert)
 243 {
 244
 245    ExDetail d;
 246    d.group   = group;
 247    d.elem    = elem;
 248    d.convert = convert;
 249    ExDetails.push_back( d );
 250 }
 251 /**
 252  * \brief Sets the root Directory
 253  * @param   dir Name of the directory to deal with
 254  * @param recursive whether we want explore recursively the root Directory
 255  */
 256 void SerieHelper::SetDirectory(std::string const &dir, bool recursive)
 257 {
 258    DirList dirList(dir, recursive); // OS specific
 259
 260    DirListType filenames_list = dirList.GetFilenames();
 261    for( DirListType::const_iterator it = filenames_list.begin();
 262         it != filenames_list.end(); ++it)
 263    {
 264       AddFileName( *it );
 265    }
 266 }
 267
 268 /**
 269  * \brief Sorts the given Fileset
 270  * \warning This could be implemented in a 'Strategy Pattern' approach
 271  *          But as I don't know how to do it, I leave it this way
 272  *          BTW, this is also a Strategy, I don't know this is
 273  *          the best approach :)
 274  */
 275 void SerieHelper::OrderFileList(FileList *fileSet)
 276 {
 277
 278    if ( SerieHelper::UserLessThanFunction )
 279    {
 280       UserOrdering( fileSet );
 281       return;
 282    }
 283    else if ( ImagePositionPatientOrdering( fileSet ) )
 284    {
 285       return ;
 286    }
 287    else if ( ImageNumberOrdering(fileSet ) )
 288    {
 289       return ;
 290    }
 291    else
 292    {
 293       FileNameOrdering(fileSet );
 294    }
 295 }
 296
 297 /**
 298  * \brief Elementary coherence checking of the files with the same Serie UID
 299  * Only sizes and pixel type are checked right now ...
 300  */
 301 bool SerieHelper::IsCoherent(FileList *fileSet)
 302 {
 303    if(fileSet->size() == 1)
 304    return true;
 305
 306    FileList::const_iterator it = fileSet->begin();
 307
 308    int nX =               (*it)->GetXSize();
 309    int nY =               (*it)->GetYSize();
 310    int pixelSize =        (*it)->GetPixelSize();
 311    bool signedPixelData = (*it)->IsSignedPixelData();
 312    it ++;
 313    for ( ;
 314          it != fileSet->end();
 315        ++it)
 316    {
 317       if ( (*it)->GetXSize() != nX )
 318          return false;
 319       if ( (*it)->GetYSize() != nY )
 320          return false;
 321       if ( (*it)->GetPixelSize() != pixelSize )
 322          return false;
 323       if ( (*it)->IsSignedPixelData() != signedPixelData )
 324          return false;
 325       // probabely more is to be checked (?)
 326    }
 327    return true;
 328 }
 329
 330 #ifndef GDCM_LEGACY_REMOVE
 331 /**
 332  * \brief   accessor (DEPRECATED :  use GetFirstSingleSerieUIDFileSet )
 333  *          Warning : 'coherent' means here they have the same Serie UID
 334  * @return  The first FileList if found, otherwhise NULL
 335  */
 336 FileList *SerieHelper::GetFirstCoherentFileList()
 337 {
 338    ItFileSetHt = SingleSerieUIDFileSetHT.begin();
 339    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 340       return ItFileSetHt->second;
 341    return NULL;
 342 }
 343
 344 /**
 345  * \brief   accessor (DEPRECATED :  use GetNextSingleSerieUIDFileSet )
 346  *          Warning : 'coherent' means here they have the same Serie UID
 347  * \note : meaningfull only if GetFirstCoherentFileList() already called
 348  * @return  The next FileList if found, otherwhise NULL
 349  */
 350 FileList *SerieHelper::GetNextCoherentFileList()
 351 {
 352    gdcmAssertMacro (ItFileSetHt != SingleSerieUIDFileSetHT.end());
 353
 354    ++ItFileSetHt;
 355    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 356       return ItFileSetHt->second;
 357    return NULL;
 358 }
 359
 360 /**
 361  * \brief   accessor (DEPRECATED :  use GetSingleSerieUIDFileSet )
 362   *          Warning : 'coherent' means here they have the same Serie UID
 363  * @param SerieUID SerieUID
 364  * \return  pointer to the FileList if found, otherwhise NULL
 365  */
 366 FileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
 367 {
 368    if ( SingleSerieUIDFileSetHT.count(SerieUID) == 0 )
 369       return 0;
 370    return SingleSerieUIDFileSetHT[SerieUID];
 371 }
 372 #endif
 373
 374
 375 /**
 376  * \brief   Get the first Fileset while visiting the SingleSerieUIDFileSetmap
 377  * @return  The first FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 378  */
 379 FileList *SerieHelper::GetFirstSingleSerieUIDFileSet()
 380 {
 381    ItFileSetHt = SingleSerieUIDFileSetHT.begin();
 382    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 383       return ItFileSetHt->second;
 384    return NULL;
 385 }
 386
 387 /**
 388  * \brief   Get the next Fileset while visiting the SingleSerieUIDFileSetmap
 389  * \note : meaningfull only if GetNextSingleSerieUIDFileSet() already called
 390  * @return  The next FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 391  */
 392 FileList *SerieHelper::GetNextSingleSerieUIDFileSet()
 393 {
 394    gdcmAssertMacro (ItFileSetHt != SingleSerieUIDFileSetHT.end());
 395
 396    ++ItFileSetHt;
 397    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 398       return ItFileSetHt->second;
 399    return NULL;
 400 }
 401
 402 /**
 403  * \brief   Get the SingleSerieUIDFileSet according to its Serie UID
 404  * @param SerieUID SerieUID to retrieve
 405  * \return pointer to the FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 406  */
 407 FileList *SerieHelper::GetSingleSerieUIDFileSet(std::string SerieUID)
 408 {
 409    if ( SingleSerieUIDFileSetHT.count(SerieUID) == 0 )
 410       return 0;
 411    return SingleSerieUIDFileSetHT[SerieUID];
 412 }
 413
 414 /**
 415  * \brief   Splits a Single SerieUID Fileset according to the Orientations
 416  * @param fileSet File Set to be splitted
 417  * \return  std::map of 'Xcoherent' File sets
 418  */
 419
 420 XCoherentFileSetmap SerieHelper::SplitOnOrientation(FileList *fileSet)
 421 {
 422    XCoherentFileSetmap CoherentFileSet;
 423
 424    int nb = fileSet->size();
 425    if (nb == 0 )
 426       return CoherentFileSet;
 427    float iop[6];
 428    std::string strOrient;
 429    std::ostringstream ossOrient;
 430
 431    FileList::const_iterator it = fileSet->begin();
 432    it ++;
 433    for ( ;
 434          it != fileSet->end();
 435        ++it)
 436    {
 437       // Information is in :
 438       // 0020 0037 : Image Orientation (Patient) or
 439       // 0020 0035 : Image Orientation (RET)
 440
 441       // Let's build again the 'cosines' string, to be sure of it's format
 442       (*it)->GetImageOrientationPatient(iop);
 443
 444       ossOrient << iop[0];
 445       for (int i = 1; i < 6; i++)
 446       {
 447         ossOrient << "\\";
 448         ossOrient << iop[i];
 449       }
 450       strOrient = ossOrient.str();
 451       ossOrient.str("");
 452       if ( CoherentFileSet.count(strOrient) == 0 )
 453       {
 454          gdcmDebugMacro(" New Orientation :[" << strOrient << "]");
 455          // create a File set in 'orientation' position
 456          CoherentFileSet[strOrient] = new FileList;
 457       }
 458       // Current Orientation and DICOM header match; add the file:
 459       CoherentFileSet[strOrient]->push_back( (*it) );
 460    }
 461    return CoherentFileSet;
 462 }
 463
 464 /**
 465  * \brief   Splits a 'Single SerieUID' Fileset according to the Positions
 466  * @param fileSet File Set to be splitted
 467  * \return  std::map of 'Xcoherent' File sets
 468  */
 469
 470 XCoherentFileSetmap SerieHelper::SplitOnPosition(FileList *fileSet)
 471 {
 472    XCoherentFileSetmap CoherentFileSet;
 473
 474    int nb = fileSet->size();
 475    if (nb == 0 )
 476       return CoherentFileSet;
 477    float pos[3];
 478    std::string strImPos;  // read on disc
 479    std::ostringstream ossPosition;
 480    std::string strPosition; // re computed
 481    FileList::const_iterator it = fileSet->begin();
 482    it ++;
 483    for ( ;
 484          it != fileSet->end();
 485        ++it)
 486    {
 487       // Information is in :
 488       // 0020,0032 : Image Position Patient
 489       // 0020,0030 : Image Position (RET)
 490
 491       strImPos = (*it)->GetEntryString(0x0020,0x0032);
 492       if ( strImPos == GDCM_UNFOUND)
 493       {
 494          gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 495          strImPos = (*it)->GetEntryString(0x0020,0x0030); // For ACR-NEMA images
 496          if ( strImPos == GDCM_UNFOUND )
 497          {
 498             gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 499             // User wants to split on the 'Position'
 500             // No 'Position' info found.
 501             // We return an empty Htable !
 502             return CoherentFileSet;
 503          }
 504       }
 505
 506       if ( sscanf( strImPos.c_str(), "%f \\%f \\%f ",
 507                                               &pos[0], &pos[1], &pos[2]) != 3 )
 508       {
 509             gdcmWarningMacro( "Wrong number for Position : ["
 510                        << strImPos << "]" );
 511              return CoherentFileSet;
 512       }
 513
 514       // Let's build again the 'position' string, to be sure of it's format
 515
 516       ossPosition << pos[0];
 517       for (int i = 1; i < 3; i++)
 518       {
 519         ossPosition << "\\";
 520         ossPosition << pos[i];
 521       }
 522       strPosition = ossPosition.str();
 523       ossPosition.str("");
 524
 525       if ( CoherentFileSet.count(strPosition) == 0 )
 526       {
 527          gdcmDebugMacro(" New Position :[" << strPosition << "]");
 528          // create a File set in 'position' position
 529          CoherentFileSet[strPosition] = new FileList;
 530       }
 531       // Current Position and DICOM header match; add the file:
 532       CoherentFileSet[strPosition]->push_back( (*it) );
 533    }
 534    return CoherentFileSet;
 535 }
 536
 537 /**
 538  * \brief   Splits a 'Single SerieUID' File set Coherent according to the
 539  *          value of a given Tag
 540  * @param fileSet File Set to be splitted
 541  * @param   group  group number of the target Element
 542  * @param   elem element number of the target Element
 543  * \return  std::map of 'Xcoherent' File sets
 544  */
 545
 546 XCoherentFileSetmap SerieHelper::SplitOnTagValue(FileList *fileSet,
 547                                                uint16_t group, uint16_t element)
 548 {
 549    XCoherentFileSetmap CoherentFileSet;
 550
 551    int nb = fileSet->size();
 552    if (nb == 0 )
 553       return CoherentFileSet;
 554
 555    std::string strTagValue;  // read on disc
 556
 557    FileList::const_iterator it = fileSet->begin();
 558    it ++;
 559    for ( ;
 560          it != fileSet->end();
 561        ++it)
 562    {
 563       // Information is in :
 564       // 0020,0032 : Image Position Patient
 565       // 0020,0030 : Image Position (RET)
 566
 567       strTagValue = (*it)->GetEntryString(group,element);
 568
 569       if ( CoherentFileSet.count(strTagValue) == 0 )
 570       {
 571          gdcmDebugMacro(" New Tag Value :[" << strTagValue << "]");
 572          // create a File set in 'position' position
 573          CoherentFileSet[strTagValue] = new FileList;
 574       }
 575       // Current Tag value and DICOM header match; add the file:
 576       CoherentFileSet[strTagValue]->push_back( (*it) );
 577    }
 578    return CoherentFileSet;
 579 }
 580
 581 //-----------------------------------------------------------------------------
 582 // Protected
 583
 584 //-----------------------------------------------------------------------------
 585 // Private
 586 /**
 587  * \brief sorts the images, according to their Patient Position.
 588  *
 589  *  We may order, considering :
 590  *   -# Image Position Patient
 591  *   -# Image Number
 592  *   -# file name
 593  *   -# More to come :-)
 594  * \note : FileList = std::vector<File* >
 595  * @param fileList Coherent File list (same Serie UID) to sort
 596  * @return false only if the header is bugged !
 597  */
 598 bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
 599 //based on Jolinda Smith's algorithm
 600 {
 601    //iop is calculated based on the file file
 602    float cosines[6];
 603    double normal[3];
 604    double ipp[3];
 605    double dist;
 606    double min = 0, max = 0;
 607    bool first = true;
 608
 609    std::multimap<double,File *> distmultimap;
 610    // Use a multimap to sort the distances from 0,0,0
 611    for ( FileList::const_iterator
 612          it = fileList->begin();
 613          it != fileList->end(); ++it )
 614    {
 615       if ( first )
 616       {
 617          (*it)->GetImageOrientationPatient( cosines );
 618
 619          // You only have to do this once for all slices in the volume. Next,
 620          // for each slice, calculate the distance along the slice normal
 621          // using the IPP ("Image Position Patient") tag.
 622          // ("dist" is initialized to zero before reading the first slice) :
 623          normal[0] = cosines[1]*cosines[5] - cosines[2]*cosines[4];
 624          normal[1] = cosines[2]*cosines[3] - cosines[0]*cosines[5];
 625          normal[2] = cosines[0]*cosines[4] - cosines[1]*cosines[3];
 626
 627          ipp[0] = (*it)->GetXOrigin();
 628          ipp[1] = (*it)->GetYOrigin();
 629          ipp[2] = (*it)->GetZOrigin();
 630
 631          dist = 0;
 632          for ( int i = 0; i < 3; ++i )
 633          {
 634             dist += normal[i]*ipp[i];
 635          }
 636
 637          distmultimap.insert(std::pair<const double,File *>(dist, *it));
 638
 639          max = min = dist;
 640          first = false;
 641       }
 642       else
 643       {
 644          ipp[0] = (*it)->GetXOrigin();
 645          ipp[1] = (*it)->GetYOrigin();
 646          ipp[2] = (*it)->GetZOrigin();
 647
 648          dist = 0;
 649          for ( int i = 0; i < 3; ++i )
 650          {
 651             dist += normal[i]*ipp[i];
 652          }
 653
 654          distmultimap.insert(std::pair<const double,File *>(dist, *it));
 655
 656          min = (min < dist) ? min : dist;
 657          max = (max > dist) ? max : dist;
 658       }
 659    }
 660
 661    // Find out if min/max are coherent
 662    if ( min == max )
 663    {
 664      gdcmWarningMacro("Looks like all images have the exact same image position"
 665                       << ". No PositionPatientOrdering sort performed" );
 666      return false;
 667    }
 668
 669    // Check to see if image shares a common position
 670    bool ok = true;
 671    for (std::multimap<double, File *>::iterator it2 = distmultimap.begin();
 672         it2 != distmultimap.end();
 673         ++it2)
 674    {
 675       if (distmultimap.count((*it2).first) != 1)
 676       {
 677          gdcmErrorMacro("File: "
 678               << ((*it2).second->GetFileName())
 679               << " Distance: "
 680               << (*it2).first
 681               << " position is not unique");
 682
 683          ok = false;
 684       }
 685    }
 686    if (!ok)
 687    {
 688       return false;
 689    }
 690
 691    fileList->clear();  // doesn't delete list elements, only nodes
 692
 693    if (DirectOrder)
 694    {
 695       for (std::multimap<double, File *>::iterator it3 = distmultimap.begin();
 696            it3 != distmultimap.end();
 697            ++it3)
 698       {
 699          fileList->push_back( (*it3).second );
 700       }
 701    }
 702    else // user asked for reverse order
 703    {
 704       std::multimap<double, File *>::const_iterator it4;
 705       it4 = distmultimap.end();
 706       do
 707       {
 708          it4--;
 709          fileList->push_back( (*it4).second );
 710       } while (it4 != distmultimap.begin() );
 711    }
 712
 713    distmultimap.clear();
 714
 715    return true;
 716 }
 717
 718 bool SerieHelper::ImageNumberLessThan(File *file1, File *file2)
 719 {
 720   return file1->GetImageNumber() < file2->GetImageNumber();
 721 }
 722
 723 bool SerieHelper::ImageNumberGreaterThan(File *file1, File *file2)
 724 {
 725   return file1->GetImageNumber() > file2->GetImageNumber();
 726 }
 727
 728 /**
 729  * \brief sorts the images, according to their Image Number
 730  * \note Works only on bona fide files  (i.e image number is a character string
 731  *                                      corresponding to an integer)
 732  *             within a bona fide serie (i.e image numbers are consecutive)
 733  * @param fileList File set (same Serie UID) to sort
 734  * @return false if non bona fide stuff encountered
 735  */
 736 bool SerieHelper::ImageNumberOrdering(FileList *fileList)
 737 {
 738    int min, max, pos;
 739    int n = fileList->size();
 740
 741    FileList::const_iterator it = fileList->begin();
 742    min = max = (*it)->GetImageNumber();
 743
 744    for (; it != fileList->end(); ++it, ++n)
 745    {
 746       pos = (*it)->GetImageNumber();
 747       min = (min < pos) ? min : pos;
 748       max = (max > pos) ? max : pos;
 749    }
 750
 751    // Find out if image numbers are coherent (consecutive)
 752    if ( min == max || max == 0 || max >= (n+min) )
 753    {
 754       gdcmWarningMacro( " 'Image numbers' not coherent. "
 755                         << " No ImageNumberOrdering sort performed.");
 756       return false;
 757    }
 758    if (DirectOrder)
 759       Sort(fileList,SerieHelper::ImageNumberLessThan);
 760    else
 761       Sort(fileList,SerieHelper::ImageNumberGreaterThan);
 762
 763    return true;
 764 }
 765
 766 bool SerieHelper::FileNameLessThan(File *file1, File *file2)
 767 {
 768    return file1->GetFileName() < file2->GetFileName();
 769 }
 770
 771 bool SerieHelper::FileNameGreaterThan(File *file1, File *file2)
 772 {
 773    return file1->GetFileName() > file2->GetFileName();
 774 }
 775 /**
 776  * \brief sorts the images, according to their File Name
 777  * @param fileList Coherent File list (same Serie UID) to sort
 778  * @return false only if the header is bugged !
 779  */
 780 bool SerieHelper::FileNameOrdering(FileList *fileList)
 781 {
 782    if (DirectOrder)
 783       Sort(fileList,SerieHelper::FileNameLessThan);
 784    else
 785       Sort(fileList,SerieHelper::FileNameGreaterThan);
 786
 787    return true;
 788 }
 789
 790 /**
 791  * \brief sorts the images, according to user supplied function
 792  * @param fileList Coherent File list (same Serie UID) to sort
 793  * @return false only if the header is bugged !
 794  */
 795 bool SerieHelper::UserOrdering(FileList *fileList)
 796 {
 797    Sort(fileList,SerieHelper::UserLessThanFunction);
 798    if (!DirectOrder)
 799    {
 800       std::reverse(fileList->begin(), fileList->end());
 801    }
 802    return true;
 803 }
 804
 805 //-----------------------------------------------------------------------------
 806 // Print
 807 /**
 808  * \brief   Canonical printer.
 809  */
 810 void SerieHelper::Print(std::ostream &os, std::string const &indent)
 811 {
 812    // For all the Coherent File lists of the gdcm::Serie
 813    SingleSerieUIDFileSetmap::iterator itl = SingleSerieUIDFileSetHT.begin();
 814    if ( itl == SingleSerieUIDFileSetHT.end() )
 815    {
 816       gdcmWarningMacro( "No SingleSerieUID File set found" );
 817       return;
 818    }
 819    while (itl != SingleSerieUIDFileSetHT.end())
 820    {
 821       os << "Serie UID :[" << itl->first << "]" << std::endl;
 822
 823       // For all the files of a SingleSerieUID File set
 824       for (FileList::iterator it =  (itl->second)->begin();
 825                                   it != (itl->second)->end();
 826                                 ++it)
 827       {
 828          os << indent << " --- " << (*it)->GetFileName() << std::endl;
 829       }
 830       ++itl;
 831    }
 832 }
 833
 834 void SerieHelper::CreateDefaultUniqueSeriesIdentifier()
 835 {
 836    // If the user requests, additional information can be appended
 837    // to the SeriesUID to further differentiate volumes in the DICOM
 838    // objects being processed.
 839
 840    // 0020 0011 Series Number
 841    // A scout scan prior to a CT volume scan can share the same
 842    //   SeriesUID, but they will sometimes have a different Series Number
 843    AddRestriction( TagKey(0x0020, 0x0011) );
 844    // 0018 0024 Sequence Name
 845    // For T1-map and phase-contrast MRA, the different flip angles and
 846    //   directions are only distinguished by the Sequence Name
 847    AddRestriction( TagKey(0x0018, 0x0024) );
 848    // 0018 0050 Slice Thickness
 849    // On some CT systems, scout scans and subsequence volume scans will
 850    //   have the same SeriesUID and Series Number - YET the slice
 851    //   thickness will differ from the scout slice and the volume slices.
 852    AddRestriction( TagKey(0x0018, 0x0050));
 853    // 0028 0010 Rows
 854    // If the 2D images in a sequence don't have the same number of rows,
 855    // then it is difficult to reconstruct them into a 3D volume.
 856    AddRestriction( TagKey(0x0028, 0x0010));
 857    // 0028 0011 Columns
 858    // If the 2D images in a sequence don't have the same number of columns,
 859    // then it is difficult to reconstruct them into a 3D volume.
 860    AddRestriction( TagKey(0x0028, 0x0011));
 861 }
 862
 863 /**
 864  * \brief Heuristics to *try* to build a Serie Identifier that would ensure
 865  *        all the images are coherent.
 866  *
 867  * By default, uses the SeriesUID.  If UseSeriesDetails(true) has been called,
 868  *         then additional identifying information is used.
 869  *  We allow user to add his own critierions, using AddSeriesDetail
 870  *        (he knows more than we do about his images!)
 871  *        ex : in tagging series, the only pertnent tag is
 872  *        0018|1312 [In-plane Phase Encoding Direction] value : ROW/COLUMN
 873  * @param inFile gdcm::File we want to build a Serie Identifier for.
 874  * @return the SeriesIdentifier
 875  */
 876 std::string SerieHelper::CreateUniqueSeriesIdentifier( File *inFile )
 877 {
 878    if( inFile->IsReadable() )
 879    {
 880     // 0020 000e UI REL Series Instance UID
 881     std::string uid = inFile->GetEntryString (0x0020, 0x000e);
 882     std::string id = uid.c_str();
 883     if(m_UseSeriesDetails)
 884       {
 885       for(SerieExRestrictions::iterator it2 = ExRefine.begin();
 886         it2 != ExRefine.end();
 887         ++it2)
 888         {
 889         const ExRule &r = *it2;
 890         std::string s = inFile->GetEntryString( r.group, r.elem );
 891         if( s == gdcm::GDCM_UNFOUND )
 892           {
 893           s = "";
 894           }
 895         if( id == uid && !s.empty() )
 896           {
 897           id += "."; // add separator
 898           }
 899         id += s;
 900         }
 901       }
 902     // Eliminate non-alnum characters, including whitespace...
 903     //   that may have been introduced by concats.
 904     for(unsigned int i=0; i<id.size(); i++)
 905       {
 906       while(i<id.size()
 907         && !( id[i] == '.'
 908           || (id[i] >= 'a' && id[i] <= 'z')
 909           || (id[i] >= '0' && id[i] <= '9')
 910           || (id[i] >= 'A' && id[i] <= 'Z')))
 911         {
 912         id.erase(i, 1);
 913         }
 914       }
 915     return id;
 916     }
 917   else // Could not open inFile
 918     {
 919     gdcmWarningMacro("Could not parse series info.");
 920     std::string id = gdcm::GDCM_UNFOUND;
 921     return id;
 922     }
 923 }
 924
 925 /**
 926  * \brief Allow user to build is own File Identifier (to be able to sort
 927  *        temporal series just as he wants)
 928  *        Criterions will be set with AddSeriesDetail.
 929  *        (Maybe the method should be moved elsewhere
 930  *       -File class? FileHelper class?-
 931  * @return FileIdentifier (Tokenizable on '%%%'. Hope it's enough !)
 932  */
 933 std::string SerieHelper::CreateUserDefinedFileIdentifier( File * inFile )
 934 {
 935   //     Deal with all user supplied tags.
 936   //      (user knows more than we do about his images!)
 937
 938    double converted;
 939    std::string id;
 940    std::string s;
 941    char charConverted[17];
 942
 943    for(SeriesExDetails::iterator it2 = ExDetails.begin();
 944       it2 != ExDetails.end();
 945       ++it2)
 946    {
 947       const ExDetail &r = *it2;
 948       s = inFile->GetEntryString( r.group, r.elem );
 949
 950       // User is allowed to ask 'convertion', to allow further ordering
 951       // e.g : 100 would be *before* 20; 000020.00 vs 00100.00 : OK
 952       if (it2->convert)
 953       {
 954          if ( s != GDCM_UNFOUND) // Don't convert unfound fields !
 955          {
 956             converted = atof(s.c_str());
 957             // probabely something much more complicated is possible,
 958             // using C++ features
 959             /// \todo check the behaviour when there are >0 and <0 numbers
 960             sprintf(charConverted, "%016.6f",converted);
 961             s = charConverted;
 962          }
 963       }
 964       // Eliminate non-alphanum characters, including whitespace.
 965       for(unsigned int i=0; i<s.size(); i++)
 966       {
 967          while(i<s.size()
 968             && !( s[i] == '.' || s[i] == '%'
 969                     || (s[i] >= 'a' && s[i] <= 'z')
 970                     || (s[i] >= '0' && s[i] <= '9')
 971                     || (s[i] >= 'A' && s[i] <= 'Z')))
 972          {
 973             s.erase(i, 1);
 974          }
 975       }
 976
 977       id += s.c_str();
 978       id += "%%%"; // make the FileIdentifier Tokenizable
 979    }
 980
 981    return id;
 982 }
 983
 984 //-----------------------------------------------------------------------------
 985 // Sort
 986 /**
 987  * \brief   Sort FileList.
 988  */
 989 void SerieHelper::Sort(FileList *fileList, bool (*pt2Func)( File *file1, File *file2) )
 990 {
 991  std::sort(fileList->begin(), fileList->end(), pt2Func );
 992 }
 993
 994 //-----------------------------------------------------------------------------
 995 } // end namespace gdcm