]> Creatis software - gdcm.git/blobdiff - src/gdcmDataEntry.cxx
Minor typo fixes
[gdcm.git] / src / gdcmDataEntry.cxx
index 6c7a11b813f1900a2b16857dfbc783e9bdaa9eb4..e318600b245f02cd530f2854b4c410b92189823d 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDataEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 07:23:50 $
-  Version:   $Revision: 1.4 $
+  Date:      $Date: 2005/12/09 12:23:38 $
+  Version:   $Revision: 1.25 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -54,7 +54,7 @@ DataEntry::DataEntry(DictEntry *e)
 DataEntry::DataEntry(DocEntry *e)
             : DocEntry(e->GetDictEntry())
 {
-   Flag = 0;
+   Flag = FLAG_NONE;
    BinArea = 0;
    SelfArea = true;
 
@@ -76,6 +76,8 @@ DataEntry::~DataEntry ()
 // Public
 /**
  * \brief Sets the value (non string) of the current Dicom Header Entry
+ * @param area area
+ * @param self self
  */
 void DataEntry::SetBinArea( uint8_t *area, bool self )  
 { 
@@ -86,7 +88,11 @@ void DataEntry::SetBinArea( uint8_t *area, bool self )
 
    State = STATE_LOADED;
 }
-
+/**
+ * \brief Inserts the value (non string) into the current Dicom Header Entry
+ * @param area area
+ * @param length length 
+ */
 void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )
 {
    DeleteBinArea();
@@ -105,7 +111,12 @@ void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )
    }
 }
 
-void DataEntry::SetValue(const uint32_t &id,const double &val)
+/**
+ * \brief Inserts the value (non string) into the current Dicom Header Entry
+ * @param id id
+ * @param val val 
+ */
+void DataEntry::SetValue(const uint32_t &id, const double &val)
 {
    if( !BinArea )
       NewBinArea();
@@ -147,22 +158,31 @@ void DataEntry::SetValue(const uint32_t &id,const double &val)
       BinArea[id] = (uint8_t)val;
    }
 }
