Doxygenation

[gdcm.git] / src / gdcmPixelReadConvert.h

diff --git a/src/gdcmPixelReadConvert.h b/src/gdcmPixelReadConvert.h
index 743d1ef53e8baa640369599d1d92883f406b21e2..79d882a6564efda1c023be5782ed409eece8c69a 100644 (file)
--- a/src/gdcmPixelReadConvert.h
+++ b/src/gdcmPixelReadConvert.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmPixelReadConvert.h,v $
   Language:  C++
-  Date:      $Date: 2004/12/03 20:16:58 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/01/06 16:07:34 $
+  Version:   $Revision: 1.8 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -21,6 +21,7 @@
 #define GDCMPIXELREADCONVERT_H
 
 #include "gdcmCommon.h"
+#include "gdcmBase.h"
 #include "gdcmException.h"
 
 namespace gdcm
@@ -32,7 +33,7 @@ class JPEGFragmentsInfo;
  * \brief Utility container for gathering the various forms the pixel data
  *        migth take during the user demanded processes.
  */
-class GDCM_EXPORT PixelReadConvert
+class GDCM_EXPORT PixelReadConvert : public Base
 {
 public:
    PixelReadConvert();
@@ -41,13 +42,14 @@ public:
    //// Getter accessors:
    uint8_t* GetRGB() { return RGB; }
    size_t   GetRGBSize() { return RGBSize; }
-   uint8_t* GetDecompressed() { return Decompressed; }
-   size_t   GetDecompressedSize() { return DecompressedSize; }
+   uint8_t* GetRaw() { return Raw; }
+   size_t   GetRawSize() { return RawSize; }
    uint8_t* GetLutRGBA() { return LutRGBA; }
 
    //// Predicates:
-   bool IsDecompressedRGB();
+   bool IsRawRGB();
 
+   void Print( std::ostream &os = std::cout );
    void Print( std::string indent = "", std::ostream &os = std::cout );
 
 // In progress
@@ -66,6 +68,11 @@ private:
    void ReadAndDecompress12BitsTo16Bits( std::ifstream* fp ) throw ( FormatError );
    bool ReadAndDecompressRLEFile( std::ifstream* fp );
    bool ReadAndDecompressJPEGFile( std::ifstream* fp );
+   bool ReadAndDecompressJPEGFramesFromFile( std::ifstream* fp );
+   bool ReadAndDecompressJPEGSingleFrameFragmentsFromFile( std::ifstream* fp );
+   bool ReadAndDecompressJPEGFragmentedFramesFromFile( std::ifstream* fp );
+
+
    void BuildLUTRGBA( std::ifstream* fp );
 
    // In place (within Decompressed and with no fp access) decompression
@@ -79,19 +86,19 @@ private:
    void ConvertYcBcRPlanesToRGBPixels();
    void ConvertHandleColor();
 
-   void ComputeDecompressedAndRGBSizes();
+   void ComputeRawAndRGBSizes();
    void AllocateRGB();
-   void AllocateDecompressed();
+   void AllocateRaw();
 
 // Variables
    /// Pixel data represented as RGB after LUT color interpretation.
    uint8_t* RGB;
-   /// Size of \ref RGB image.
+   /// Size of RGB image.
    size_t   RGBSize;
    /// Pixel data after decompression and bit/byte rearrangement.
-   uint8_t* Decompressed;
-   /// Size of \ref Decompressed image.
-   size_t   DecompressedSize;
+   uint8_t* Raw;
+   /// Size of Decompressed image.
+   size_t   RawSize;
    /// \brief Red/Green/Blue/Alpha LookUpTable build out of the
    ///        Red/Green/Blue LUT descriptors (see \ref BuildLUTRGBA ).
    uint8_t* LutRGBA;
@@ -109,7 +116,7 @@ private:
    bool PixelSign;
    int SwapCode;
 
-   bool IsDecompressed;
+   bool IsRaw;
    bool IsJPEG2000;
    bool IsJPEGLossless;
    bool IsRLELossless;