X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmPixelReadConvert.h;h=4aac9d3d3bdf83a663f2a9f1d87ef216564cf3f2;hb=20233e0e4bc268a63105f697c663feedecbe99f7;hp=f82f292db433e7dd7ddef35eae024366c45143a4;hpb=62b3ec331e9eba81d12a0c0b0f2017cd679ba487;p=gdcm.git

diff --git a/src/gdcmPixelReadConvert.h b/src/gdcmPixelReadConvert.h
index f82f292d..4aac9d3d 100644
--- a/src/gdcmPixelReadConvert.h
+++ b/src/gdcmPixelReadConvert.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelReadConvert.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 08:29:50 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2005/10/23 15:09:19 $
+  Version:   $Revision: 1.26 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -40,19 +40,28 @@ typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *);
  */
 class GDCM_EXPORT PixelReadConvert : public Base
 {
-public:
+friend class FileHelper;
+
+private:
    PixelReadConvert();
    virtual ~PixelReadConvert();
 
    void Print( std::ostream &os = std::cout, std::string const &indent = "" );
 
    // Getter accessors:
+   /// \brief returns pixel area holding RGB Pixels, made from Grey level + LUT
    uint8_t *GetRGB()           { return RGB;     }
+   /// \brief returns pixel area length -RGB Pixels, (from Grey level + LUT)-
    size_t   GetRGBSize()       { return RGBSize; }
+   /// \brief returns pixel area holding native RGB Pixels or Grey level
    uint8_t *GetRaw()           { return Raw;     }
+   /// \brief returns pixel area size -native RGB Pixels or Grey level-
    size_t   GetRawSize()       { return RawSize; }
+   /// \brief returns Red Green Blue Alpha LUT
    uint8_t *GetLutRGBA()       { return LutRGBA; }
+   /// \brief returns Lut Item Number
    int      GetLutItemNumber() { return LutItemNumber; }
+   /// \brief returns Lut Item Size
    int      GetLutItemSize()   { return LutItemSize;   }
    // Predicates:
    bool IsRawRGB();
@@ -63,10 +72,11 @@ public:
    void Squeeze();
    bool BuildRGBImage();
    void BuildLUTRGBA();
-
+/// \brief Allow user to pass his own function to modify pixels 
+///        (e.g; mirror, upsidedown, ...) just after reading
    void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc ) 
                          { UserFunction = userFunc; }
-private:
+
    // Use the fp:
    void ReadAndDecompress12BitsTo16Bits( std::ifstream *fp ) 
                                  throw ( FormatError );