]> Creatis software - gdcm.git/blobdiff - src/gdcmDataEntry.cxx
add
[gdcm.git] / src / gdcmDataEntry.cxx
index ffe35271227937e25b63bbd54809c626217ad0ec..fc36ec5666dcf64eeb30580d350c382d17e81519 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDataEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2006/04/14 08:10:02 $
-  Version:   $Revision: 1.37 $
+  Date:      $Date: 2009/02/05 09:50:09 $
+  Version:   $Revision: 1.55 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 #include <fstream>
 
 #if defined(__BORLANDC__)
- #include <mem.h> // for memcpy
+ #include <mem.h>    // for memcpy
  #include <stdlib.h> // for atof
- #include <ctype.h> // for isdigit
+ #include <ctype.h>  // for isdigit
 #endif
+#include <string.h> // memcpy
+#include <stdlib.h> // atof
 
-namespace gdcm 
+// Could be defined like MAX_SIZE_LOAD_ELEMENT_VALUE
+#define GDCM_MAX_LENGTH_TO_CONVERT_TO_HEXA 8
+
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 #define MAX_SIZE_PRINT_ELEMENT_VALUE 0x7fffffff
@@ -40,8 +45,10 @@ uint32_t DataEntry::MaxSizePrintEntry = MAX_SIZE_PRINT_ELEMENT_VALUE;
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \brief   Constructor for a given DictEntry
- * @param   e Pointer to existing dictionary entry
+ * \brief   Constructor for a given DataEntry
+ * @param   group group number of the Data Entry to be created
+ * @param   elem element number of the Data Entry to be created
+ * @param   vr Value Representation of the Data Entry to be created 
  */
 DataEntry::DataEntry(uint16_t group,uint16_t elem,
                                      VRKey const &vr) 
@@ -50,8 +57,10 @@ DataEntry::DataEntry(uint16_t group,uint16_t elem,
    State = STATE_LOADED;
    Flag = FLAG_NONE;
 
-   BinArea = 0;
-   SelfArea = true;
+   StrArea     = 0;
+   StrHexaArea = 0;   
+   BinArea     = 0;
+   SelfArea    = true;
 }
 
 /**
@@ -64,6 +73,7 @@ DataEntry::DataEntry(DocEntry *e)
 {
    Flag = FLAG_NONE;
    BinArea = 0;
+   
    SelfArea = true;
 
    Copy(e);
@@ -75,17 +85,18 @@ DataEntry::DataEntry(DocEntry *e)
 DataEntry::~DataEntry ()
 {
    DeleteBinArea();
+   
 }
 
-//-----------------------------------------------------------------------------
-// Print
-
 //-----------------------------------------------------------------------------
 // Public
 /**
  * \brief Sets the value (non string) of the current DataEntry
  * @param area area
- * @param self self
+ * @param self self=true : The area : *belongs" to the DataEntry 
+ *                                  : will be delete with the DataEntry
+ *             self=false  The area *is not* deleted with the DataEntry
+ *              
  */
 void DataEntry::SetBinArea( uint8_t *area, bool self )  
 { 
@@ -113,12 +124,105 @@ void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )
       NewBinArea();
       memcpy(BinArea,area,length);
       if( length!=lgh )
-         BinArea[length]=0;
+         BinArea[length]=0; // padd with zero
 
       State = STATE_LOADED;
    }
 }
 
