src/gdcmRLEFrame.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmRLEFrame.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/18 12:49:23 $
   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 GDCMRLEFRAME_H
  21 #define GDCMRLEFRAME_H
  22
  23 #include "gdcmCommon.h"
  24
  25 namespace gdcm
  26 {
  27 /**
  28  * \brief Utility class for summerizing the informations of a SINGLE RLE
  29  *        frame of an "Encapsulated RLE Compressed Image" (refer to
  30  *        PS 3.5-2003 annex G).
  31  *        This information is a mix of:
  32  *        - the RLE Header (see PS 3.5-2003 section G5) and
  33  *        - the lengths of each RLE segment [ which can be decuded from
  34  *          both the above RLE Header and the itemlength of the frame).
  35  *
  36  *        Each instance of this class (they can be as many instances for
  37  *        a given Document as they are frames and they are collected in
  38  *        a \ref RLEFramesInfo ) describes :
  39  *        - the total number of segments (up to 15),
  40  *        - the offsets of each segment of the frame,
  41  *        - the (corresponding) lengths of each segment of the frame.
  42  */
  43 class GDCM_EXPORT RLEFrame
  44 {
  45 friend class Document;
  46 friend class File;
  47 friend class PixelConvert;
  48    int     NumberFragments;
  49    long    Offset[15];
  50    long    Length[15];
  51    RLEFrame() { NumberFragments = 0; }
  52
  53 };
  54 } // end namespace gdcm
  55 //-----------------------------------------------------------------------------
  56 #endif