src/gdcmSerieHelper.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSerieHelper.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/25 12:40:03 $
   7   Version:   $Revision: 1.29 $
   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 <map>
  29 #include <algorithm>
  30 #include <stdio.h>  //for sscanf
  31
  32 namespace gdcm
  33 {
  34 //-----------------------------------------------------------------------------
  35
  36 //-----------------------------------------------------------------------------
  37 // Constructor / Destructor
  38 /**
  39  * \brief   Constructor from a given SerieHelper
  40  */
  41 SerieHelper::SerieHelper()
  42 {
  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          delete *it; // remove each entry
  72       }
  73       l->clear();
  74       delete l;     // remove the container
  75       l = GetNextSingleSerieUIDFileSet();
  76    }
  77 }
  78
  79 //-----------------------------------------------------------------------------
  80
  81 //-----------------------------------------------------------------------------
  82
  83 // Public
  84 /**
  85  * \brief add a gdcm::File to the Fileset corresponding to its Serie UID
  86  * @param   filename Name of the file to deal with
  87  */
  88 void SerieHelper::AddFileName(std::string const &filename)
  89 {
  90    // Create a DICOM file
  91    File *header = new File ();
  92    header->SetLoadMode(LoadMode);
  93    header->SetFileName( filename );
  94    header->Load();
  95
  96    if ( header->IsReadable() )
  97    {
  98       int allrules = 1;
  99       // First step : the user defined a set of rules for the DICOM file
 100       // he is looking for.
 101       // Make sure the file corresponds to his set of rules:
 102
 103       std::string s;
 104       for(SerieExRestrictions::iterator it2 = ExRestrictions.begin();
 105           it2 != ExRestrictions.end();
 106           ++it2)
 107       {
 108          const ExRule &r = *it2;
 109          s = header->GetEntryString( r.group, r.elem );
 110          if ( !Util::CompareDicomString(s, r.value.c_str(), r.op) )
 111          {
 112            // Argh ! This rule is unmatched; let's just quit
 113
 114            allrules = 0;
 115            break;
 116          }
 117       }
 118
 119       if ( allrules ) // all rules are respected:
 120       {
 121          // Allright! we have a found a DICOM that matches the user expectation.
 122          // Let's add it!
 123
 124          // 0020 000e UI REL Series Instance UID
 125          const std::string &uid = header->GetEntryString(0x0020, 0x000e);
 126          // if uid == GDCM_UNFOUND then consistently we should find GDCM_UNFOUND
 127          // no need here to do anything special
 128
 129
 130          if ( SingleSerieUIDFileSetHT.count(uid) == 0 )
 131          {
 132             gdcmDebugMacro(" New Serie UID :[" << uid << "]");
 133             // create a std::list in 'uid' position
 134             SingleSerieUIDFileSetHT[uid] = new FileList;
 135          }
 136          // Current Serie UID and DICOM header seems to match; add the file:
 137          SingleSerieUIDFileSetHT[uid]->push_back( header );
 138       }
 139       else
 140       {
 141          // at least one rule was unmatched we need to deallocate the file:
 142          delete header;
 143       }
 144    }
 145    else
 146    {
 147       gdcmWarningMacro("Could not read file: " << filename );
 148       delete header;
 149    }
 150 }
 151
 152 /**
 153  * \brief add a gdcm::File to the first (and supposed to be unique) file set
 154  *        of the gdcm::SerieHelper.
 155  * \warning : this method should be used by aware users only!
 156  *           Passing a gdcm::File* has the same effect than passing a file name!
 157  * \todo : decide which one is wrong (the method, or the commentary)!
 158  *           the following comment doesn't match the method :-(
 159  *            User is supposed to know the files he want to deal with
 160  *           and consider them they belong to the same Serie
 161  *           (even if their Serie UID is different)
 162  *           user will probabely OrderFileList() this list (actually, ordering
 163  *           user choosen gdm::File is the sole interest of this method)
 164  *           Moreover, using vtkGdcmReader::SetCoherentFileList() will avoid
 165  *           vtkGdcmReader parsing twice the same files.
 166  *           *no* coherence check is performed, but those specified
 167  *           by SerieHelper::AddRestriction()
 168  * @param   header gdcm::File* of the file to deal with
 169  */
 170 void SerieHelper::AddGdcmFile(File *header)
 171 {
 172       int allrules = 1;
 173       // First step the user has defined a set of rules for the DICOM
 174       // he is looking for.
 175       // make sure the file correspond to his set of rules:
 176       for(SerieRestrictions::iterator it =  Restrictions.begin();
 177                                       it != Restrictions.end();
 178                                     ++it)
 179       {
 180          const Rule &r = *it;
 181          const std::string s;// = header->GetEntryValue( r.first );
 182          if ( !Util::DicomStringEqual(s, r.second.c_str()) )
 183          {
 184            // Argh ! This rule is unmatch let's just quit
 185            allrules = 0;
 186            break;
 187          }
 188       }
 189       if ( allrules ) // all rules are respected:
 190       {
 191          // Allright ! we have a found a DICOM that match the user expectation.
 192          // Let's add it !
 193
 194          const std::string &uid = "0";
 195          // Serie UID of the gdcm::File* may be different.
 196          // User is supposed to know what he wants
 197
 198          if ( SingleSerieUIDFileSetHT.count(uid) == 0 )
 199          {
 200             gdcmDebugMacro(" New Serie UID :[" << uid << "]");
 201             // create a std::list in 'uid' position
 202             SingleSerieUIDFileSetHT[uid] = new FileList;
 203          }
 204          // Current Serie UID and DICOM header seems to match; add the file:
 205          SingleSerieUIDFileSetHT[uid]->push_back( header );
 206       }
 207          // Even if a rule was unmatch we don't deallocate the gdcm::File:
 208 }
 209
 210 /**
 211  * \brief add a rules for restricting a DICOM file to be in the serie we are
 212  * trying to find. For example you can select only the DICOM file from a
 213  * directory which would have a particular EchoTime==4.0.
 214  * This method is a user level, value is not required to be formatted as a DICOM
 215  * string
 216  * @param   group  Group number of the target tag.
 217  * @param   elem Element number of the target tag.
 218  * @param value value to be checked to exclude File
 219  * @param op  operator we want to use to check
 220  */
 221 void SerieHelper::AddRestriction(uint16_t group, uint16_t elem,
 222                                  std::string const &value, int op)
 223 {
 224    ExRule r;
 225    r.group = group;
 226    r.elem  = elem;
 227    r.value = value;
 228    r.op    = op;
 229    ExRestrictions.push_back( r );
 230 }
 231
 232 #ifndef GDCM_LEGACY_REMOVE
 233 void SerieHelper::AddRestriction(TagKey const &key, std::string const &value)
 234 {
 235    Rule r;
 236    r.first = key;
 237    r.second = value;
 238    Restrictions.push_back( r );
 239 }
 240 #endif
 241
 242 /**
 243  * \brief Sets the root Directory
 244  * @param   dir Name of the directory to deal with
 245  * @param recursive whether we want explore recursively the root Directory
 246  */
 247 void SerieHelper::SetDirectory(std::string const &dir, bool recursive)
 248 {
 249    DirList dirList(dir, recursive); // OS specific
 250
 251    DirListType filenames_list = dirList.GetFilenames();
 252    for( DirListType::const_iterator it = filenames_list.begin();
 253         it != filenames_list.end(); ++it)
 254    {
 255       AddFileName( *it );
 256    }
 257 }
 258
 259 /**
 260  * \brief Sorts the given Fileset
 261  * \warning This could be implemented in a 'Strategy Pattern' approach
 262  *          But as I don't know how to do it, I leave it this way
 263  *          BTW, this is also a Strategy, I don't know this is
 264  *          the best approach :)
 265  */
 266 void SerieHelper::OrderFileList(FileList *fileSet)
 267 {
 268
 269    if ( SerieHelper::UserLessThanFunction )
 270    {
 271       UserOrdering( fileSet );
 272       return;
 273    }
 274    else if ( ImagePositionPatientOrdering( fileSet ) )
 275    {
 276       return ;
 277    }
 278    else if ( ImageNumberOrdering(fileSet ) )
 279    {
 280       return ;
 281    }
 282    else
 283    {
 284       FileNameOrdering(fileSet );
 285    }
 286 }
 287
 288 /**
 289  * \brief Elementary coherence checking of the files with the same Serie UID
 290  * Only sizes and pixel type are checked right now ...
 291  */
 292 bool SerieHelper::IsCoherent(FileList *fileSet)
 293 {
 294    if(fileSet->size() == 1)
 295    return true;
 296
 297    FileList::const_iterator it = fileSet->begin();
 298
 299    int nX = (*it)->GetXSize();
 300    int nY = (*it)->GetYSize();
 301    int pixelSize = (*it)->GetPixelSize();
 302
 303    it ++;
 304    for ( ;
 305          it != fileSet->end();
 306        ++it)
 307    {
 308       if ( (*it)->GetXSize() != nX )
 309          return false;
 310       if ( (*it)->GetYSize() != nY )
 311          return false;
 312       if ( (*it)->GetPixelSize() != pixelSize )
 313          return false;
 314       // probabely more is to be checked (?)
 315    }
 316    return true;
 317 }
 318
 319 #ifndef GDCM_LEGACY_REMOVE
 320
 321 FileList *SerieHelper::GetFirstCoherentFileList()
 322 {
 323    ItFileSetHt = SingleSerieUIDFileSetHT.begin();
 324    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 325       return ItFileSetHt->second;
 326    return NULL;
 327 }
 328
 329
 330 FileList *SerieHelper::GetNextCoherentFileList()
 331 {
 332    gdcmAssertMacro (ItFileSetHt != SingleSerieUIDFileSetHT.end());
 333
 334    ++ItFileSetHt;
 335    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 336       return ItFileSetHt->second;
 337    return NULL;
 338 }
 339
 340
 341 FileList *SerieHelper::GetCoherentFileList(std::string SerieUID)
 342 {
 343    if ( SingleSerieUIDFileSetHT.count(SerieUID) == 0 )
 344       return 0;
 345    return SingleSerieUIDFileSetHT[SerieUID];
 346 }
 347 #endif
 348
 349
 350 /**
 351  * \brief   Get the first Fileset while visiting the SingleSerieUIDFileSetmap
 352  * @return  The first FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 353  */
 354 FileList *SerieHelper::GetFirstSingleSerieUIDFileSet()
 355 {
 356    ItFileSetHt = SingleSerieUIDFileSetHT.begin();
 357    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 358       return ItFileSetHt->second;
 359    return NULL;
 360 }
 361
 362 /**
 363  * \brief   Get the next Fileset while visiting the SingleSerieUIDFileSetmap
 364  * \note : meaningfull only if GetNextSingleSerieUIDFileSet() already called
 365  * @return  The next FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 366  */
 367 FileList *SerieHelper::GetNextSingleSerieUIDFileSet()
 368 {
 369    gdcmAssertMacro (ItFileSetHt != SingleSerieUIDFileSetHT.end());
 370
 371    ++ItFileSetHt;
 372    if ( ItFileSetHt != SingleSerieUIDFileSetHT.end() )
 373       return ItFileSetHt->second;
 374    return NULL;
 375 }
 376
 377 /**
 378  * \brief   Get the SingleSerieUIDFileSet according to its Serie UID
 379  * @param SerieUID SerieUID to retrieve
 380  * \return pointer to the FileList (SingleSerieUIDFileSet) if found, otherwhise 0
 381  */
 382 FileList *SerieHelper::GetSingleSerieUIDFileSet(std::string SerieUID)
 383 {
 384    if ( SingleSerieUIDFileSetHT.count(SerieUID) == 0 )
 385       return 0;
 386    return SingleSerieUIDFileSetHT[SerieUID];
 387 }
 388
 389 /**
 390  * \brief   Splits a Single SerieUID Fileset according to the Orientations
 391  * @param fileSet File Set to be splitted
 392  * \return  std::map of 'Xcoherent' File sets
 393  */
 394
 395 XCoherentFileSetmap SerieHelper::SplitOnOrientation(FileList *fileSet)
 396 {
 397    XCoherentFileSetmap CoherentFileSet;
 398
 399    int nb = fileSet->size();
 400    if (nb == 0 )
 401       return CoherentFileSet;
 402    float iop[6];
 403
 404    std::string strOrient;
 405    std::ostringstream ossOrient;
 406    FileList::const_iterator it = fileSet->begin();
 407    it ++;
 408    for ( ;
 409          it != fileSet->end();
 410        ++it)
 411    {
 412       // Information is in :
 413       // 0020 0037 : Image Orientation (Patient) or
 414       // 0020 0035 : Image Orientation (RET)
 415
 416       // Let's build again the 'cosines' string, to be sure of it's format
 417       (*it)->GetImageOrientationPatient(iop);
 418
 419       ossOrient << iop[0];
 420       for (int i = 1; i < 6; i++)
 421       {
 422         ossOrient << "\\";
 423         ossOrient << iop[i];
 424       }
 425       strOrient = ossOrient.str();
 426       ossOrient.str("");
 427       // FIXME : is it a 'cleaner' way to initialize an ostringstream?
 428
 429       if ( CoherentFileSet.count(strOrient) == 0 )
 430       {
 431          gdcmDebugMacro(" New Orientation :[" << strOrient << "]");
 432          // create a File set in 'orientation' position
 433          CoherentFileSet[strOrient] = new FileList;
 434       }
 435       // Current Orientation and DICOM header match; add the file:
 436       CoherentFileSet[strOrient]->push_back( (*it) );
 437    }
 438    return CoherentFileSet;
 439 }
 440
 441 /**
 442  * \brief   Splits a 'Single SerieUID' Fileset according to the Positions
 443  * @param fileSet File Set to be splitted
 444  * \return  std::map of 'Xcoherent' File sets
 445  */
 446
 447 XCoherentFileSetmap SerieHelper::SplitOnPosition(FileList *fileSet)
 448 {
 449    XCoherentFileSetmap CoherentFileSet;
 450
 451    int nb = fileSet->size();
 452    if (nb == 0 )
 453       return CoherentFileSet;
 454    float pos[3];
 455    std::string strImPos;  // read on disc
 456    std::ostringstream ossPosition;
 457    std::string strPosition; // re computed
 458    FileList::const_iterator it = fileSet->begin();
 459    it ++;
 460    for ( ;
 461          it != fileSet->end();
 462        ++it)
 463    {
 464       // Information is in :
 465       // 0020,0032 : Image Position Patient
 466       // 0020,0030 : Image Position (RET)
 467
 468       strImPos = (*it)->GetEntryString(0x0020,0x0032);
 469       if ( strImPos == GDCM_UNFOUND)
 470       {
 471          gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 472          strImPos = (*it)->GetEntryString(0x0020,0x0030); // For ACR-NEMA images
 473          if ( strImPos == GDCM_UNFOUND )
 474          {
 475             gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 476             // User wants to split on the 'Position'
 477             // No 'Position' info found.
 478             // We return an empty Htable !
 479             return CoherentFileSet;
 480          }
 481       }
 482
 483       if ( sscanf( strImPos.c_str(), "%f \\%f \\%f ",
 484                                               &pos[0], &pos[1], &pos[2]) != 3 )
 485       {
 486             gdcmWarningMacro( "Wrong number for Position : ["
 487                        << strImPos << "]" );
 488              return CoherentFileSet;
 489       }
 490
 491       // Let's build again the 'position' string, to be sure of it's format
 492
 493       ossPosition << pos[0];
 494       for (int i = 1; i < 3; i++)
 495       {
 496         ossPosition << "\\";
 497         ossPosition << pos[i];
 498       }
 499       strPosition = ossPosition.str();
 500
 501       if ( CoherentFileSet.count(strPosition) == 0 )
 502       {
 503          gdcmDebugMacro(" New Position :[" << strPosition << "]");
 504          // create a File set in 'position' position
 505          CoherentFileSet[strPosition] = new FileList;
 506       }
 507       // Current Position and DICOM header match; add the file:
 508       CoherentFileSet[strPosition]->push_back( (*it) );
 509    }
 510    return CoherentFileSet;
 511 }
 512
 513 /**
 514  * \brief   Splits a 'Single SerieUID' File set Coherent according to the
 515  *          value of a given Tag
 516  * @param fileSet File Set to be splitted
 517  * @param   group  group number of the target Element
 518  * @param   elem element number of the target Element
 519  * \return  std::map of 'Xcoherent' File sets
 520  */
 521
 522 XCoherentFileSetmap SerieHelper::SplitOnTagValue(FileList *fileSet,
 523                                                uint16_t group, uint16_t elem)
 524 {
 525    XCoherentFileSetmap CoherentFileSet;
 526
 527    int nb = fileSet->size();
 528    if (nb == 0 )
 529       return CoherentFileSet;
 530
 531    std::string strTagValue;  // read on disc
 532
 533    FileList::const_iterator it = fileSet->begin();
 534    it ++;
 535    for ( ;
 536          it != fileSet->end();
 537        ++it)
 538    {
 539       // Information is in :
 540       // 0020,0032 : Image Position Patient
 541       // 0020,0030 : Image Position (RET)
 542
 543       strTagValue = (*it)->GetEntryString(group,elem);
 544
 545       if ( CoherentFileSet.count(strTagValue) == 0 )
 546       {
 547          gdcmDebugMacro(" New Tag Value :[" << strTagValue << "]");
 548          // create a File set in 'position' position
 549          CoherentFileSet[strTagValue] = new FileList;
 550       }
 551       // Current Tag value and DICOM header match; add the file:
 552       CoherentFileSet[strTagValue]->push_back( (*it) );
 553    }
 554    return CoherentFileSet;
 555 }
 556
 557 //-----------------------------------------------------------------------------
 558 // Protected
 559
 560 //-----------------------------------------------------------------------------
 561 // Private
 562 /**
 563  * \brief sorts the images, according to their Patient Position
 564  *  We may order, considering :
 565  *   -# Image Position Patient
 566  *   -# Image Number
 567  *   -# File Name
 568  *   -# More to come :-)
 569  * \note : FileList = std::vector<File* >
 570  * @param fileList Coherent File list (same Serie UID) to sort
 571  * @return false only if the header is bugged !
 572  */
 573 bool SerieHelper::ImagePositionPatientOrdering( FileList *fileList )
 574 //based on Jolinda Smith's algorithm
 575 {
 576    //iop is calculated based on the file file
 577    float cosines[6];
 578    float normal[3];
 579    float ipp[3];
 580    float dist;
 581    float min = 0, max = 0;
 582    bool first = true;
 583    int n=0;
 584    std::vector<float> distlist;
 585
 586    //!\todo rewrite this for loop.
 587    for ( FileList::const_iterator
 588          it = fileList->begin();
 589          it != fileList->end(); ++it )
 590    {
 591       if ( first )
 592       {
 593          (*it)->GetImageOrientationPatient( cosines );
 594
 595          // You only have to do this once for all slices in the volume. Next,
 596          // for each slice, calculate the distance along the slice normal
 597          // using the IPP ("Image Position Patient") tag.
 598          // ("dist" is initialized to zero before reading the first slice) :
 599          normal[0] = cosines[1]*cosines[5] - cosines[2]*cosines[4];
 600          normal[1] = cosines[2]*cosines[3] - cosines[0]*cosines[5];
 601          normal[2] = cosines[0]*cosines[4] - cosines[1]*cosines[3];
 602
 603          ipp[0] = (*it)->GetXOrigin();
 604          ipp[1] = (*it)->GetYOrigin();
 605          ipp[2] = (*it)->GetZOrigin();
 606
 607          dist = 0;
 608          for ( int i = 0; i < 3; ++i )
 609          {
 610             dist += normal[i]*ipp[i];
 611          }
 612
 613          distlist.push_back( dist );
 614
 615          max = min = dist;
 616          first = false;
 617       }
 618       else
 619       {
 620          ipp[0] = (*it)->GetXOrigin();
 621          ipp[1] = (*it)->GetYOrigin();
 622          ipp[2] = (*it)->GetZOrigin();
 623
 624          dist = 0;
 625          for ( int i = 0; i < 3; ++i )
 626          {
 627             dist += normal[i]*ipp[i];
 628          }
 629
 630          distlist.push_back( dist );
 631
 632          min = (min < dist) ? min : dist;
 633          max = (max > dist) ? max : dist;
 634       }
 635       ++n;
 636    }
 637
 638    // Then I order the slices according to the value "dist". Finally, once
 639    // I've read in all the slices, I calculate the z-spacing as the difference
 640    // between the "dist" values for the first two slices.
 641    FileVector CoherentFileVector(n);
 642    // CoherentFileVector.reserve( n );
 643    CoherentFileVector.resize( n );
 644    // gdcmAssertMacro( CoherentFileVector.capacity() >= n );
 645
 646    // Find out if min/max are coherent
 647    if ( min == max )
 648    {
 649      gdcmWarningMacro("Looks like all images have the exact same image position"
 650                       << ". No PositionPatientOrdering sort performed" );
 651      return false;
 652    }
 653
 654    float step = (max - min)/(n - 1);
 655    int pos;
 656    n = 0;
 657
 658    //VC++ don't understand what scope is !! it -> it2
 659    for (FileList::const_iterator it2  = fileList->begin();
 660         it2 != fileList->end(); ++it2, ++n)
 661    {
 662       //2*n sort algo !!
 663       //Assumption: all files are present (no one missing)
 664       pos = (int)( fabs( (distlist[n]-min)/step) + .5 );
 665
 666       // a Dicom 'Serie' may contain scout views
 667       // and images may have differents directions
 668       // -> More than one may have the same 'pos'
 669       // Sorting has then NO meaning !
 670       if (CoherentFileVector[pos]==NULL)
 671          CoherentFileVector[pos] = *it2;
 672       else
 673       {
 674          gdcmWarningMacro( "At least 2 files with same position."
 675                         << " No PositionPatientOrdering sort performed");
 676          return false;
 677       }
 678    }
 679
 680    fileList->clear();  // doesn't delete list elements, only nodes
 681
 682    if (DirectOrder)
 683    {
 684       //VC++ don't understand what scope is !! it -> it3
 685       for (FileVector::const_iterator it3  = CoherentFileVector.begin();
 686            it3 != CoherentFileVector.end(); ++it3)
 687       {
 688          fileList->push_back( *it3 );
 689       }
 690    }
 691    else // user asked for reverse order
 692    {
 693       FileVector::const_iterator it4;
 694       it4 = CoherentFileVector.end();
 695       do
 696       {
 697          it4--;
 698          fileList->push_back( *it4 );
 699       } while (it4 != CoherentFileVector.begin() );
 700    }
 701
 702    distlist.clear();
 703    CoherentFileVector.clear();
 704
 705    return true;
 706 }
 707
 708 bool SerieHelper::ImageNumberLessThan(File *file1, File *file2)
 709 {
 710   return file1->GetImageNumber() < file2->GetImageNumber();
 711 }
 712
 713 bool SerieHelper::ImageNumberGreaterThan(File *file1, File *file2)
 714 {
 715   return file1->GetImageNumber() > file2->GetImageNumber();
 716 }
 717
 718 /**
 719  * \brief sorts the images, according to their Image Number
 720  * \note Works only on bona fide files  (i.e image number is a character string
 721  *                                      corresponding to an integer)
 722  *             within a bona fide serie (i.e image numbers are consecutive)
 723  * @param fileList  File set (same Serie UID) to sort
 724  * @return false if non bona fide stuff encountered
 725  */
 726 bool SerieHelper::ImageNumberOrdering(FileList *fileList)
 727 {
 728    int min, max, pos;
 729    int n = fileList->size();
 730
 731    FileList::const_iterator it = fileList->begin();
 732    min = max = (*it)->GetImageNumber();
 733
 734    for (; it != fileList->end(); ++it, ++n)
 735    {
 736       pos = (*it)->GetImageNumber();
 737       min = (min < pos) ? min : pos;
 738       max = (max > pos) ? max : pos;
 739    }
 740
 741    // Find out if image numbers are coherent (consecutive)
 742    if ( min == max || max == 0 || max >= (n+min) )
 743    {
 744       gdcmWarningMacro( " 'Image numbers' not coherent. "
 745                         << " No ImageNumberOrdering sort performed.");
 746       return false;
 747    }
 748    if (DirectOrder)
 749       std::sort(fileList->begin(), fileList->end(),
 750                                           SerieHelper::ImageNumberLessThan );
 751    else
 752       std::sort(fileList->begin(), fileList->end(),
 753                                           SerieHelper::ImageNumberGreaterThan );
 754
 755    return true;
 756 }
 757
 758 bool SerieHelper::FileNameLessThan(File *file1, File *file2)
 759 {
 760    return file1->GetFileName() < file2->GetFileName();
 761 }
 762
 763 bool SerieHelper::FileNameGreaterThan(File *file1, File *file2)
 764 {
 765    return file1->GetFileName() > file2->GetFileName();
 766 }
 767 /**
 768  * \brief sorts the images, according to their File Name
 769  * @param fileList Coherent File list (same Serie UID) to sort
 770  * @return false only if the header is bugged !
 771  */
 772 bool SerieHelper::FileNameOrdering(FileList *fileList)
 773 {
 774    if (DirectOrder)
 775       std::sort(fileList->begin(), fileList->end(),
 776                                        SerieHelper::FileNameLessThan);
 777    else
 778       std::sort(fileList->begin(), fileList->end(),
 779                                        SerieHelper::FileNameGreaterThan);
 780
 781    return true;
 782 }
 783
 784 /**
 785  * \brief sorts the images, according to user supplied function
 786  * @param fileList Coherent File list (same Serie UID) to sort
 787  * @return false only if the header is bugged !
 788  */
 789 bool SerieHelper::UserOrdering(FileList *fileList)
 790 {
 791    std::sort(fileList->begin(), fileList->end(),
 792                                     SerieHelper::UserLessThanFunction);
 793    if (!DirectOrder)
 794    {
 795       std::reverse(fileList->begin(), fileList->end());
 796    }
 797    return true;
 798 }
 799
 800 //-----------------------------------------------------------------------------
 801 // Print
 802 /**
 803  * \brief   Canonical printer.
 804  */
 805 void SerieHelper::Print(std::ostream &os, std::string const &indent)
 806 {
 807    // For all the Coherent File lists of the gdcm::Serie
 808    SingleSerieUIDFileSetmap::iterator itl = SingleSerieUIDFileSetHT.begin();
 809    if ( itl == SingleSerieUIDFileSetHT.end() )
 810    {
 811       gdcmWarningMacro( "No SingleSerieUID File set found" );
 812       return;
 813    }
 814    while (itl != SingleSerieUIDFileSetHT.end())
 815    {
 816       os << "Serie UID :[" << itl->first << "]" << std::endl;
 817
 818       // For all the files of a SingleSerieUID File set
 819       for (FileList::iterator it =  (itl->second)->begin();
 820                                   it != (itl->second)->end();
 821                                 ++it)
 822       {
 823          os << indent << " --- " << (*it)->GetFileName() << std::endl;
 824       }
 825       ++itl;
 826    }
 827 }
 828
 829 //-----------------------------------------------------------------------------
 830 } // end namespace gdcm