+/**
+ * \brief Checks wether the current DataEntry contains number(s)
+ */
+
+bool DataEntry::IsNumerical()
+{
+   const VRKey &vr = GetVR();
+   
+   return 
+          vr == "DS" ||
+          vr == "FL" ||
+          vr == "FD" ||
+          vr == "IS" || 
+          vr == "SH" ||
+          vr == "SL" ||
+          vr == "SS" ||
+          vr == "UI" ||
+          vr == "UL" ||
+          vr == "US" ;      
+}
+
+/**
+ * \brief Gets a std::vector of 'double' holding the value(s) of any 'numerical' DataEntry
+ * @param valueVector std::vector double of value(s)
+ * \return false if VR not "a 'numerical" one
+ */
+ bool DataEntry::GetNumerical(std::vector <double> &valueVector)
+ {
+    valueVector.clear();
+    
+    if (!IsNumerical()) // never trust a user !
+       return false;    
+
+    const VRKey &vr = GetVR();
+    int loop;
+    if (vr == "IS" || vr == "DS")
+    {
+       /// \todo rewrite the whole method, in order *not to use* std::string !
+       std::vector<std::string> tokens;
+           
+       Util::Tokenize ( GetString().c_str(), tokens, "\\" );
+        
+       int nbValues= tokens.size();
+       if (nbValues == 0)
+          return false;
+
+       if (vr == "DS")        
+          for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(atof(tokens[loop].c_str()));
+       else
+          for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(atoi(tokens[loop].c_str()));
+               
+       return true;     
+    }    
+    
+    uint32_t nbValues = GetValueCount();
+    if (nbValues == 0)
+       return false;
+       
+    if( vr == "US") {
+       for (loop=0; loop<nbValues; loop++)
+             valueVector.push_back(((uint16_t *)BinArea)[loop]);  
+       return true;
+    }
+    if( vr == "SS" ) {
+       for (loop=0; loop<nbValues; loop++)
+             valueVector.push_back(((int16_t *)BinArea)[loop]);  
+       return true;
+    }
+    if( vr == "UL") {
+       for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(((uint32_t *)BinArea)[loop]);      
+       return true;
+    }
+    if(vr == "SL" ) {
+       for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(((int32_t *)BinArea)[loop]);      
+       return true;
+    }       
+    if( vr == "FL" ) {
+       for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(((float *)BinArea)[loop]);     
+       return true;
+    }
+    if( vr == "FD" ) {
+       for (loop=0; loop<nbValues; loop++) 
+             valueVector.push_back(((double *)BinArea)[loop]);
+       return true;
+    }     
+    return false;   // ?!? 
+ }
+
 /**
  * \brief Inserts the elementary (non string) value into the current DataEntry
  * @param id index of the elementary value to be set
@@ -132,7 +236,7 @@ void DataEntry::SetValue(const uint32_t &id, const double &val)
 
    if( id > GetValueCount() )
    {
-      gdcmErrorMacro("Index (" << id << ")is greater than the data size");
+      gdcmErrorMacro("Index (" << id << ") is greater than the data size");
       return;
    }
 
@@ -167,7 +271,7 @@ void DataEntry::SetValue(const uint32_t &id, const double &val)
    }
 }
 /**
- * \brief returns, as a double (?!?) one of the values 
+ * \brief returns, as a double one of the values 
  *      (when entry is multivaluated), identified by its index.
  *      Returns 0.0 if index is wrong
  * @param id id
@@ -191,13 +295,11 @@ double DataEntry::GetValue(const uint32_t &id) const
       return 0.0;
    }
 
-   /// \todo FIX the API : user *knows* that entry contains a US
-   ///               and he receives a double ?!?
+   // if user *knows* that entry contains a US, 
+   // he just has to cast the double he receives
    
    const VRKey &vr = GetVR();
-   /// \todo FIX the API : user *knows* that entry contains a US,
-   ///       the method is supposed to return a double
-   ///       but sends a US ?!? 
+
    if( vr == "US" || vr == "SS" )
       return ((uint16_t *)BinArea)[id];
    else if( vr == "UL" || vr == "SL" )
@@ -333,8 +435,8 @@ uint32_t DataEntry::GetValueCount( ) const
 }
 
 /**
- * \brief Gets a std::vector <double> holding the value(s) of a DS DataEntry
- * @param valueVector std::vector <double> of value(s)
+ * \brief Gets a std::vector of 'double' holding the value(s) of a DS DataEntry
+ * @param valueVector std::vector double of value(s)
  * \return false if VR not "DS" or DataEntry empty
  */
  bool DataEntry::GetDSValue(std::vector <double> &valueVector)
