src/gdcmSerieHeader.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSerieHeader.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/14 21:30:53 $
   7   Version:   $Revision: 1.6 $
   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 GDCMSERIEHEADER_H
  20 #define GDCMSERIEHEADER_H
  21
  22 #include "gdcmCommon.h"
  23 #include <list>
  24
  25 namespace gdcm
  26 {
  27 class Header;
  28 //-----------------------------------------------------------------------------
  29 /**
  30  * \ingroup SerieHeader
  31  * \brief
  32  * - This class should be used for a stack of 2D dicom images.
  33  * - For a multiframe dicom image better use directly SerieHeader
  34 */
  35 class GDCM_EXPORT SerieHeader
  36 {
  37 public:
  38    typedef std::list<Header* > GdcmHeaderList;
  39
  40     SerieHeader();
  41     ~SerieHeader();
  42
  43    /// \todo should return bool or throw error ?
  44    void AddFileName(std::string const &filename);
  45    void SetDirectory(std::string const &dir);
  46    void OrderGdcmFileList();
  47
  48    /// \brief Gets the *coherent* File List
  49    /// @return the *coherent* File List
  50    /// Caller must call OrderGdcmFileList first
  51    const GdcmHeaderList &GetGdcmFileList() { return CoherentGdcmFileList; }
  52
  53 private:
  54    bool ImagePositionPatientOrdering();
  55    bool ImageNumberOrdering();
  56    bool FileNameOrdering();
  57
  58    GdcmHeaderList CoherentGdcmFileList;
  59    /// Ref to the current Serie Instance UID to avoid mixing two series
  60    /// within the same directory
  61    std::string    CurrentSerieUID;
  62 };
  63
  64 } // end namespace gdcm
  65
  66 //-----------------------------------------------------------------------------
  67 #endif