-
+/**
+ * \brief returns, as a double (?!?) one of the values 
+ *      (when entry is multivaluated), identified by its index.
+ *      Returns 0.0 if index is wrong
+ *     FIXME : warn the user there was a problem ! 
+ * @param id id
+ */
 double DataEntry::GetValue(const uint32_t &id) const
 {
    if( !BinArea )
    {
       gdcmErrorMacro("BinArea not set. Can't get the value");
-      return 0;
+      return 0.0;
    }
 
    uint32_t count = GetValueCount();
    if( id > count )
    {
       gdcmErrorMacro("Index (" << id << ")is greater than the data size");
-      return 0;
+      return 0.0;
    }
 
+   // FIX the API : user *knows* that entry contains a US
+   //               and he receives a double ?!?
+   
    const VRKey &vr = GetVR();
    if( vr == "US" || vr == "SS" )
       return ((uint16_t *)BinArea)[id];
@@ -177,7 +197,7 @@ double DataEntry::GetValue(const uint32_t &id) const
       if( GetLength() )
       {
          // Don't use std::string to accelerate processing
-         double val = 0.0;
+         double val;
          char *tmp = new char[GetLength()+1];
          memcpy(tmp,BinArea,GetLength());
          tmp[GetLength()]=0;
@@ -219,19 +239,72 @@ double DataEntry::GetValue(const uint32_t &id) const
       return BinArea[id];
 }
 
-uint32_t DataEntry::GetValueCount(void) const
+/**
+ * \brief Checks if the multiplicity of the value follows Dictionary VM
+ */
+bool DataEntry::IsValueCountValid() const
+{
+  uint32_t vm;
+  const std::string &strVM = GetVM();
+  uint32_t vc = GetValueCount();
+  bool valid = vc == 0;
+  if( valid )
+    return true;
+  
+  // FIXME : what shall we do with VM = "2-n", "3-n", etc
+  
+  if( strVM == "1-n" )
+  {
+    // make sure there is at least one ??? FIXME
+    valid = vc >= 1;
+  }
+  else
+  {
+    std::istringstream os;
+    os.str( strVM );
+    os >> vm;
+    // Two cases:
+    // vm respects the one from the dict
+    // vm is 0 (we need to check if this element is allowed to be empty) FIXME
+
+    // note  (JPR)
+    // ----    
+    // Entries whose type is 1 are mandatory, with a mandatory value.
+    // Entries whose type is 1c are mandatory-inside-a-Sequence,
+    //                          with a mandatory value.
+    // Entries whose type is 2 are mandatory, with an optional value.
+    // Entries whose type is 2c are mandatory-inside-a-Sequence,
+    //                          with an optional value.
+    // Entries whose type is 3 are optional.
+
+    // case vc == 0 is only applicable for 'type 2' entries.
+    // Problem : entry type may depend on the modality and/or the Sequence
+    //           it's embedded in !
+    //          (Get the information in the 'Conformance Statements' ...)  
+    valid = vc == vm;
+  }
+  return valid;
+}
+
+/**
+ * \brief returns the number of elementary values
+ */ 
+uint32_t DataEntry::GetValueCount( ) const
 {
    const VRKey &vr = GetVR();
    if( vr == "US" || vr == "SS" )
       return GetLength()/sizeof(uint16_t);
    else if( vr == "UL" || vr == "SL" )
       return GetLength()/sizeof(uint32_t);
-   else if( vr == "FL" )
-      return GetLength()/sizeof(float);
+   else if( vr == "FL" || vr == "OF" )
+      return GetLength()/4 ; // FL has a *4* length! sizeof(float);
    else if( vr == "FD" )
-      return GetLength()/sizeof(double);
+      return GetLength()/8;  // FD has a *8* length! sizeof(double);
    else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
    {
+      // Some element in DICOM are allowed to be empty
+      if( !GetLength() ) 
+         return 0;
       // Don't use std::string to accelerate processing
       uint32_t count = 1;
       for(uint32_t i=0;i<GetLength();i++)
@@ -241,10 +314,12 @@ uint32_t DataEntry::GetValueCount(void) const
       }
       return count;
    }
-   else
-      return GetLength();
+   return GetLength();
 }
-
+/**
+ * \brief Sets the 'value' of an Entry, passed as a std::string
+ * @param value string representation of the value to be set
+ */ 
 void DataEntry::SetString(std::string const &value)
 {
    DeleteBinArea();
@@ -302,16 +377,19 @@ void DataEntry::SetString(std::string const &value)
    {
       if( value.size() > 0 )
       {
-         std::string finalVal = Util::DicomString( value.c_str() );
-         SetLength(finalVal.size());
+         size_t l =  value.size();    
+         SetLength(l + l%2);
          NewBinArea();
-
-         memcpy(BinArea, &(finalVal[0]), finalVal.size());
+         memcpy(BinArea, value.c_str(), l);
+         if (l%2)
+            BinArea[l] = '\0';
       }
    }
    State = STATE_LOADED;
 }
-
+/**
+ * \brief   returns as a string (when possible) the value of the DataEntry
+ */
 std::string const &DataEntry::GetString() const
 {
    static std::ostringstream s;
@@ -322,6 +400,9 @@ std::string const &DataEntry::GetString() const
 
    if( !BinArea )
       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" || vr == "SS" )
    {
@@ -335,7 +416,7 @@ std::string const &DataEntry::GetString() const
       }
       StrArea=s.str();
    }
-   // See above comment on multiple integers (mutatis mutandis).
+   // See above comment on multiple short integers (mutatis mutandis).
    else if( vr == "UL" || vr == "SL" )
    {
       uint32_t *data=(uint32_t *)BinArea;
@@ -373,11 +454,20 @@ std::string const &DataEntry::GetString() const
       StrArea=s.str();
    }
    else