@@ -364,7 +466,6 @@ uint32_t DataEntry::GetValueCount( ) const
 void DataEntry::SetString(std::string const &value)
 {
    DeleteBinArea();
-
    const VRKey &vr = GetVR();
    if ( vr == "US" || vr == "SS" )
    {
@@ -415,16 +516,18 @@ void DataEntry::SetString(std::string const &value)
       tokens.clear();
    }
    else
-   {
-      //if( value.size() > 0 )  // when user sets a string to 0, *do* the job.
-      {
-         size_t l =  value.size();    
-         SetLength(l + l%2);
-         NewBinArea();
-         memcpy(BinArea, value.c_str(), l);
-         if (l%2)
-            BinArea[l] = '\0';
-      }      
+   {      
+      size_t l =  value.size();    
+      SetLength(l + l%2);
+      NewBinArea();
+      memcpy(BinArea, value.c_str(), l);
+      if (l%2) // padded with blank except for UI
+        {
+        if ( vr == "UI" )
+          BinArea[l] = '\0';
+        else
+          BinArea[l] = ' ';
+        }
    }
    State = STATE_LOADED;
 }
@@ -436,11 +539,15 @@ std::string const &DataEntry::GetString() const
   static std::ostringstream s;
   const VRKey &vr = GetVR();
   s.str("");
-  StrArea="";
+  
+  if (!StrArea)
+     StrArea = new std::string();
+  else 
+     *StrArea="";
 
   if( !BinArea )
-     return StrArea;
-      // When short integer(s) are stored, convert the following (n * 2) characters
+     return *StrArea;
+  // When short integer(s) are stored, convert the following (n * 2) characters
   // as a displayable string, the values being separated by a back-slash
   if( vr == "US" )
   {
@@ -451,7 +558,7 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
+     *StrArea=s.str();
   }
   else if (vr == "SS" )
   {
@@ -462,7 +569,7 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
+     *StrArea=s.str();
   }      // See above comment on multiple short integers (mutatis mutandis).
   else if( vr == "UL" )
   {
@@ -473,7 +580,7 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
+     *StrArea=s.str();
   }
   else if( vr == "SL" )
   {
@@ -484,8 +591,9 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
-  }    else if( vr == "FL" )
+     *StrArea=s.str();
+  }     // See above comment on multiple short integers (mutatis mutandis).
+  else if( vr == "FL" )
   {
      float *data=(float *)BinArea;
      for (unsigned int i=0; i < GetValueCount(); i++)
@@ -494,8 +602,8 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
-  }
+     *StrArea=s.str();
+  }     // See above comment on multiple short integers (mutatis mutandis).
   else if( vr == "FD" )
   {
      double *data=(double *)BinArea;
@@ -505,22 +613,145 @@ std::string const &DataEntry::GetString() const
            s << '\\';
         s << data[i];
      }
-     StrArea=s.str();
+     *StrArea=s.str();
   }
   else
   {
-     StrArea.append((const char *)BinArea,GetLength());
+     StrArea->append((const char *)BinArea,GetLength());
      // to avoid gdcm to propagate oddities in lengthes
      if ( GetLength()%2)
-        StrArea.append(" ",1);   }
-  return StrArea;
+        StrArea->append(" ",1);
+   }
+  return *StrArea;
 }
 
+/**
+ * \brief   returns an hexadecimal representation of the DataEntry value
+ */
+std::string const &DataEntry::GetHexaRepresentation() const
+{ 
+  static std::ostringstream s2;
+  const VRKey &vr = GetVR();
+   
+  s2.str("");
+  if (!StrHexaArea)
+     StrHexaArea = new std::string();
+  else 
+     *StrHexaArea="";
+  if( !BinArea )
+     return *StrHexaArea;
+  // When short integer(s) are stored, convert the following (n * 2) characters
+  // as a displayable string, the values being separated by a back-slash
+  
+  s2 << std::hex;
+  
+  if( vr == "US" )
+  {
+     uint16_t *data=(uint16_t *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+        s2  << std::setw( 2 ) << std::setfill( '0' );     
+        if( i!=0 )
+           s2 << '\\';
+        s2 << data[i];
+     }
+     *StrHexaArea=s2.str();
+  }
+  else if (vr == "SS" )
+  {
+     int16_t *data=(int16_t *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+        s2  << std::setw( 4 ) << std::setfill( '0' );
+        if( i!=0 )
+           s2 << '\\';
+        s2  << data[i];
+     }
+     *StrHexaArea=s2.str();
+  }      // See above comment on multiple short integers (mutatis mutandis).
+  else if( vr == "UL" )
+  {
+     uint32_t *data=(uint32_t *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+        s2  << std::setw( 4 ) << std::setfill( '0' );
+        if( i!=0 ) 
+           s2  << '\\';
+        s2 << data[i];
+     }
+     *StrHexaArea=s2.str();
+  }
+  else if( vr == "SL" )
+  {
+     int32_t *data=(int32_t *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+        s2  << std::setw( 4 ) << std::setfill( '0' );
+         if( i!=0 )
+           s2  << '\\';
+        s2 << data[i];
+     }
+     *StrHexaArea=s2.str();
+  }
+  else if( vr == "FL" )
+  {
+     unsigned char *toto=(unsigned char *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+         s2.str("");
+         if( i!=0 )
+           s2 << '\\';
+         unsigned int a4;
+         for(int iif=0; iif<4; iif++)
+         {
+            a4=toto[iif];
+            s2 << a4; 
+         }
+     }
+     *StrHexaArea=s2.str();
+  }
+  else if( vr == "FD" )
+  {
+     //double *data=(double *)BinArea;
+     unsigned char *toto=(unsigned char *)BinArea;
+     for (unsigned int i=0; i < GetValueCount(); i++)
+     {
+        s2.str("");
+        if( i!=0 )
+           s2 << '\\';
+        //s2 << data[i];
+
+         unsigned int a4;
+         for(int iid=0; iid<8; iid++)
+         {
+            a4=toto[iid];
+            s2 << a4; 
+         }
+
+     }
+     *StrHexaArea=s2.str();
+  }
+  else
+  {
+     unsigned int l = (Length > GDCM_MAX_LENGTH_TO_CONVERT_TO_HEXA) ? GDCM_MAX_LENGTH_TO_CONVERT_TO_HEXA : Length;
+     uint8_t *data=(uint8_t *)BinArea;
+     for (unsigned int i=0; i < l; i++)
+     {
+        if( i!=0 )
+           s2 << '\\';
+        s2 << std::setw( 2 ) << (int)(data[i]);
+     }
+     if (Length > 16)
+        s2 << "\\...";
+     *StrHexaArea=s2.str();
+   }
+  return *StrHexaArea;
+}
 
 /**
  * \brief Copies all the attributes from an other DocEntry 
  * @param doc entry to copy from
- * @remarks The content BinArea is copied too
+ * @remarks The content BinArea is copied too (StrArea is not)
  */
 void DataEntry::Copy(DocEntry *doc)
 {
@@ -531,18 +762,20 @@ void DataEntry::Copy(DocEntry *doc)
    {
       State = entry->State;
       Flag = entry->Flag;
-      CopyBinArea(entry->BinArea,entry->GetLength());
+      CopyBinArea(entry->BinArea,entry->GetLength());      
    }
 }
 
 /**
- * \brief   Writes the 'value' area of a DataEntry
+ * \brief   Writes the 'common part' + the 'value' area of a DataEntry
  * @param fp already open ofstream pointer
  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  */
