src/gdcmSerieHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSerieHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/07/19 09:04:58 $
   7   Version:   $Revision: 1.13 $
   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 #ifndef GDCMSERIEHELPER_H
  20 #define GDCMSERIEHELPER_H
  21
  22 #include "gdcmCommon.h"
  23
  24 #include <vector>
  25 #include <iostream>
  26 #include <map>
  27
  28 namespace gdcm
  29 {
  30 class File;
  31 typedef std::vector<File* > FileList;
  32
  33 //-----------------------------------------------------------------------------
  34 /**
  35  * \brief
  36  * - This class should be used for a stack of 2D dicom images.
  37  *   It allows to explore (recursively or not) a directory and
  38  *   makes a set of 'Coherent Files' list (coherent : same Serie UID)
  39  *   It allows to sort any of the Coherent File list on the image position
  40  */
  41 class GDCM_EXPORT SerieHelper
  42 {
  43 public:
  44    typedef std::map<std::string, FileList *> CoherentFileListmap;
  45    typedef std::vector<File* > FileVector;
  46
  47    SerieHelper();
  48    ~SerieHelper();
  49    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
  50
  51    /// \todo should return bool or throw error ?
  52    void AddFileName(std::string const &filename);
  53    void AddGdcmFile(File *header);
  54
  55    void SetDirectory(std::string const &dir, bool recursive=false);
  56    void OrderFileList(FileList *coherentFileList);
  57
  58    /// \brief Gets the FIRST *coherent* File List.
  59    ///        Deprecated; kept not to break the API
  60    /// \note Caller must call OrderFileList first
  61    /// @return the (first) *coherent* File List
  62    const FileList &GetFileList() { return *CoherentFileListHT.begin()->second; }
  63
  64    FileList *GetFirstCoherentFileList();
  65    FileList *GetNextCoherentFileList();
  66    FileList *GetCoherentFileList(std::string serieUID);
  67
  68    /// All the following allow user to restrict DICOM file to be part
  69    /// of a particular serie
  70    void AddRestriction(TagKey const &key, std::string const &value);
  71
  72 /**
  73  * \brief Sets the LoadMode as a boolean string.
  74  *        NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
  75  ... (nothing more, right now)
  76  *        WARNING : before using NO_SHADOW, be sure *all* your files
  77  *        contain accurate values in the 0x0000 element (if any)
  78  *        of *each* Shadow Group. The parser will fail if the size is wrong !
  79  * @param   mode Load mode to be used
  80  */
  81    void SetLoadMode (int mode) { LoadMode = mode; }
  82
  83 private:
  84    bool ImagePositionPatientOrdering(FileList *coherentFileList);
  85    bool ImageNumberOrdering(FileList *coherentFileList);
  86    bool FileNameOrdering(FileList *coherentFileList);
  87
  88    static bool ImageNumberLessThan(File *file1, File *file2);
  89    static bool FileNameLessThan(File *file1, File *file2);
  90
  91 //Attributes:
  92    CoherentFileListmap CoherentFileListHT;
  93    CoherentFileListmap::iterator ItListHt;
  94
  95    typedef std::pair<TagKey, std::string> Rule;
  96    typedef std::vector<Rule> SerieRestrictions;
  97    SerieRestrictions Restrictions;
  98
  99    /// \brief Bit string integer (each one considered as a boolean)
 100    ///        Bit 0 : Skip Sequences,    if possible
 101    ///        Bit 1 : Skip Shadow Groups if possible
 102    ///        Probabely, some more to add
 103    int LoadMode;
 104 };
 105
 106 } // end namespace gdcm
 107
 108 //-----------------------------------------------------------------------------
 109 #endif