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