Typo

[gdcm.git] / src / gdcmRLEFramesInfo.cxx

diff --git a/src/gdcmRLEFramesInfo.cxx b/src/gdcmRLEFramesInfo.cxx
index cc7a5ca9a09a77942c9d35e8a1cc8778a3eca490..2c184116f5f6909ef38d62de1afd6008cc3ba207 100644 (file)
--- a/src/gdcmRLEFramesInfo.cxx
+++ b/src/gdcmRLEFramesInfo.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmRLEFramesInfo.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/31 06:17:22 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/02/11 17:01:46 $
+  Version:   $Revision: 1.15 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -21,7 +21,8 @@
 
 namespace gdcm 
 {
-
+//-------------------------------------------------------------------------
+// Constructor / Destructor
 RLEFramesInfo::~RLEFramesInfo()
 {
    for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it)
@@ -31,30 +32,8 @@ RLEFramesInfo::~RLEFramesInfo()
    Frames.clear();
 }
 
-/**
- * \brief        Print self.
- * @param indent Indentation string to be prepended during printing.
- * @param os     Stream to print to.
- */
-void RLEFramesInfo::Print( std::ostream &os, std::string indent )
-{
-   os << std::endl;
-   os << indent
-      << "----------------- RLE frames --------------------------------"
-      << std::endl;
-   os << indent
-      << "Total number of Frames : " << Frames.size()
-      << std::endl;
-   int frameNumber = 0;
-   for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it)
-   {
-      os << indent
-         << "   frame number :" << frameNumber++
-         << std::endl;
-      (*it)->Print( os, indent + "   " );
-   }
-}
-
+//-----------------------------------------------------------------------------
+// Public
 void RLEFramesInfo::AddFrame(RLEFrame *frame)
 {
    Frames.push_back(frame);
@@ -83,9 +62,16 @@ RLEFrame *RLEFramesInfo::GetNextFrame()
  *            Dicom encapsulated file and decompress it.
  * @param     fp already open File Pointer
  *            at which the pixel data should be copied
+ * @param raw raw
+ * @param xSize x Size
+ * @param ySize y Size
+ * @param zSize z Size
+ * @param bitsAllocated Bits allocated
  * @return    Boolean
  */
-bool RLEFramesInfo::DecompressRLEFile( std::ifstream *fp , uint8_t *raw, int xSize, int ySize, int zSize, int bitsAllocated )
+bool RLEFramesInfo::DecompressRLEFile( std::ifstream *fp , uint8_t *raw, 
+                                       int xSize, int ySize, int zSize, 
+                                       int bitsAllocated )
 {
    uint8_t *subRaw = raw;
    long rawSegmentSize = xSize * ySize;
@@ -106,15 +92,17 @@ bool RLEFramesInfo::DecompressRLEFile( std::ifstream *fp , uint8_t *raw, int xSi
 }
 
 /**
- * \brief     Try to deal with RLE 16 Bits. 
- *            We assume the RLE has already been parsed and loaded in
- *            Raw (through \ref ReadAndDecompressJPEGFile ).
- *            We here need to make 16 Bits Pixels from Low Byte and
- *            High Byte 'Planes'...(for what it may mean)
- * @return    Boolean
+ * \brief  We assume Raw contains the decoded RLE pixels but as
+ *         8 bits per pixel. We convert those pixels to 16 bits
+ *         per pixel.
+ * @param raw raw 
+ * @param xSize x Size
+ * @param ySize y Size
+ * @param numberOfFrames number of frames 
+ * @return    Boolean always true
  */
-bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits( uint8_t* raw, int xSize, 
-                                             int ySize,int numberOfFrames  )
+bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits(uint8_t *raw, int xSize, 
+                                                 int ySize, int numberOfFrames)
 {
    size_t pixelNumber = xSize * ySize;
    size_t rawSize = xSize * ySize * numberOfFrames;
@@ -124,12 +112,12 @@ bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits( uint8_t* raw, int xSize,
    // per pixel we cannot work in place within Raw and hence
    // we copy it in a safe place, say copyRaw.
 
-   uint8_t* copyRaw = new uint8_t[rawSize * 2];
+   uint8_t *copyRaw = new uint8_t[rawSize * 2];
    memmove( copyRaw, raw, rawSize * 2 );
 
-   uint8_t* x = raw;
-   uint8_t* a = copyRaw;
-   uint8_t* b = a + pixelNumber;
+   uint8_t *x = raw;
+   uint8_t *a = copyRaw;
+   uint8_t *b = a + pixelNumber;
 
    for ( int i = 0; i < numberOfFrames; i++ )
    {
@@ -139,12 +127,42 @@ bool RLEFramesInfo::ConvertRLE16BitsFromRLE8Bits( uint8_t* raw, int xSize,
          *(x++) = *(a++);
       }
    }
-
    delete[] copyRaw;
-      
-   /// \todo check that operator new []didn't fail, and sometimes return false
+
    return true;
 }
 
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief        Print self.
+ * @param indent Indentation string to be prepended during printing.
+ * @param os     Stream to print to.
+ */
+void RLEFramesInfo::Print( std::ostream &os, std::string indent )
+{
+   os << std::endl;
+   os << indent
+      << "----------------- RLE frames --------------------------------"
+      << std::endl;
+   os << indent
+      << "Total number of Frames : " << Frames.size()
+      << std::endl;
+   int frameNumber = 0;
+   for(RLEFrameList::iterator it = Frames.begin(); it != Frames.end(); ++it)
+   {
+      os << indent
+         << "   frame number :" << frameNumber++
+         << std::endl;
+      (*it)->Print( os, indent + "   " );
+   }
+}
 
+//-----------------------------------------------------------------------------
 } // end namespace gdcm