-void DataEntry::WriteContent(std::ofstream *fp, FileType filetype)
+void DataEntry::WriteContent(std::ofstream *fp, FileType filetype, 
+                                                      bool insideMetaElements, bool insideSequence)
 { 
-   DocEntry::WriteContent(fp, filetype);
+   // writes the 'common part'
+   DocEntry::WriteContent(fp, filetype, insideMetaElements, insideSequence);
 
    if ( GetGroup() == 0xfffe )
    {
@@ -643,7 +876,9 @@ uint32_t DataEntry::ComputeFullLength()
 
 //-----------------------------------------------------------------------------
 // Protected
-/// \brief Creates a DataEntry owned BinArea (remove previous one if any)
+
+/// \brief Creates a DataEntry owned BinArea 
+///       (remove previous one if any and relevant StrArea if any)
 void DataEntry::NewBinArea( )
 {
    DeleteBinArea();
@@ -651,7 +886,8 @@ void DataEntry::NewBinArea( )
       BinArea = new uint8_t[GetLength()];
    SelfArea = true;
 }
-/// \brief Removes the BinArea, if owned by the DataEntry
+/// \brief Removes the BinArea, if owned by the DataEntry, 
+///        and the relevant StrArea if any
 void DataEntry::DeleteBinArea(void)
 {
    if (BinArea && SelfArea)
@@ -659,6 +895,16 @@ void DataEntry::DeleteBinArea(void)
       delete[] BinArea;
       BinArea = NULL;
    }
+   if (StrArea)
+   {
+      delete StrArea;
+      StrArea = 0;
+   }
+   if (StrHexaArea)
+   {
+      delete StrHexaArea;
+      StrHexaArea = 0;
+   }   
 }
 
 //-----------------------------------------------------------------------------
@@ -673,7 +919,9 @@ void DataEntry::DeleteBinArea(void)
  */
 void DataEntry::Print(std::ostream &os, std::string const & )
 {
-   os << "D ";
+   //os << "D ";
+   
+   // First, Print the common part (vr [length offset] name).
    DocEntry::Print(os);
 
    uint16_t g = GetGroup();
@@ -692,7 +940,7 @@ void DataEntry::Print(std::ostream &os, std::string const & )
 
       if( vr == "US" || vr == "SS" || vr == "UL" || vr == "SL" 
        || vr == "FL" || vr == "FD")
-         s << " [" << GetString() << "]";
+         s << " [" << GetString() << "] =0x(" << GetHexaRepresentation() << ")";
       else
       { 
          if(Global::GetVR()->IsVROfStringRepresentable(vr))
@@ -711,7 +959,7 @@ void DataEntry::Print(std::ostream &os, std::string const & )
             }
             else
             {
-               s << " [gdcm::too long for print (" << cleanString.length() << ") ]";
+               s << " [GDCM_NAME_SPACE::too long for print (" << cleanString.length() << ") ]";
             }
          }
          else
@@ -731,7 +979,7 @@ void DataEntry::Print(std::ostream &os, std::string const & )
             else
             {
                s << " [" << GDCM_BINLOADED << ";"
-               << "length = " << GetLength() << "]";
+               << "length = " << GetLength() << "] =0x(" << GetHexaRepresentation() << ")";      
             }
          }
       }