src/gdcmDataEntry.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDataEntry.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/11/03 08:41:59 $
   7   Version:   $Revision: 1.17 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #include "gdcmDataEntry.h"
  20 #include "gdcmVR.h"
  21 #include "gdcmTS.h"
  22 #include "gdcmGlobal.h"
  23 #include "gdcmUtil.h"
  24 #include "gdcmDebug.h"
  25
  26 #include <fstream>
  27
  28 namespace gdcm
  29 {
  30 //-----------------------------------------------------------------------------
  31 #define MAX_SIZE_PRINT_ELEMENT_VALUE 0x7fffffff
  32 uint32_t DataEntry::MaxSizePrintEntry = MAX_SIZE_PRINT_ELEMENT_VALUE;
  33
  34 //-----------------------------------------------------------------------------
  35 // Constructor / Destructor
  36 /**
  37  * \brief   Constructor for a given DictEntry
  38  * @param   e Pointer to existing dictionary entry
  39  */
  40 DataEntry::DataEntry(DictEntry *e)
  41             : DocEntry(e)
  42 {
  43    State = STATE_LOADED;
  44    Flag = FLAG_NONE;
  45
  46    BinArea = 0;
  47    SelfArea = true;
  48 }
  49
  50 /**
  51  * \brief   Constructor for a given DocEntry
  52  * @param   e Pointer to existing Doc entry
  53  */
  54 DataEntry::DataEntry(DocEntry *e)
  55             : DocEntry(e->GetDictEntry())
  56 {
  57    Flag = FLAG_NONE;
  58    BinArea = 0;
  59    SelfArea = true;
  60
  61    Copy(e);
  62 }
  63
  64 /**
  65  * \brief   Canonical destructor.
  66  */
  67 DataEntry::~DataEntry ()
  68 {
  69    DeleteBinArea();
  70 }
  71
  72 //-----------------------------------------------------------------------------
  73 // Print
  74
  75 //-----------------------------------------------------------------------------
  76 // Public
  77 /**
  78  * \brief Sets the value (non string) of the current Dicom Header Entry
  79  */
  80 void DataEntry::SetBinArea( uint8_t *area, bool self )
  81 {
  82    DeleteBinArea();
  83
  84    BinArea = area;
  85    SelfArea = self;
  86
  87    State = STATE_LOADED;
  88 }
  89 /**
  90  * \brief Inserts the value (non string) into the current Dicom Header Entry
  91  */
  92 void DataEntry::CopyBinArea( uint8_t *area, uint32_t length )
  93 {
  94    DeleteBinArea();
  95
  96    uint32_t lgh = length + length%2;
  97    SetLength(lgh);
  98
  99    if( area && length > 0 )
 100    {
 101       NewBinArea();
 102       memcpy(BinArea,area,length);
 103       if( length!=lgh )
 104          BinArea[length]=0;
 105
 106       State = STATE_LOADED;
 107    }
 108 }
 109
 110 void DataEntry::SetValue(const uint32_t &id, const double &val)
 111 {
 112    if( !BinArea )
 113       NewBinArea();
 114    State = STATE_LOADED;
 115
 116    if( id > GetValueCount() )
 117    {
 118       gdcmErrorMacro("Index (" << id << ")is greater than the data size");
 119       return;
 120    }
 121
 122    const VRKey &vr = GetVR();
 123    if( vr == "US" || vr == "SS" )
 124    {
 125       uint16_t *data = (uint16_t *)BinArea;
 126       data[id] = (uint16_t)val;
 127    }
 128    else if( vr == "UL" || vr == "SL" )
 129    {
 130       uint32_t *data = (uint32_t *)BinArea;
 131       data[id] = (uint32_t)val;
 132    }
 133    else if( vr == "FL" )
 134    {
 135       float *data = (float *)BinArea;
 136       data[id] = (float)val;
 137    }
 138    else if( vr == "FD" )
 139    {
 140       double *data = (double *)BinArea;
 141       data[id] = (double)val;
 142    }
 143    else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
 144    {
 145       gdcmErrorMacro("SetValue on String representable not implemented yet");
 146    }
 147    else
 148    {
 149       BinArea[id] = (uint8_t)val;
 150    }
 151 }
 152 /**
 153  * \brief returns, as a double (?!?) one of the values
 154  //      (when entry is multivaluated), identified by its index.
 155  //      Returns 0.0 if index is wrong
 156  //     FIXME : warn the user there was a problem !
 157  */
 158 double DataEntry::GetValue(const uint32_t &id) const
 159 {
 160    if( !BinArea )
 161    {
 162       gdcmErrorMacro("BinArea not set. Can't get the value");
 163       return 0.0;
 164    }
 165
 166    uint32_t count = GetValueCount();
 167    if( id > count )
 168    {
 169       gdcmErrorMacro("Index (" << id << ")is greater than the data size");
 170       return 0.0;
 171    }
 172
 173    // FIX the API : user *knows* that entry contains a US
 174    //               and he receives a double ?!?
 175
 176    const VRKey &vr = GetVR();
 177    if( vr == "US" || vr == "SS" )
 178       return ((uint16_t *)BinArea)[id];
 179    else if( vr == "UL" || vr == "SL" )
 180       return ((uint32_t *)BinArea)[id];
 181    else if( vr == "FL" )
 182       return ((float *)BinArea)[id];
 183    else if( vr == "FD" )
 184       return ((double *)BinArea)[id];
 185    else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
 186    {
 187       if( GetLength() )
 188       {
 189          // Don't use std::string to accelerate processing
 190          double val;
 191          char *tmp = new char[GetLength()+1];
 192          memcpy(tmp,BinArea,GetLength());
 193          tmp[GetLength()]=0;
 194
 195          if( count == 0 )
 196          {
 197             val = atof(tmp);
 198          }
 199          else
 200          {
 201             count = id;
 202             char *beg = tmp;
 203             for(uint32_t i=0;i<GetLength();i++)
 204             {
 205                if( tmp[i] == '\\' )
 206                {
 207                   if( count == 0 )
 208                   {
 209                      tmp[i] = 0;
 210                      break;
 211                   }
 212                   else
 213                   {
 214                      count--;
 215                      beg = &(tmp[i+1]);
 216                   }
 217                }
 218             }
 219             val = atof(beg);
 220          }
 221
 222          delete[] tmp;
 223          return val;
 224       }
 225       else
 226          return 0.0;
 227    }
 228    else
 229       return BinArea[id];
 230 }
 231
 232 /**
 233  * \brief Checks if the multiplicity of the value follows Dictionary VM
 234  */
 235 bool DataEntry::IsValueCountValid() const
 236 {
 237   bool valid;
 238   uint32_t vm;
 239   const std::string &strVM = GetVM();
 240   uint32_t vc = GetValueCount();
 241
 242   // FIXME : what shall we do with VM = "2-n", "3-n", etc
 243
 244   if( strVM == "1-n" )
 245   {
 246     // make sure there is at least one ??? FIXME
 247     valid = vc >= 1 || vc == 0;
 248   }
 249   else
 250   {
 251     std::istringstream os;
 252     os.str( strVM );
 253     os >> vm;
 254     // Two cases:
 255     // vm respects the one from the dict
 256     // vm is 0 (we need to check if this element is allowed to be empty) FIXME
 257
 258     // note  (JPR)
 259     // ----
 260     // Entries whose type is 1 are mandatory, with a mandatory value.
 261     // Entries whose type is 1c are mandatory-inside-a-Sequence,
 262     //                          with a mandatory value.
 263     // Entries whose type is 2 are mandatory, with an optional value.
 264     // Entries whose type is 2c are mandatory-inside-a-Sequence,
 265     //                          with an optional value.
 266     // Entries whose type is 3 are optional.
 267
 268     // case vc == 0 is only applicable for 'type 2' entries.
 269     // Problem : entry type may depend on the modality and/or the Sequence
 270     //           it's embedded in !
 271     //          (Get the information in the 'Conformance Statements' ...)
 272     valid = vc == vm || vc == 0;
 273   }
 274   return valid;
 275 }
 276
 277 /**
 278  * \brief returns the number of elementary values
 279  */
 280 uint32_t DataEntry::GetValueCount( ) const
 281 {
 282    const VRKey &vr = GetVR();
 283    if( vr == "US" || vr == "SS" )
 284       return GetLength()/sizeof(uint16_t);
 285    else if( vr == "UL" || vr == "SL" )
 286       return GetLength()/sizeof(uint32_t);
 287    else if( vr == "FL" )
 288       return GetLength()/sizeof(float);
 289    else if( vr == "FD" )
 290       return GetLength()/sizeof(double);
 291    else if( Global::GetVR()->IsVROfStringRepresentable(vr) )
 292    {
 293       // Some element in DICOM are allowed to be empty
 294       if( !GetLength() ) return 0;
 295       // Don't use std::string to accelerate processing
 296       uint32_t count = 1;
 297       for(uint32_t i=0;i<GetLength();i++)
 298       {
 299          if( BinArea[i] == '\\')
 300             count++;
 301       }
 302       return count;
 303    }
 304
 305    return GetLength();
 306 }
 307 /**
 308  * \brief Sets the 'value' of an Entry, passed as a std::string
 309  * @param value string representation of the value to be set
 310  */
 311 void DataEntry::SetString(std::string const &value)
 312 {
 313    DeleteBinArea();
 314
 315    const VRKey &vr = GetVR();
 316    if ( vr == "US" || vr == "SS" )
 317    {
 318       std::vector<std::string> tokens;
 319       Util::Tokenize (value, tokens, "\\");
 320       SetLength(tokens.size()*sizeof(uint16_t));
 321       NewBinArea();
 322
 323       uint16_t *data = (uint16_t *)BinArea;
 324       for (unsigned int i=0; i<tokens.size();i++)
 325          data[i] = atoi(tokens[i].c_str());
 326       tokens.clear();
 327    }
 328    else if ( vr == "UL" || vr == "SL" )
 329    {
 330       std::vector<std::string> tokens;
 331       Util::Tokenize (value, tokens, "\\");
 332       SetLength(tokens.size()*sizeof(uint32_t));
 333       NewBinArea();
 334
 335       uint32_t *data = (uint32_t *)BinArea;
 336       for (unsigned int i=0; i<tokens.size();i++)
 337          data[i] = atoi(tokens[i].c_str());
 338       tokens.clear();
 339    }
 340    else if ( vr == "FL" )
 341    {
 342       std::vector<std::string> tokens;
 343       Util::Tokenize (value, tokens, "\\");
 344       SetLength(tokens.size()*sizeof(float));
 345       NewBinArea();
 346
 347       float *data = (float *)BinArea;
 348       for (unsigned int i=0; i<tokens.size();i++)
 349          data[i] = (float)atof(tokens[i].c_str());
 350       tokens.clear();
 351    }
 352    else if ( vr == "FD" )
 353    {
 354       std::vector<std::string> tokens;
 355       Util::Tokenize (value, tokens, "\\");
 356       SetLength(tokens.size()*sizeof(double));
 357       NewBinArea();
 358
 359       double *data = (double *)BinArea;
 360       for (unsigned int i=0; i<tokens.size();i++)
 361          data[i] = atof(tokens[i].c_str());
 362       tokens.clear();
 363    }
 364    else
 365    {
 366       if( value.size() > 0 )
 367       {
 368          // FIXME : should be quicker if we don't create one more std::string
 369          //         just to make even the length of a char array ...
 370
 371          /*
 372          std::string finalVal = Util::DicomString( value.c_str() );
 373          SetLength(finalVal.size());
 374          NewBinArea();
 375
 376          memcpy(BinArea, &(finalVal[0]), finalVal.size());
 377          */
 378
 379          size_t l =  value.size();
 380          SetLength(l + l%2);
 381          NewBinArea();
 382          //memcpy(BinArea, &(value[0]), l);
 383          memcpy(BinArea, value.c_str(), l);
 384          if (l%2)
 385             BinArea[l] = '\0';
 386       }
 387    }
 388    State = STATE_LOADED;
 389 }
 390 /**
 391  * \brief   returns as a string (when possible) the value of the DataEntry
 392  */
 393 std::string const &DataEntry::GetString() const
 394 {
 395    static std::ostringstream s;
 396    const VRKey &vr = GetVR();
 397
 398    s.str("");
 399    StrArea="";
 400
 401    if( !BinArea )
 402       return StrArea;
 403
 404    // When short integer(s) are stored, convert the following (n * 2) characters
 405    // as a displayable string, the values being separated by a back-slash
 406
 407    if( vr == "US" || vr == "SS" )
 408    {
 409       uint16_t *data=(uint16_t *)BinArea;
 410
 411       for (unsigned int i=0; i < GetValueCount(); i++)
 412       {
 413          if( i!=0 )
 414             s << '\\';
 415          s << data[i];
 416       }
 417       StrArea=s.str();
 418    }
 419    // See above comment on multiple short integers (mutatis mutandis).
 420    else if( vr == "UL" || vr == "SL" )
 421    {
 422       uint32_t *data=(uint32_t *)BinArea;
 423
 424       for (unsigned int i=0; i < GetValueCount(); i++)
 425       {
 426          if( i!=0 )
 427             s << '\\';
 428          s << data[i];
 429       }
 430       StrArea=s.str();
 431    }
 432    else if( vr == "FL" )
 433    {
 434       float *data=(float *)BinArea;
 435
 436       for (unsigned int i=0; i < GetValueCount(); i++)
 437       {
 438          if( i!=0 )
 439             s << '\\';
 440          s << data[i];
 441       }
 442       StrArea=s.str();
 443    }
 444    else if( vr == "FD" )
 445    {
 446       double *data=(double *)BinArea;
 447
 448       for (unsigned int i=0; i < GetValueCount(); i++)
 449       {
 450          if( i!=0 )
 451             s << '\\';
 452          s << data[i];
 453       }
 454       StrArea=s.str();
 455    }
 456    else
 457    {
 458       StrArea.append((const char *)BinArea,GetLength());
 459       // to avoid gdcm propagate oddities in lengthes
 460       if ( GetLength()%2)
 461          StrArea.append(" ",1);
 462    }
 463    return StrArea;
 464 }
 465 /**
 466  * \brief   Copies all the attributes from an other DocEntry
 467  * @param doc entry to copy from
 468  */
 469 void DataEntry::Copy(DocEntry *doc)
 470 {
 471    DocEntry::Copy(doc);
 472
 473    DataEntry *entry = dynamic_cast<DataEntry *>(doc);
 474    if ( entry )
 475    {
 476       State = entry->State;
 477       Flag = entry->Flag;
 478       CopyBinArea(entry->BinArea,entry->GetLength());
 479    }
 480 }
 481 /**
 482  * \brief   Writes the 'value' area of a DataEntry
 483  * @param fp already open ofstream pointer
 484  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
 485  */
 486 void DataEntry::WriteContent(std::ofstream *fp, FileType filetype)
 487 {
 488    DocEntry::WriteContent(fp, filetype);
 489
 490    if ( GetGroup() == 0xfffe )
 491    {
 492       return; //delimitors have NO value
 493    }
 494
 495    // --> We only deal with Little Endian writting
 496    // --> forget Big Endian Transfer Syntax writting!
 497    //     Next DICOM version will give it up ...
 498
 499    // WARNING - For Implicit VR private element,
 500    //           we have *no choice* but considering them as
 501    //           something like 'OB' values.
 502    //           we rewrite them as we found them on disc.
 503    //           Some trouble will occur if element was
 504    //           *actually* OW, if image was produced
 505    //           on Big endian based processor, read and writen
 506    //           on Little endian based processor
 507    //           and, later on, somebody needs
 508    //           this 'OW' Implicit VR private element (?!?)
 509    //           (Same stuff, mutatis mutandis, for Little/Big)
 510
 511    // 8/16 bits Pixels problem should be solved automatiquely,
 512    // since we ensure the VR (OB vs OW) is conform to Pixel size.
 513
 514    uint8_t *data = BinArea; //safe notation
 515    size_t l = GetLength();
 516    gdcmDebugMacro ("in DataEntry::WriteContent " << GetKey()
 517              << " : " << Global::GetVR()->GetAtomicElementLength(this->GetVR())
 518              );
 519    if (BinArea) // the binArea was *actually* loaded
 520    {
 521 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
 522       unsigned short vrLgth =
 523                         Global::GetVR()->GetAtomicElementLength(this->GetVR());
 524       unsigned int i;
 525       switch(vrLgth)
 526       {
 527          case 1:
 528          {
 529             binary_write (*fp, data, l );
 530             break;
 531          }
 532          case 2:
 533          {
 534             uint16_t *data16 = (uint16_t *)data;
 535             for(i=0;i<l/vrLgth;i++)
 536                binary_write( *fp, data16[i]);
 537             break;
 538          }
 539          case 4:
 540          {
 541             uint32_t *data32 = (uint32_t *)data;
 542             for(i=0;i<l/vrLgth;i++)
 543                binary_write( *fp, data32[i]);
 544             break;
 545          }
 546          case 8:
 547          {
 548             double *data64 = (double *)data;
 549             for(i=0;i<l/vrLgth;i++)
 550                binary_write( *fp, data64[i]);
 551             break;
 552          }
 553       }
 554 #else
 555    binary_write (*fp, data, l );
 556 #endif //GDCM_WORDS_BIGENDIAN
 557
 558    }
 559    else
 560    {
 561       // nothing was loaded, but we need to skip space on disc
 562
 563       //  --> WARNING : nothing is written;
 564       //  --> the initial data (on the the source image) is lost
 565       //  --> user is *not* informed !
 566
 567       fp->seekp(l, std::ios::cur);
 568    }
 569    // to avoid gdcm to propagate oddities
 570    // (length was already modified)
 571    if (l%2)
 572       fp->seekp(1, std::ios::cur);
 573 }
 574
 575 //-----------------------------------------------------------------------------
 576 // Protected
 577 void DataEntry::NewBinArea(void)
 578 {
 579    DeleteBinArea();
 580    if( GetLength() > 0 )
 581       BinArea = new uint8_t[GetLength()];
 582    SelfArea = true;
 583 }
 584
 585 void DataEntry::DeleteBinArea(void)
 586 {
 587    if (BinArea && SelfArea)
 588    {
 589       delete[] BinArea;
 590       BinArea = NULL;
 591    }
 592 }
 593
 594 //-----------------------------------------------------------------------------
 595 // Private
 596
 597 //-----------------------------------------------------------------------------
 598 // Print
 599 /**
 600  * \brief   Prints a DataEntry (Dicom entry)
 601  * @param   os ostream we want to print in
 602  * @param indent Indentation string to be prepended during printing
 603  */
 604 void DataEntry::Print(std::ostream &os, std::string const & )
 605 {
 606    os << "D ";
 607    DocEntry::Print(os);
 608
 609    uint16_t g = GetGroup();
 610    if (g == 0xfffe) // delimiters have NO value
 611    {
 612       return; // just to avoid identing all the remaining code
 613    }
 614
 615    std::ostringstream s;
 616    TSAtr v;
 617
 618    if( BinArea )
 619    {
 620       v = GetString();
 621       const VRKey &vr = GetVR();
 622
 623       if( vr == "US" || vr == "SS" )
 624          s << " [" << GetString() << "]";
 625       else if( vr == "UL" || vr == "SL" )
 626          s << " [" << GetString() << "]";
 627       else if ( vr == "FL" )
 628          s << " [" << GetString() << "]";
 629       else if ( vr == "FD" )
 630          s << " [" << GetString() << "]";
 631       else
 632       {
 633          if(Global::GetVR()->IsVROfStringRepresentable(vr))
 634          {
 635             // replace non printable characters by '.'
 636             std::string cleanString = Util::CreateCleanString(v);
 637             if ( cleanString.length() <= GetMaxSizePrintEntry()
 638               || PrintLevel >= 3
 639               || IsNotLoaded() )
 640            // FIXME : when IsNotLoaded(), you create a Clean String ?!?
 641            // FIXME : PrintLevel<2 *does* print the values
 642            //        (3 is only for extra offsets printing)
 643            // What do you wanted to do ? JPR
 644             {
 645                s << " [" << cleanString << "]";
 646             }
 647             else
 648             {
 649                s << " [gdcm::too long for print (" << cleanString.length() << ") ]";
 650             }
 651          }
 652          else
 653          {
 654             // A lot of Private elements (with no VR) contain actually
 655             // only printable characters;
 656             // Let's deal with them as is they were VR std::string representable
 657
 658             if ( Util::IsCleanArea( GetBinArea(), GetLength()  ) )
 659             {
 660                // FIXME : since the 'Area' *is* clean, just use
 661                //         a 'CreateString' method, to save CPU time.
 662                std::string cleanString =
 663                      Util::CreateCleanString( BinArea,GetLength()  );
 664                s << " [" << cleanString << "]";
 665             }
 666             else
 667             {
 668                s << " [" << GDCM_BINLOADED << ";"
 669                << "length = " << GetLength() << "]";
 670             }
 671          }
 672       }
 673    }
 674    else
 675    {
 676       if( IsNotLoaded() )
 677          s << " [" << GDCM_NOTLOADED << "]";
 678       else if( IsUnfound() )
 679          s << " [" << GDCM_UNFOUND << "]";
 680       else if( IsUnread() )
 681          s << " [" << GDCM_UNREAD << "]";
 682       else if ( GetLength() == 0 )
 683          s << " []";
 684    }
 685
 686    if( IsPixelData() )
 687       s << " (" << GDCM_PIXELDATA << ")";
 688
 689    // Display the UID value (instead of displaying only the rough code)
 690    // First 'clean' trailing character (space or zero)
 691    if(BinArea)
 692    {
 693       const uint16_t &gr = GetGroup();
 694       const uint16_t &elt = GetElement();
 695       TS *ts = Global::GetTS();
 696
 697       if (gr == 0x0002)
 698       {
 699          // Any more to be displayed ?
 700          if ( elt == 0x0010 || elt == 0x0002 )
 701          {
 702             if ( v.length() != 0 )  // for brain damaged headers
 703             {
 704                if ( ! isdigit((unsigned char)v[v.length()-1]) )
 705                {
 706                   v.erase(v.length()-1, 1);
 707                }
 708             }
 709             s << "  ==>\t[" << ts->GetValue(v) << "]";
 710          }
 711       }
 712       else if (gr == 0x0008)
 713       {
 714          if ( elt == 0x0016 || elt == 0x1150 )
 715          {
 716             if ( v.length() != 0 )  // for brain damaged headers
 717             {
 718                if ( ! isdigit((unsigned char)v[v.length()-1]) )
 719                {
 720                   v.erase(v.length()-1, 1);
 721                }
 722             }
 723             s << "  ==>\t[" << ts->GetValue(v) << "]";
 724          }
 725       }
 726       else if (gr == 0x0004)
 727       {
 728          if ( elt == 0x1510 || elt == 0x1512  )
 729          {
 730             if ( v.length() != 0 )  // for brain damaged headers
 731             {
 732                if ( ! isdigit((unsigned char)v[v.length()-1]) )
 733                {
 734                   v.erase(v.length()-1, 1);
 735                }
 736             }
 737             s << "  ==>\t[" << ts->GetValue(v) << "]";
 738          }
 739       }
 740    }
 741
 742    os << s.str();
 743 }
 744
 745 //-----------------------------------------------------------------------------
 746 } // end namespace gdcm
 747