src/gdcmRLEFramesInfo.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmRLEFramesInfo.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/20 16:17:00 $
   7   Version:   $Revision: 1.10 $
   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
  20 #ifndef GDCMRLEFRAMESINFO_H
  21 #define GDCMRLEFRAMESINFO_H
  22
  23 #include "gdcmRLEFrame.h"
  24
  25 #include <list>
  26
  27 namespace gdcm
  28 {
  29
  30 /**
  31  * \brief Utility class for gathering the informations of the collection
  32  *        of RLE frame[s] (see \ref RLEFrame)  when handling
  33  *        "Encapsulated RLE Compressed Images" (see PS 3.5-2003 annex G).
  34  *        Note: a classical image can be considered as the degenerated case
  35  *              of a multiframe image. In this case the collection is limited
  36  *              to a single individual frame.
  37  *        The informations on each frame are obtained during the parsing
  38  *        of a Document (refer to
  39  *          \ref Document::ComputeRLEInfo() ).
  40  *        They shall be used when (if necessary) decoding the frames.
  41  *
  42  *        This class is simply a stl list<> of \ref RLEFrame.
  43  */
  44 class GDCM_EXPORT RLEFramesInfo
  45 {
  46    typedef std::list< RLEFrame* > RLEFrameList;
  47 friend class Document;
  48 friend class FileHelper;
  49 friend class PixelReadConvert;
  50    RLEFrameList Frames;
  51 public:
  52    ~RLEFramesInfo();
  53    void Print( std::ostream &os = std::cout, std::string indent = "" );
  54 };
  55 } // end namespace gdcm
  56
  57 //-----------------------------------------------------------------------------
  58 #endif