]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
*FIX : gdcmHeader::LoadElements is now based
[gdcm.git] / src / gdcmFile.cxx
index da30b3d0c4663eb998e0b942ac013b8547a49393..4b22d148d7ec4823f52bdf2e5f1ae1fbc130241a 100644 (file)
@@ -56,11 +56,15 @@ void gdcmFile::SetPixelDataSizeFromHeader(void) {
       nb = atoi(str_nb.c_str() );
       if (nb == 12) nb =16;
    }
-   lgrTotale =  GetXSize() *  GetYSize() *  GetZSize() 
+   lgrTotale =  lgrTotaleRaw = GetXSize() *  GetYSize() *  GetZSize() 
               * (nb/8)* GetSamplesPerPixel();
    std::string str_PhotometricInterpretation = 
                              gdcmHeader::GetPubElValByNumber(0x0028,0x0004);
-   if ( str_PhotometricInterpretation == "PALETTE COLOR " ) { 
+                            
+   /*if ( str_PhotometricInterpretation == "PALETTE COLOR " )*/
+   // pb when undealt Segmented Palette Color
+   
+    if (HasLUT()) { 
       lgrTotale*=3;
    }
 }
@@ -92,6 +96,21 @@ void gdcmFile::SetPixelDataSizeFromHeader(void) {
   // 0028|1203 [US]   [Blue Palette Color Lookup Table Data]
 
 
+/////////////////////////////////////////////////////////////////
+/**
+ * \ingroup   gdcmFile
+ * \brief     Returns the size (in bytes) of required memory to hold
+ * \          the pixel data represented in this file, when user DOESN'T want 
+ * \          to get RGB pixels image when it's stored as a PALETTE COLOR image
+ * \          - the (vtk) user is supposed to know how deal with LUTs - 
+ * \          warning to be used with GetImagePixelsRaw()
+ * @return    The size of pixel data in bytes.
+ */
+
+size_t gdcmFile::GetImageDataSizeRaw(void) {
+   return (lgrTotaleRaw);
+}
+
 /////////////////////////////////////////////////////////////////
 /**
  * \ingroup   gdcmFile
@@ -286,6 +305,9 @@ bool gdcmFile::ReadPixelData(void* destination) {
  * \ingroup gdcmFile
  * \brief   Allocates necessary memory, copies the pixel data
  *          (image[s]/volume[s]) to newly allocated zone.
+ *          Transforms YBR pixels into RGB pixels if any
+            Transforms 3 planes R, G, B into a single RGB Plane
+           Transforms single Grey plane + 3 Palettes into a RGB Plane
  * @return  Pointer to newly allocated pixel data.
  * \        NULL if alloc fails 
  */
@@ -296,6 +318,27 @@ void * gdcmFile::GetImageData (void) {
    return(PixelData);
 }
 
+/**
+ * \ingroup gdcmFile
+ * \brief   Allocates necessary memory, copies the pixel data
+ *          (image[s]/volume[s]) to newly allocated zone.
+ *          Transforms YBR pixels into RGB pixels if any
+            Transforms 3 planes R, G, B into a single RGB Plane
+           DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
+ * @return  Pointer to newly allocated pixel data.
+ * \        NULL if alloc fails 
+ */
+void * gdcmFile::GetImageDataRaw (void) {
+   if (HasLUT())
+      lgrTotale /= 3;  // TODO Let gdcmHeadar user a chance 
+                       // to get the right value
+                      // Create a member lgrTotaleRaw ???
+   PixelData = (void *) malloc(lgrTotale);
+   if (PixelData)
+      GetImageDataIntoVectorRaw(PixelData, lgrTotale);
+   return(PixelData);
+}
+
 /**
  * \ingroup gdcmFile
  * \brief   Copies at most MaxSize bytes of pixel data to caller's
@@ -303,11 +346,11 @@ void * gdcmFile::GetImageData (void) {
  * \warning This function was designed to avoid people that want to build
  *          a volume from an image stack to need first to get the image pixels 
  *          and then move them to the volume area.
- *          It's absolutely useless for VTK users since vtk chooses 
+ *          It's absolutely useless for any VTK user since vtk chooses 
  *          to invert the lines of an image, that is the last line comes first
  *          (for some axis related reasons?). Hence he will have 
  *          to load the image line by line, starting from the end.
- *          VTK users hace to call GetImageData
+ *          VTK users have to call GetImageData
  *     
  * @param   destination Address (in caller's memory space) at which the
  *          pixel data should be copied
@@ -320,6 +363,92 @@ void * gdcmFile::GetImageData (void) {
 
 size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
 
+   size_t l = GetImageDataIntoVectorRaw (destination, MaxSize);
+   
+   if (!HasLUT())
+      return lgrTotale; 
+                            
+         //       from Lut R + Lut G + Lut B
+         
+   unsigned char * newDest = (unsigned char *)malloc(lgrTotale);
+   unsigned char * a       = (unsigned char *)destination;      
+   unsigned char * lutRGBA = (unsigned char *)GetLUTRGBA();
+   if (lutRGBA) {          
+      int l = lgrTotaleRaw;
+      memmove(newDest, destination, l);// move Gray pixels to temp area            
+      int j;    
+      for (int i=0;i<l; i++) {         // Build RGB Pixels
+         j=newDest[i]*4;
+         *a++ = lutRGBA[j]; 
+         *a++ = lutRGBA[j+1];
+         *a++ = lutRGBA[j+2];
+      }
+      free(newDest);
+    
+   // now, it's an RGB image
+   // Lets's write it in the Header
+
+         // CreateOrReplaceIfExist ?
+        
+   std::string spp = "3";        // Samples Per Pixel
+   gdcmHeader::SetPubElValByNumber(spp,0x0028,0x0002);
+   std::string rgb= "RGB ";      // Photometric Interpretation
+   gdcmHeader::SetPubElValByNumber(rgb,0x0028,0x0004);
+   std::string planConfig = "0"; // Planar Configuration
+   gdcmHeader::SetPubElValByNumber(planConfig,0x0028,0x0006);
+       
+               
+   } else { 
+            // need to make RGB Pixels (?)
+             //    from grey Pixels (?!)
+             //     and Gray Lut  (!?!) 
+            //    or Segmented xxx Palette Color Lookup Table Data and so on
+                 
+             // Well . I'll wait till I find such an image 
+                                 
+                  // Oops! I get one (gdcm-US-ALOKA-16.dcm)
+                   // No idea how to manage it 
+                  // It seems that *no Dicom Viewer* has any idea :-(
+                  // Segmented xxx Palette Color are *more* than 65535 long ?!?
+                  
+      std::string rgb= "MONOCHROME1 ";      // Photometric Interpretation
+      gdcmHeader::SetPubElValByNumber(rgb,0x0028,0x0004);                 
+                  
+   }   
+        
+   // TODO : Drop Palette Color out of the Header?          
+   return lgrTotale; 
+}
+
+
+
+/**
+ * \ingroup gdcmFile
+ * \brief   Copies at most MaxSize bytes of pixel data to caller's
+ *          memory space.
+ * \warning This function was designed to avoid people that want to build
+ *          a volume from an image stack to need first to get the image pixels 
+ *          and then move them to the volume area.
+ *          It's absolutely useless for any VTK user since vtk chooses 
+ *          to invert the lines of an image, that is the last line comes first
+ *          (for some axis related reasons?). Hence he will have 
+ *          to load the image line by line, starting from the end.
+ *          VTK users hace to call GetImageData
+  * \warning DOES NOT transform the Grey Plane + Palette Color (if any) 
+ *                   into a single RGB Pixels Plane
+ *          the (VTK) user will manage the palettes
+ *     
+ * @param   destination Address (in caller's memory space) at which the
+ *          pixel data should be copied
+ * @param   MaxSize Maximum number of bytes to be copied. When MaxSize
+ *          is not sufficient to hold the pixel data the copy is not
+ *          executed (i.e. no partial copy).
+ * @return  On success, the number of bytes actually copied. Zero on
+ *          failure e.g. MaxSize is lower than necessary.
+ */
+
+size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
+
    int nb, nbu, highBit, signe;
    std::string str_nbFrames, str_nb, str_nbu, str_highBit, str_signe;
  
@@ -449,10 +578,15 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
          if (str_PhotometricInterpretation == "YBR_FULL") { 
         
         // Warning : YBR_FULL_422 acts as RGB
-         //       need to make RGB Pixels from Planes Y,cB,cR
+         //         : we need to make RGB Pixels from Planes Y,cB,cR
          // see http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
          // for code optimisation
-
+        
+        // to see the tricks about YBR_FULL, YBR_FULL_422, 
+         // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at :
+        //   ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf
+        // and be *very* affraid
+        //
             int l = GetXSize()*GetYSize();
             int nbFrames = GetZSize();
 
@@ -490,7 +624,7 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
 
         } else {
          
-         //       need to make RGB Pixels from Planes R,G,B
+         //       need to make RGB Pixels from R,G,B Planes
         //       (all the Frames at a time)
 
             int l = GetXSize()*GetYSize()*GetZSize();
@@ -515,58 +649,22 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
        }
      
        case 2:                      
-         //       from Lut R + Lut G + Lut B
-
-         {
-         unsigned char * newDest = (unsigned char *)malloc(lgrTotale);
-         unsigned char * a       = (unsigned char *)destination;
-        
-         unsigned char * lutRGBA = (unsigned char *) GetLUTRGBA();
-        if (lutRGBA) { 
-           
-         int l = lgrTotale/3;
-         memmove(newDest, destination, l);// move Gray pixels to temp area         
-        int j;  
-         for (int i=0;i<l; i++) {         // Build RGB Pixels
-            j=newDest[i]*4;
-            *a++ = lutRGBA[j]; 
-            *a++ = lutRGBA[j+1];
-            *a++ = lutRGBA[j+2];
-         }
-            free(newDest);
-               
-         } else { 
-            // need to make RGB Pixels (?)
-             //    from grey Pixels (?!)
-             //     and Gray Lut  (!?!) 
-            //    or Segmented Green Palette Color Lookup Table Data and so on
-                 
-             // Well . I'll wait till I find such an image 
-                                 
-                  // Oops! I get one (gdcm-US-ALOKA-16.dcm)
-                   // No idea how to manage it 
-                  // It seems that *no Dicom Viewer* has any idea :-(
-                  // Segmented xxx Palette Color are *more* than 65535 long ?!?
-                           
-            // WARNING : quick and dirty trick to produce 
-           //           a single plane Grey image
-           // See also  gdcmHeaderHelper::GetNumberOfScalarComponents()                              
-                   lgrTotale /=3;
-                   return lgrTotale;
-           // end of dirty trick
-         }
-         break;
-      }
+         //       Palettes were found
+        //       Let the user deal with them !
+         return lgrTotale;        
    } 
             // now, it's an RGB image
             // Lets's write it in the Header
 
          // CreateOrReplaceIfExist ?
         
+
+
    std::string spp = "3";        // Samples Per Pixel
    gdcmHeader::SetPubElValByNumber(spp,0x0028,0x0002);
-   std::string rgb="RGB ";       // Photometric Interpretation
+   std::string rgb="RGB ";   // Photometric Interpretation
    gdcmHeader::SetPubElValByNumber(rgb,0x0028,0x0004);
+
    std::string planConfig = "0"; // Planar Configuration
    gdcmHeader::SetPubElValByNumber(planConfig,0x0028,0x0006);
         
@@ -576,6 +674,7 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
 }
 
 
+
 /**
  * \ingroup gdcmFile
  * \brief   Swap the bytes, according to swap code.