]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
update
[gdcm.git] / src / gdcmFile.cxx
index 3193f55406b763bafb89817c03037a80b2853dce..aa60bd7683b271c24715a09e712ccb35c61ba194 100644 (file)
@@ -1,7 +1,7 @@
 // gdcmFile.cxx
 //-----------------------------------------------------------------------------
 #include "gdcmFile.h"
-#include "gdcmUtil.h"
+#include "gdcmDebug.h"
 #include "jpeg/ljpg/jpegless.h"
 
 typedef std::pair<TagHeaderEntryHT::iterator,TagHeaderEntryHT::iterator> IterHT;
@@ -22,7 +22,6 @@ typedef std::pair<TagHeaderEntryHT::iterator,TagHeaderEntryHT::iterator> IterHT;
  * @param header file to be opened for reading datas
  * @return     
  */
 gdcmFile::gdcmFile(gdcmHeader *header) {
    Header=header;
    SelfHeader=false;
@@ -44,9 +43,25 @@ gdcmFile::gdcmFile(gdcmHeader *header) {
  *        one sets an a posteriori shadow dictionary (efficiency can be
  *        seen as a side effect).   
  * @param filename file to be opened for parsing
+ * @param   exception_on_error whether we throw an exception or not
+ * @param   enable_sequences = true to allow the header 
+ *          to be parsed *inside* the SeQuences, 
+ *          when they have an actual length 
+ * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files
+ * @param   ignore_shadow to allow skipping the shadow elements, 
+ *          to save memory space.
+ * \warning The TRUE value for this param has to be used 
+ *          with a FALSE value for the 'enable_sequence' param.
+ *          ('public elements' may be embedded in 'shadow Sequences')
  */
-gdcmFile::gdcmFile(std::string & filename) {
-   Header=new gdcmHeader(filename.c_str());
+gdcmFile::gdcmFile(std::string & filename, 
+                   bool exception_on_error,
+                   bool enable_sequences, 
+                   bool ignore_shadow) {
+   Header=new gdcmHeader(filename.c_str(),
+                         exception_on_error,
+                         enable_sequences,
+                         ignore_shadow);
    SelfHeader=true;
    PixelRead=-1; // no ImageData read yet.
 
@@ -66,9 +81,25 @@ gdcmFile::gdcmFile(std::string & filename) {
  *        one sets an a posteriori shadow dictionary (efficiency can be
  *        seen as a side effect).   
  * @param filename file to be opened for parsing
+ * @param   exception_on_error whether we throw an exception or not
+ * @param   enable_sequences = true to allow the header 
+ *          to be parsed *inside* the SeQuences, 
+ *          when they have an actual length 
+ * \warning enable_sequences *has to be* true for reading PAPYRUS 3.0 files
+ * @param   ignore_shadow to allow skipping the shadow elements, 
+ *          to save memory space.
+ * \warning The TRUE value for this param has to be used 
+ *          with a FALSE value for the 'enable_sequence' param.
+ *          ('public elements' may be embedded in 'shadow Sequences')
  */
- gdcmFile::gdcmFile(const char * filename) {
-   Header=new gdcmHeader(filename);
+ gdcmFile::gdcmFile(const char * filename, 
+                   bool exception_on_error,
+                   bool enable_sequences, 
+                   bool ignore_shadow) {
+   Header=new gdcmHeader(filename,
+                         exception_on_error,
+                         enable_sequences,
+                         ignore_shadow);
    SelfHeader=true;
    PixelRead=-1; // no ImageData read yet.
 
@@ -79,7 +110,7 @@ gdcmFile::gdcmFile(std::string & filename) {
 /**
  * \ingroup   gdcmFile
  * \brief canonical destructor
- * \Note  If the gdcmHeader is created by the gdcmFile, it is destroyed
+ * \note  If the gdcmHeader is created by the gdcmFile, it is destroyed
  *        by the gdcmFile
  */
 gdcmFile::~gdcmFile(void) {
@@ -95,7 +126,7 @@ gdcmFile::~gdcmFile(void) {
 // Public
 /**
  * \ingroup   gdcmFile
- * \brief     
+ * \brief returns the gdcmHeader *Header   
  * @return     
  */
 gdcmHeader *gdcmFile::GetHeader(void) {
@@ -193,9 +224,10 @@ size_t gdcmFile::GetImageDataSizeRaw(void) {
  *          NULL if alloc fails 
  */
 void * gdcmFile::GetImageData (void) {
-   PixelData = (void *) malloc(lgrTotale);
+   PixelData = new char[lgrTotale];
    if (PixelData)
       GetImageDataIntoVector(PixelData, lgrTotale);
+      
    PixelRead=0; // no PixelRaw
    return(PixelData);
 }
@@ -222,13 +254,14 @@ void * gdcmFile::GetImageData (void) {
  *          failure e.g. MaxSize is lower than necessary.
  */
 size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
-   size_t l = GetImageDataIntoVectorRaw (destination, MaxSize);
+   //size_t l = GetImageDataIntoVectorRaw (destination, MaxSize);
+        GetImageDataIntoVectorRaw (destination, MaxSize);
    PixelRead=0 ; // no PixelRaw
    if (!Header->HasLUT())
       return lgrTotale; 
                             
    // from Lut R + Lut G + Lut B
-   unsigned char * newDest = (unsigned char *)malloc(lgrTotale);
+   unsigned char * newDest = new (unsigned char)[lgrTotale];
    unsigned char * a       = (unsigned char *)destination;      
    unsigned char * lutRGBA =                  Header->GetLUTRGBA();
    if (lutRGBA) {          
@@ -241,7 +274,7 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
          *a++ = lutRGBA[j+1];
          *a++ = lutRGBA[j+2];
       }
-      free(newDest);
+      delete[] newDest;
     
    // now, it's an RGB image
    // Lets's write it in the Header
@@ -269,7 +302,7 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
       std::string rgb= "MONOCHROME1 ";      // Photometric Interpretation
       Header->SetEntryByNumber(rgb,0x0028,0x0004);                                
    }            
-   // TODO : Drop Palette Color out of the Header?          
+   /// \todo Drop Palette Color out of the Header?          
    return lgrTotale; 
 }
 
@@ -285,10 +318,10 @@ size_t gdcmFile::GetImageDataIntoVector (void* destination, size_t MaxSize) {
  */
 void * gdcmFile::GetImageDataRaw (void) {
    if (Header->HasLUT())
-      lgrTotale /= 3;  // TODO Let gdcmHeadar user a chance 
-                       // to get the right value
-                      // Create a member lgrTotaleRaw ???
-   PixelData = (void *) malloc(lgrTotale);
+      /// \todo Let gdcmHeadar user a chance to get the right value
+               /// Create a member lgrTotaleRaw ???
+      lgrTotale /= 3;
+   PixelData = new char[lgrTotale];
    if (PixelData)
       GetImageDataIntoVectorRaw(PixelData, lgrTotale);
    PixelRead=1; // PixelRaw
@@ -332,7 +365,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
    }
        
    (void)ReadPixelData(destination);
-       
+       
        // Number of Bits Allocated for storing a Pixel
    str_nb = Header->GetEntryByNumber(0x0028,0x0100);
    if (str_nb == GDCM_UNFOUND ) {
@@ -378,7 +411,6 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
           deb++;   
          }
     }
-
    // re arange bits inside the bytes
    if (nbu != nb){
       int l = (int)lgrTotale / (nb/8);
@@ -403,7 +435,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
          return (size_t)0; 
       }
    } 
-// DO NOT remove this code commented out.
+// DO NOT remove this commented out code .
 // Nobody knows what's expecting you ...
 // Just to 'see' what was actually read on disk :-(
 
@@ -460,17 +492,17 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
             int l = Header->GetXSize()*Header->GetYSize();
             int nbFrames = Header->GetZSize();
 
-            unsigned char * newDest = (unsigned char*) malloc(lgrTotale);
+            unsigned char * newDest = new (unsigned char)[lgrTotale];
             unsigned char *x  = newDest;
             unsigned char * a = (unsigned char *)destination;
             unsigned char * b = a + l;
             unsigned char * c = b + l;
             double R,G,B;
 
-            // TODO : Replace by the 'well known' 
-            //        integer computation counterpart
-           // see http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
-            // for code optimisation
+            /// \todo : Replace by the 'well known' integer computation
+            /// counterpart
+                /// see http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
+            /// for code optimisation
            
             for (int i=0;i<nbFrames;i++) {
                for (int j=0;j<l; j++) {
@@ -492,7 +524,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
                }
            }
             memmove(destination,newDest,lgrTotale);
-            free(newDest);
+            delete[] newDest;
 
         } else {
          
@@ -501,7 +533,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
 
             int l = Header->GetXSize()*Header->GetYSize()*Header->GetZSize();
 
-            char * newDest = (char*) malloc(lgrTotale);
+            char * newDest = new char[lgrTotale];
             char * x = newDest;
             char * a = (char *)destination;
             char * b = a + l;
@@ -513,7 +545,7 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
                *(x++) = *(c++);  
             }           
             memmove(destination,newDest,lgrTotale);
-            free(newDest);
+            delete[] newDest;
         }        
          break;
        }     
@@ -535,18 +567,19 @@ size_t gdcmFile::GetImageDataIntoVectorRaw (void* destination, size_t MaxSize) {
    std::string planConfig = "0"; // Planar Configuration
    Header->SetEntryByNumber(planConfig,0x0028,0x0006);
         
-        // TODO : Drop Palette Color out of the Header? 
+        /// \todo Drop Palette Color out of the Header? 
    return lgrTotale; 
 }
 
 /**
  * \ingroup   gdcmFile
- * \brief TODO JPR
- * \warning doit-etre etre publique ?  
- * \toto : y a-t-il un inconvenient à fusioner ces 2 fonctions
- *
- * @param inData 
- * @param ExpectedSize 
+ * \brief performs a shadow copy (not a deep copy) of the user given
+ *        pixel area.
+ *        'image' Pixels are presented as C-like 2D arrays : line per line.
+ *        'volume'Pixels are presented as C-like 3D arrays : lane per plane 
+ * \warning user is kindly requested NOT TO 'free' the Pixel area
+ * @param inData user supplied pixel area
+ * @param ExpectedSize total image size, in Bytes
  *
  * @return boolean     
  */
@@ -581,7 +614,8 @@ bool gdcmFile::WriteRawData (std::string fileName) {
 
 /**
  * \ingroup   gdcmFile
- * \brief Writes on disk A SINGLE Dicom file
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Implicit Value Representation convention
  *        NO test is performed on  processor "Endiannity".
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
@@ -594,8 +628,9 @@ bool gdcmFile::WriteDcmImplVR (std::string fileName) {
 
 /**
  * \ingroup   gdcmFile
- * \brief  
- * @param fileName name of the file to be created
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Implicit Value Representation convention
+ *        NO test is performed on  processor "Endiannity". * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails        
  */
@@ -606,8 +641,9 @@ bool gdcmFile::WriteDcmImplVR (const char* fileName) {
        
 /**
  * \ingroup   gdcmFile
- * \brief  
- * @param fileName name of the file to be created
+* \brief Writes on disk A SINGLE Dicom file, 
+ *        using the Explicit Value Representation convention
+ *        NO test is performed on  processor "Endiannity". * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails        
  */
@@ -618,15 +654,14 @@ bool gdcmFile::WriteDcmExplVR (std::string fileName) {
        
 /**
  * \ingroup   gdcmFile
- * \brief  Ecrit au format ACR-NEMA sur disque l'entete et les pixels
+ * \brief Writes on disk A SINGLE Dicom file, 
+ *        using the ACR-NEMA convention
+ *        NO test is performed on  processor "Endiannity".
  *        (a l'attention des logiciels cliniques 
  *        qui ne prennent en entrée QUE des images ACR ...
  * \warning if a DICOM_V3 header is supplied,
- *         groups < 0x0008 and shadow groups are ignored)
+ *         groups < 0x0008 and shadow groups are ignored
  * \warning NO TEST is performed on processor "Endiannity".
- *        Ca fonctionnera correctement (?) sur processeur Intel
- *        (Equivalent a IdDcmWrite) 
- *
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @return false if write fails                
@@ -640,7 +675,8 @@ bool gdcmFile::WriteAcr (std::string fileName) {
 // Protected
 /**
  * \ingroup   gdcmFile
- *
+ * \brief NOT a end user inteded function
+ *        (used by WriteDcmExplVR, WriteDcmImplVR, WriteAcr, etc)
  * @param fileName name of the file to be created
  *                 (any already existing file is overwritten)
  * @param  type file type (ExplicitVR, ImplicitVR, ...)
@@ -650,9 +686,7 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
 
    FILE * fp1;
    
-   if (PixelRead==-1 && type != DICOMDIR) {
-      std::cout << "U never Read the pixels; U cannot write the file" 
-                << std::endl;
+   if (PixelRead==-1 && type != ExplicitVR) {
       return false;               
    }
 
@@ -665,10 +699,10 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
    if ( (type == ImplicitVR) || (type == ExplicitVR) ) {
       char * filePreamble;
       // writing Dicom File Preamble
-      filePreamble=(char*)calloc(128,1);
+      filePreamble=new char[128];
       fwrite(filePreamble,128,1,fp1);
       fwrite("DICM",4,1,fp1);
-      free (filePreamble);
+      delete[] filePreamble;
    }
 
    // --------------------------------------------------------------
@@ -678,8 +712,8 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
    // we reproduce on disk the switch between lineNumber and columnNumber
    // just before writting ...
    
-   // TODO : the best trick would be *change* the recognition code
-   //        but pb expected if user deals with, e.g. COMPLEX images
+   /// \todo the best trick would be *change* the recognition code
+   ///       but pb expected if user deals with, e.g. COMPLEX images
 
    std::string rows, columns; 
    if ( Header->GetFileType() == ACR_LIBIDO){
@@ -690,7 +724,7 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
    }   
    // ----------------- End of Special Patch ----------------
    
-   // TODO : get the grPixel, numPixel values (for some ACR-NEMA images only)
+   /// \todo get the grPixel, numPixel values (for some ACR-NEMA images only)
    
    guint16 grPixel =Header->GetGrPixel();
    guint16 numPixel=Header->GetNumPixel();;
@@ -720,7 +754,6 @@ bool gdcmFile::WriteBase (std::string fileName, FileType type) {
    
    //PixelElement->SetPrintLevel(2);
    //PixelElement->Print();    
    Header->Write(fp1, type);
 
    // --------------------------------------------------------------
@@ -768,9 +801,10 @@ if(nb == 16)
       case 2143:
       case 4321:
 
-         for(i=0;i<lgr;i++)
+         for(i=0;i<lgr/2;i++) {
             ((unsigned short int*)im)[i]= ((((unsigned short int*)im)[i])>>8)
                                         | ((((unsigned short int*)im)[i])<<8);
+       }
          break;
                        
       default:
@@ -784,7 +818,7 @@ if( nb == 32 )
          break;
 
       case 4321:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 4321 */
             fort  =((unsigned long int*)im)[i]>>16;
             fort=  (fort>>8)   | (fort<<8);
@@ -795,7 +829,7 @@ if( nb == 32 )
          break;
 
       case 2143:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 2143 */
             fort=((unsigned long int*)im)[i]>>16;
             fort=  (fort>>8)   | (fort<<8);
@@ -806,7 +840,7 @@ if( nb == 32 )
          break;
   
       case 3412:
-         for(i=0;i<lgr;i++) {
+         for(i=0;i<lgr/4;i++) {
             faible=  ((unsigned long int*)im)[i]&0x0000ffff;    /* 3412 */
             fort=((unsigned long int*)im)[i]>>16;                  
             s32=faible; 
@@ -925,7 +959,7 @@ bool gdcmFile::ReadPixelData(void* destination) {
       
    if (ln != 0) {
       // What is it used for ?!?
-      char *BasicOffsetTableItemValue = (char *)malloc(ln+1);        
+      char *BasicOffsetTableItemValue = new char[ln+1];
       fread(BasicOffsetTableItemValue,ln,1,fp); 
    }