src/gdcmRLEFramesInfo.h

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