+   {
       StrArea.append((const char *)BinArea,GetLength());
-
+      // to avoid gdcm propagate oddities in lengthes
+      if ( GetLength()%2)
+         StrArea.append(" ",1);  
+   }
    return StrArea;
 }
 
+/**
+ * \brief Copies all the attributes from an other DocEntry 
+ * @param doc entry to copy from
+ * @remarks The content BinArea is copied too
+ */
 void DataEntry::Copy(DocEntry *doc)
 {
    DocEntry::Copy(doc);
@@ -391,6 +481,11 @@ void DataEntry::Copy(DocEntry *doc)
    }
 }
 
+/**
+ * \brief   Writes 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)
 { 
    DocEntry::WriteContent(fp, filetype);
@@ -399,61 +494,71 @@ void DataEntry::WriteContent(std::ofstream *fp, FileType filetype)
    {
       return; //delimitors have NO value
    }
-
-   uint8_t *binArea8 = BinArea; //safe notation
-   size_t lgr = GetLength();
-   if (BinArea) // the binArea was *actually* loaded
-   {
-
-   //  The same operation should be done if we wanted 
-   //  to write image with Big Endian Transfer Syntax, 
-   //  while working on Little Endian Processor
+   
+   // --> We only deal with Little Endian writting
    // --> forget Big Endian Transfer Syntax writting!
    //     Next DICOM version will give it up ...
-
-   // --> FIXME 
-   //    The stuff looks nice, but it's probably bugged,
-   //    since troubles occur on big endian processors (SunSparc, Motorola)
-   //    while reading the pixels of a 
-   //    gdcm-written Little-Endian 16 bits per pixel image
-
+   // WARNING - For Implicit VR private element,
+   //           we have *no choice* but considering them as
+   //           something like 'OB' values.
+   //           we rewrite them as we found them on disc.
+   //           Some trouble will occur if element was 
+   //           *actually* OW, if image was produced 
+   //           on Big endian based processor, read and writen 
+   //           on Little endian based processor
+   //           and, later on, somebody needs
+   //           this 'OW' Implicit VR private element (?!?)
+   //           (Same stuff, mutatis mutandis, for Little/Big)
+   // 8/16 bits Pixels problem should be solved automatiquely,
+   // since we ensure the VR (OB vs OW) is conform to Pixel size.
+        
+   uint8_t *data = BinArea; //safe notation
+   size_t l = GetLength(); 
+   gdcmDebugMacro ("in DataEntry::WriteContent " << GetKey() 
+             << " : " << Global::GetVR()->GetAtomicElementLength(this->GetVR())
+             );
+   if (BinArea) // the binArea was *actually* loaded
+   {
 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
-
-      /// \todo FIXME : Right now, we only care of Pixels element
-      ///       we should deal with *all* the BinEntries
-      ///       Well, not really since we are not interpreting values read...
-
-      // 8 Bits Pixels *are* OB, 16 Bits Pixels *are* OW
-      // -value forced while Reading process-
-      
-      // -->  WARNING
-      // -->        the following lines *looked* very clever, 
-      // -->        but they don't work on big endian processors.
-      // -->        since I've no access for the moment to a big endian proc :-(
-      // -->        I comment them out, to see the result on the dash board 
-      // -->     
-      
-      // --> Revert to initial code : TestWriteSimple hangs on Darwin :-(     
-      if (GetGroup() == 0x7fe0 && GetVR() == "OW")
-      {  
-         uint16_t *binArea16 = (uint16_t*)binArea8;
-         binary_write (*fp, binArea16, lgr );
-      }
-      else
-      { 
-         // For any other VR, DataEntry is re-written as-is
-         binary_write (*fp, binArea8, lgr );
+      unsigned short vrLgth = 
+                        Global::GetVR()->GetAtomicElementLength(this->GetVR());
+      unsigned int i;
+      switch(vrLgth)
+      {
+         case 1:
+         {
+            binary_write (*fp, data, l );           
+            break;
+         }     
+         case 2:
+         {
+gdcmDebugMacro ("AtomicLength = 2 found; lgt =" << l); 
+            uint16_t *data16 = (uint16_t *)data;
+            for(i=0;i<l/vrLgth;i++)
+               binary_write( *fp, data16[i]);
+            break;
+         }
+         case 4:
+         {
+            uint32_t *data32 = (uint32_t *)data;
+            for(i=0;i<l/vrLgth;i++)
+               binary_write( *fp, data32[i]);
+            break;
+         }
+         case 8:
+         {
+            double *data64 = (double *)data;
+            for(i=0;i<l/vrLgth;i++)
+               binary_write( *fp, data64[i]);
+            break;
+         }
       }
-
-      // -->  WARNING      
-      // -->         remove the following line, an uncomment the previous ones, 
-      // -->         if it doesn't work better
-      // -->     
-      /*binary_write ( *fp, binArea8, lgr ); // Elem value*/
-      
 #else
