]> Creatis software - gdcm.git/blob - src/gdcmPixelWriteConvert.h
Some more Doxygenation (for Doc/html.developper/annotated.html)
[gdcm.git] / src / gdcmPixelWriteConvert.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmPixelWriteConvert.h,v $
5   Language:  C++
6   Date:      $Date: 2005/01/11 15:15:38 $
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 GDCMPIXELWRITECONVERT_H
21 #define GDCMPIXELWRITECONVERT_H
22
23 #include "gdcmCommon.h"
24 #include "gdcmBase.h"
25
26 namespace gdcm
27 {
28 /**
29  * \brief Utility container for gathering the various forms the pixel data
30  *        migth take during the user demanded processes.
31  */
32 class GDCM_EXPORT PixelWriteConvert : public Base
33 {
34 public:
35    PixelWriteConvert();
36    virtual ~PixelWriteConvert();
37
38    // Set/Get of images and their size
39    void SetReadData(uint8_t *data,size_t size);
40    uint8_t *GetReadData() { return ReadData; }
41    size_t   GetReadDataSize() { return ReadDataSize; }
42
43    void SetUserData(uint8_t *data,size_t size);
44    uint8_t *GetUserData() { return UserData; }
45    size_t   GetUserDataSize() { return UserDataSize; }
46
47    // Get the used image and its size
48    uint8_t *GetData();
49    size_t   GetDataSize();
50
51 private:
52 // Variables
53    /// Pixel data represented as RGB after LUT color interpretation.
54    uint8_t *ReadData;
55    /// Size of RGB image.
56    size_t   ReadDataSize;
57
58    /// User pixel data
59    uint8_t *UserData;
60    /// Size of User image.
61    size_t   UserDataSize;
62 };
63 } // end namespace gdcm
64
65 //-----------------------------------------------------------------------------
66 #endif