-      binary_write ( *fp, binArea8, lgr ); // Elem value
+   binary_write (*fp, data, l );
 #endif //GDCM_WORDS_BIGENDIAN
+
    }
    else
    {
@@ -463,20 +568,34 @@ void DataEntry::WriteContent(std::ofstream *fp, FileType filetype)
       //  --> the initial data (on the the source image) is lost
       //  --> user is *not* informed !
       
-      fp->seekp(lgr, std::ios::cur);
+      fp->seekp(l, std::ios::cur);
    }
+   // to avoid gdcm to propagate oddities
+   // (length was already modified)  
+   if (l%2)
+      fp->seekp(1, std::ios::cur);  
+}
+
+/**
+ * \brief   Compute the full length of the elementary DataEntry (not only value
+ *          length) depending on the VR.
+ */
+uint32_t DataEntry::ComputeFullLength()
+{
+   return GetFullLength();
 }
 
 //-----------------------------------------------------------------------------
 // Protected
-void DataEntry::NewBinArea(void)
+/// \brief Creates a DataEntry owned BinArea (remove previous one if any)
+void DataEntry::NewBinArea( )
 {
    DeleteBinArea();
    if( GetLength() > 0 )
       BinArea = new uint8_t[GetLength()];
    SelfArea = true;
 }
-
+/// \brief Removes the BinArea, if owned by the DataEntry
 void DataEntry::DeleteBinArea(void)
 {
    if (BinArea && SelfArea)
@@ -527,10 +646,15 @@ void DataEntry::Print(std::ostream &os, std::string const & )
       { 
          if(Global::GetVR()->IsVROfStringRepresentable(vr))
          {
-            std::string cleanString = Util::CreateCleanString(v);  // replace non printable characters by '.'
+            // replace non printable characters by '.'
+            std::string cleanString = Util::CreateCleanString(v);
             if ( cleanString.length() <= GetMaxSizePrintEntry()
-            || PrintLevel >= 3
-            || IsNotLoaded() )
+              || PrintLevel >= 3
+              || IsNotLoaded() )
+           // FIXME : when IsNotLoaded(), you create a Clean String ?!?
+           // FIXME : PrintLevel<2 *does* print the values 
+           //        (3 is only for extra offsets printing)
+           // What do you wanted to do ? JPR
             {
                s << " [" << cleanString << "]";
             }
@@ -541,8 +665,14 @@ void DataEntry::Print(std::ostream &os, std::string const & )
          }
          else
          {
-            if ( Util::IsCleanArea( GetBinArea(),GetLength()  ) )
+            // A lot of Private elements (with no VR) contain actually 
+            // only printable characters;
+            // Let's deal with them as is they were VR std::string representable
+    
+            if ( Util::IsCleanArea( GetBinArea(), GetLength()  ) )
             {
+               // FIXME : since the 'Area' *is* clean, just use
+               //         a 'CreateString' method, to save CPU time.
                std::string cleanString = 
                      Util::CreateCleanString( BinArea,GetLength()  );
                s << " [" << cleanString << "]";