src/gdcmFile.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/11/21 16:28:06 $
   7   Version:   $Revision: 1.305 $
   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 //
  20 // --------------  Remember ! ----------------------------------
  21 //
  22 // Image Position (Patient)                            (0020,0032):
  23 // If not found (ACR_NEMA) we try Image Position       (0020,0030)
  24 // If not found (ACR-NEMA), we consider Slice Location (0020,1041)
  25 //                                   or Location       (0020,0050)
  26 //                                   as the Z coordinate,
  27 // 0. for all the coordinates if nothing is found
  28 //
  29 // Image Position (Patient) (0020,0032) VM=3
  30 // -->
  31 //  The attribute Patient Orientation (0020,0020) from the General Image Module
  32 // is of type 2C and has the condition Required if image does not require
  33 // Image Orientation (0020,0037) and Image Position (0020,0032).
  34 // However, if the image does require the attributes
  35 // - Image Orientation (Patient) (0020,0037), VM=6
  36 // - Image Position (Patient)    (0020,0032), VM=3
  37 // then attribute Patient Orientation (0020,0020) should not be present
  38 //  in the images.
  39 //
  40 // Remember also :
  41 // Patient Position (0018,5100) values :
  42
  43 //  HFS   = Head First-Supine, where increasing (positive axis direction) :
  44 //     X -> to the direction pointed to by the patient's oustretched left arm
  45 //     Y -> to the anterior-to-posterior direction in the patient's body
  46 //     Z -> to the feet-to-head direction in the patient's body
  47
  48 //  HFP   = Head First-Prone, where increasing (positive axis direction) :
  49 //     X -> to the direction pointed to by the patient's oustretched left arm
  50 //     Y -> to the anterior-to-posterior direction in the patient's body
  51 //     Z -> to the feet-to-head direction in the patient's body
  52
  53 //  FFS  = Feet First-Supine, where increasing (positive axis direction) :
  54 //     X -> to the direction pointed to by the patient's oustretched left arm
  55 //     Y -> to the anterior-to-posterion direction in the patient's body
  56 //     Z -> to the feet-to-head direction in the patient's body
  57
  58 //  FFP  = Feet First-Prone, where increasing (positive axis direction) :
  59 //     X -> to the direction pointed to by the patient's oustretched left arm
  60 //     Y -> to the posterior-to-anterior direction in the patient's body
  61 //     Z -> to the feet-to-head direction in the patient's body
  62
  63 // HFDR = Head First-Decubitus Right
  64 // HFDL = Head First-Decubitus Left
  65 // FFDR = Feet First-Decubitus Right
  66 // FFDL = Feet First-Decubitus Left
  67
  68 //  we can also find (non standard!)
  69
  70 // SEMIERECT
  71 // SUPINE
  72
  73 // CS 2 Patient Orientation (0020 0020)
  74 //    When the coordinates of the image
  75 //    are always present, this field is almost never used.
  76 //    Better we don't trust it too much ...
  77 //    Found Values are :
  78 //     L\P
  79 //     L\FP
  80 //     P\F
  81 //     L\F
  82 //     P\FR
  83 //     R\F
  84 //
  85 // (0020|0037) [Image Orientation (Patient)] [1\0\0\0\1\0 ]
  86
  87
  88 // ---------------------------------------------------------------
  89 //
  90 #include "gdcmFile.h"
  91 #include "gdcmGlobal.h"
  92 #include "gdcmUtil.h"
  93 #include "gdcmDebug.h"
  94 #include "gdcmTS.h"
  95 #include "gdcmSeqEntry.h"
  96 #include "gdcmRLEFramesInfo.h"
  97 #include "gdcmJPEGFragmentsInfo.h"
  98 #include "gdcmDataEntry.h"
  99
 100 #include <vector>
 101 #include <stdio.h>  //sscanf
 102 #include <stdlib.h> // for atoi
 103
 104 namespace gdcm
 105 {
 106
 107 //-----------------------------------------------------------------------------
 108 // Constructor / Destructor
 109
 110 /**
 111  * \brief Constructor used when we want to generate dicom files from scratch
 112  */
 113 File::File():
 114    Document()
 115 {
 116    RLEInfo  = new RLEFramesInfo;
 117    JPEGInfo = new JPEGFragmentsInfo;
 118    GrPixel  = 0x7fe0;  // to avoid further troubles
 119    NumPixel = 0x0010;
 120    BasicOffsetTableItemValue = 0;
 121 }
 122
 123
 124 /**
 125  * \brief   Canonical destructor.
 126  */
 127 File::~File ()
 128 {
 129    if ( RLEInfo )
 130       delete RLEInfo;
 131    if ( JPEGInfo )
 132       delete JPEGInfo;
 133    delete[] BasicOffsetTableItemValue;
 134 }
 135
 136 //-----------------------------------------------------------------------------
 137 // Public
 138 /**
 139  * \brief   Loader
 140  * @return false if file cannot be open or no swap info was found,
 141  *         or no tag was found.
 142  */
 143 bool File::Load( )
 144 {
 145    if ( ! this->Document::Load( ) )
 146       return false;
 147
 148     return DoTheLoadingJob( );
 149 }
 150
 151 /**
 152  * \brief   Does the Loading Job (internal use only)
 153  * @return false if file cannot be open or no swap info was found,
 154  *         or no tag was found.
 155  */
 156 bool File::DoTheLoadingJob( )
 157 {
 158    // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
 159    // We may encounter the 'RETired' (0x0028, 0x0200) tag
 160    // (Image Location") . This entry contains the number of
 161    // the group that contains the pixel data (hence the "Pixel Data"
 162    // is found by indirection through the "Image Location").
 163    // Inside the group pointed by "Image Location" the searched element
 164    // is conventionally the element 0x0010 (when the norm is respected).
 165    // When the "Image Location" is missing we default to group 0x7fe0.
 166    // Note: this IS the right place for the code
 167
 168    // Image Location
 169    const std::string &imgLocation = GetEntryString(0x0028, 0x0200);
 170    if ( imgLocation == GDCM_UNFOUND )
 171    {
 172       // default value
 173       GrPixel = 0x7fe0;
 174    }
 175    else
 176    {
 177       GrPixel = (uint16_t) atoi( imgLocation.c_str() );
 178    }
 179
 180    // sometimes Image Location value doesn't follow
 181    // the supposed processor endianness.
 182    // see gdcmData/cr172241.dcm
 183    if ( GrPixel == 0xe07f )
 184    {
 185       GrPixel = 0x7fe0;
 186    }
 187
 188    if ( GrPixel != 0x7fe0 )
 189    {
 190       // This is a kludge for old dirty Philips imager.
 191       NumPixel = 0x1010;
 192    }
 193    else
 194    {
 195       NumPixel = 0x0010;
 196    }
 197
 198    // Now, we know GrPixel and NumPixel.
 199    // Let's create a VirtualDictEntry to allow a further VR modification
 200    // and force VR to match with BitsAllocated.
 201    DocEntry *entry = GetDocEntry(GrPixel, NumPixel);
 202    if ( entry != 0 )
 203    {
 204       // Compute the RLE or JPEG info
 205       OpenFile();
 206       const std::string &ts = GetTransferSyntax();
 207       Fp->seekg( entry->GetOffset(), std::ios::beg );
 208       if ( Global::GetTS()->IsRLELossless(ts) )
 209          ComputeRLEInfo();
 210       else if ( Global::GetTS()->IsJPEG(ts) )
 211          ComputeJPEGFragmentInfo();
 212       CloseFile();
 213
 214       // Create a new DataEntry to change the DictEntry
 215       // The changed DictEntry will have
 216       // - a correct PixelVR OB or OW)
 217       // - the name to "Pixel Data"
 218       DataEntry *oldEntry = dynamic_cast<DataEntry *>(entry);
 219       if (oldEntry)
 220       {
 221          VRKey PixelVR;
 222          // 8 bits allocated is a 'O Bytes' , as well as 24 (old ACR-NEMA RGB)
 223          // more than 8 (i.e 12, 16) is a 'O Words'
 224          if ( GetBitsAllocated() == 8 || GetBitsAllocated() == 24 )
 225             PixelVR = "OB";
 226          else
 227             PixelVR = "OW";
 228
 229          // Change only made if usefull
 230          if ( PixelVR != oldEntry->GetVR() )
 231          {
 232             DictEntry* newDict = DictEntry::New(GrPixel,NumPixel,
 233                                                 PixelVR,"1","Pixel Data");
 234
 235             DataEntry *newEntry = DataEntry::New(newDict);
 236             newDict->Delete();
 237             newEntry->Copy(entry);
 238             newEntry->SetBinArea(oldEntry->GetBinArea(),oldEntry->IsSelfArea());
 239             oldEntry->SetSelfArea(false);
 240
 241             RemoveEntry(oldEntry);
 242             AddEntry(newEntry);
 243             newEntry->Delete();
 244          }
 245       }
 246    }
 247    return true;
 248 }
 249 /**
 250  * \brief  This predicate, based on hopefully reasonable heuristics,
 251  *         decides whether or not the current File was properly parsed
 252  *         and contains the mandatory information for being considered as
 253  *         a well formed and usable Dicom/Acr File.
 254  * @return true when File is the one of a reasonable Dicom/Acr file,
 255  *         false otherwise.
 256  */
 257 bool File::IsReadable()
 258 {
 259    if ( !Document::IsReadable() )
 260    {
 261       return false;
 262    }
 263
 264    const std::string &res = GetEntryString(0x0028, 0x0005);
 265    if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 )
 266    {
 267       gdcmWarningMacro("Wrong Image Dimensions" << res);
 268       return false; // Image Dimensions
 269    }
 270    bool b0028_0100 = true;
 271    if ( !GetDocEntry(0x0028, 0x0100) )
 272    {
 273       gdcmWarningMacro("Bits Allocated (0028|0100) not found");
 274       //return false; // "Bits Allocated"
 275       b0028_0100 = false;
 276    }
 277    bool b0028_0101 = true;
 278    if ( !GetDocEntry(0x0028, 0x0101) )
 279    {
 280       gdcmWarningMacro("Bits Stored (0028|0101) not found");
 281       //return false; // "Bits Stored"
 282       b0028_0101 = false;
 283    }
 284    bool b0028_0102 = true;
 285    if ( !GetDocEntry(0x0028, 0x0102) )
 286    {
 287       gdcmWarningMacro("Hight Bit (0028|0102) not found");
 288       //return false; // "High Bit"
 289       b0028_0102 = false;
 290    }
 291    bool b0028_0103 = true;
 292    if ( !GetDocEntry(0x0028, 0x0103) )
 293    {
 294       gdcmWarningMacro("Pixel Representation (0028|0103) not found");
 295       //return false; // "Pixel Representation" i.e. 'Sign' ( 0 : unsigned, 1 : signed)
 296       b0028_0103 = false;
 297    }
 298
 299    if ( !b0028_0100 && !b0028_0101 && !b0028_0102 && !b0028_0103)
 300    {
 301       gdcmWarningMacro("Too much mandatory Tags missing !");
 302       return false;
 303    }
 304
 305    if ( !GetDocEntry(GrPixel, NumPixel) )
 306    {
 307       gdcmWarningMacro("Pixel Dicom Element " << std::hex <<
 308                         GrPixel << "|" << NumPixel << "not found");
 309       return false; // Pixel Dicom Element not found :-(
 310    }
 311    return true;
 312 }
 313
 314 /**
 315  * \brief gets the info from 0020,0013 : Image Number else 0.
 316  * @return image number
 317  */
 318 int File::GetImageNumber()
 319 {
 320    //0020 0013 : Image Number
 321    std::string strImNumber = GetEntryString(0x0020,0x0013);
 322    if ( strImNumber != GDCM_UNFOUND )
 323    {
 324       return atoi( strImNumber.c_str() );
 325    }
 326    return 0;   //Hopeless
 327 }
 328
 329 /**
 330  * \brief gets the info from 0008,0060 : Modality
 331  * @return Modality Type
 332  */
 333 ModalityType File::GetModality()
 334 {
 335    // 0008 0060 : Modality
 336    std::string strModality = GetEntryString(0x0008,0x0060);
 337    if ( strModality != GDCM_UNFOUND )
 338    {
 339            if ( strModality.find("AU")  < strModality.length()) return AU;
 340       else if ( strModality.find("AS")  < strModality.length()) return AS;
 341       else if ( strModality.find("BI")  < strModality.length()) return BI;
 342       else if ( strModality.find("CF")  < strModality.length()) return CF;
 343       else if ( strModality.find("CP")  < strModality.length()) return CP;
 344       else if ( strModality.find("CR")  < strModality.length()) return CR;
 345       else if ( strModality.find("CT")  < strModality.length()) return CT;
 346       else if ( strModality.find("CS")  < strModality.length()) return CS;
 347       else if ( strModality.find("DD")  < strModality.length()) return DD;
 348       else if ( strModality.find("DF")  < strModality.length()) return DF;
 349       else if ( strModality.find("DG")  < strModality.length()) return DG;
 350       else if ( strModality.find("DM")  < strModality.length()) return DM;
 351       else if ( strModality.find("DS")  < strModality.length()) return DS;
 352       else if ( strModality.find("DX")  < strModality.length()) return DX;
 353       else if ( strModality.find("ECG") < strModality.length()) return ECG;
 354       else if ( strModality.find("EPS") < strModality.length()) return EPS;
 355       else if ( strModality.find("FA")  < strModality.length()) return FA;
 356       else if ( strModality.find("FS")  < strModality.length()) return FS;
 357       else if ( strModality.find("HC")  < strModality.length()) return HC;
 358       else if ( strModality.find("HD")  < strModality.length()) return HD;
 359       else if ( strModality.find("LP")  < strModality.length()) return LP;
 360       else if ( strModality.find("LS")  < strModality.length()) return LS;
 361       else if ( strModality.find("MA")  < strModality.length()) return MA;
 362       else if ( strModality.find("MR")  < strModality.length()) return MR;
 363       else if ( strModality.find("NM")  < strModality.length()) return NM;
 364       else if ( strModality.find("OT")  < strModality.length()) return OT;
 365       else if ( strModality.find("PT")  < strModality.length()) return PT;
 366       else if ( strModality.find("RF")  < strModality.length()) return RF;
 367       else if ( strModality.find("RG")  < strModality.length()) return RG;
 368       else if ( strModality.find("RTDOSE")
 369                                         < strModality.length()) return RTDOSE;
 370       else if ( strModality.find("RTIMAGE")
 371                                         < strModality.length()) return RTIMAGE;
 372       else if ( strModality.find("RTPLAN")
 373                                         < strModality.length()) return RTPLAN;
 374       else if ( strModality.find("RTSTRUCT")
 375                                         < strModality.length()) return RTSTRUCT;
 376       else if ( strModality.find("SM")  < strModality.length()) return SM;
 377       else if ( strModality.find("ST")  < strModality.length()) return ST;
 378       else if ( strModality.find("TG")  < strModality.length()) return TG;
 379       else if ( strModality.find("US")  < strModality.length()) return US;
 380       else if ( strModality.find("VF")  < strModality.length()) return VF;
 381       else if ( strModality.find("XA")  < strModality.length()) return XA;
 382       else if ( strModality.find("XC")  < strModality.length()) return XC;
 383
 384       else
 385       {
 386          /// \todo throw error return value ???
 387          /// specified <> unknown in our database
 388          return Unknow;
 389       }
 390    }
 391    return Unknow;
 392 }
 393
 394 /**
 395  * \brief   Retrieve the number of columns of image.
 396  * @return  The encountered size when found, 0 by default.
 397  *          0 means the file is NOT USABLE. The caller will have to check
 398  */
 399 int File::GetXSize()
 400 {
 401    DataEntry *entry = GetDataEntry(0x0028,0x0011);
 402    if( entry )
 403       return (int)entry->GetValue(0);
 404    return 0;
 405 }
 406
 407 /**
 408  * \brief   Retrieve the number of lines of image.
 409  * \warning The defaulted value is 1 as opposed to File::GetXSize()
 410  * @return  The encountered size when found, 1 by default
 411  *          (The ACR-NEMA file contains a Signal, not an Image).
 412  */
 413 int File::GetYSize()
 414 {
 415    DataEntry *entry = GetDataEntry(0x0028,0x0010);
 416    if( entry )
 417       return (int)entry->GetValue(0);
 418
 419    if ( IsDicomV3() )
 420    {
 421       return 0;
 422    }
 423
 424    // The Rows (0028,0010) entry was optional for ACR/NEMA.
 425    // (at least some images didn't have it.)
 426    // It might hence be a signal (1D image). So we default to 1:
 427    return 1;
 428 }
 429
 430 /**
 431  * \brief   Retrieve the number of planes of volume or the number
 432  *          of frames of a multiframe.
 433  * \warning When present we consider the "Number of Frames" as the third
 434  *          dimension. When missing we consider the third dimension as
 435  *          being the ACR-NEMA "Planes" tag content.
 436  * @return  The encountered size when found, 1 by default (single image).
 437  */
 438 int File::GetZSize()
 439 {
 440    // Both  DicomV3 and ACR/Nema consider the "Number of Frames"
 441    // as the third dimension.
 442    DataEntry *entry = GetDataEntry(0x0028,0x0008);
 443    if( entry )
 444       return (int)entry->GetValue(0);
 445
 446    // We then consider the "Planes" entry as the third dimension
 447    entry = GetDataEntry(0x0028,0x0012);
 448    if( entry )
 449       return (int)entry->GetValue(0);
 450    return 1;
 451 }
 452
 453 /**
 454   * \brief gets the info from 0018,1164 : ImagerPixelSpacing
 455   *                      then 0028,0030 : Pixel Spacing
 456   *             else 1.0
 457   * @return X dimension of a pixel
 458   */
 459 float File::GetXSpacing()
 460 {
 461    float xspacing = 1.0;
 462    uint32_t nbValue;
 463
 464    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 465
 466    DataEntry *entry = GetDataEntry(0x0018,0x1164);
 467    if( entry )
 468    {
 469       nbValue = entry->GetValueCount();
 470       // Can't use IsValueCountValid because of the complex heuristic.
 471       if( nbValue !=2 )
 472          gdcmWarningMacro("ImagerPixelSpacing (0x0018,0x1164) "
 473          << "has a wrong number of values :" << nbValue);
 474
 475       if( nbValue >= 3 )
 476          xspacing = (float)entry->GetValue(2);
 477       else if( nbValue >= 2 )
 478          xspacing = (float)entry->GetValue(1);
 479       else
 480          xspacing = (float)entry->GetValue(0);
 481
 482       if ( xspacing == 0.0 )
 483          xspacing = 1.0;
 484       return xspacing;
 485    }
 486    else
 487    {
 488       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 489    }
 490
 491    entry = GetDataEntry(0x0028,0x0030);
 492    if( entry )
 493    {
 494       nbValue = entry->GetValueCount();
 495       if( nbValue !=2 )
 496          gdcmWarningMacro("PixelSpacing (0x0018,0x0030) "
 497           << "has a wrong number of values :" << nbValue);
 498
 499       if( nbValue >= 3 )
 500          xspacing = (float)entry->GetValue(2);
 501       else if( nbValue >= 2 )
 502          xspacing = (float)entry->GetValue(1);
 503       else
 504          xspacing = (float)entry->GetValue(0);
 505
 506       if ( xspacing == 0.0 )
 507          xspacing = 1.0;
 508       return xspacing;
 509    }
 510    else
 511    {
 512       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 513    }
 514
 515    return xspacing;
 516 }
 517
 518 /**
 519   * \brief gets the info from 0018,1164 : ImagerPixelSpacing
 520   *               then from   0028,0030 : Pixel Spacing
 521   *             else 1.0
 522   * @return Y dimension of a pixel
 523   */
 524 float File::GetYSpacing()
 525 {
 526    float yspacing = 1.0;
 527    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 528
 529    DataEntry *entry = GetDataEntry(0x0018,0x1164);
 530    if( entry )
 531    {
 532       yspacing = (float)entry->GetValue(0);
 533
 534       if ( yspacing == 0.0 )
 535          yspacing = 1.0;
 536       return yspacing;
 537    }
 538    else
 539    {
 540       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 541    }
 542
 543    entry = GetDataEntry(0x0028,0x0030);
 544    if( entry )
 545    {
 546       yspacing = (float)entry->GetValue(0);
 547
 548       if ( yspacing == 0.0 )
 549          yspacing = 1.0;
 550       return yspacing;
 551    }
 552    else
 553    {
 554       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 555    }
 556
 557    return yspacing;
 558 }
 559
 560 /**
 561  * \brief gets the info from 0018,0088 : Space Between Slices
 562  *                 else from 0018,0050 : Slice Thickness
 563  *                 else 1.0
 564  * @return Z dimension of a voxel-to be
 565  */
 566 float File::GetZSpacing()
 567 {
 568    // --->
 569    // ---> Warning :
 570    // --->
 571   // For *Dicom* images, ZSpacing should be calculated using
 572   // XOrigin, YOrigin, ZOrigin (of the top left image corner)
 573   // of 2 consecutive images, and the Orientation
 574   //
 575   // Computing ZSpacing on a single image is not really meaningfull !
 576
 577    float zspacing = 1.0f;
 578
 579    // Spacing Between Slices : distance between the middle of 2 slices
 580    // Slices may be :
 581    //   jointives     (Spacing between Slices = Slice Thickness)
 582    //   overlapping   (Spacing between Slices < Slice Thickness)
 583    //   disjointes    (Spacing between Slices > Slice Thickness)
 584    // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
 585    //   It only concerns the MRI guys, not people wanting to visualize volumes
 586    //   If Spacing Between Slices is missing,
 587    //   we suppose slices joint together
 588    DataEntry *entry = GetDataEntry(0x0018,0x0088);
 589    if( entry )
 590    {
 591       zspacing = (float)entry->GetValue(0);
 592
 593       if ( zspacing == 0.0 )
 594          zspacing = 1.0;
 595       return zspacing;
 596    }
 597    else
 598       gdcmWarningMacro("Unfound Spacing Between Slices (0018,0088)");
 599
 600    // if no 'Spacing Between Slices' is found,
 601    // we assume slices join together
 602    // (no overlapping, no interslice gap)
 603    // if they don't, we're fucked up
 604    entry = GetDataEntry(0x0018,0x0050);
 605    if( entry )
 606    {
 607       zspacing = (float)entry->GetValue(0);
 608
 609       if ( zspacing == 0.0 )
 610          zspacing = 1.0;
 611       return zspacing;
 612    }
 613    else
 614       gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
 615
 616    return zspacing;
 617 }
 618
 619 /**
 620  * \brief gets the info from 0020,0032 : Image Position Patient
 621  *                 else from 0020,0030 : Image Position (RET)
 622  *                 else 0.
 623  * @return up-left image corner X position
 624  */
 625 float File::GetXOrigin()
 626 {
 627    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 628    if( !entry )
 629    {
 630       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 631       entry = GetDataEntry(0x0020,0x0030);
 632       if( !entry )
 633       {
 634          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 635          return 0.0f;
 636       }
 637    }
 638
 639    if( entry->GetValueCount() == 3 )
 640    {
 641       if (!entry->IsValueCountValid() )
 642       {
 643          gdcmErrorMacro( "Invalid Value Count" );
 644       }
 645       return (float)entry->GetValue(0);
 646    }
 647    return 0.0f;
 648 }
 649
 650 /**
 651  * \brief gets the info from 0020,0032 : Image Position Patient
 652  *                 else from 0020,0030 : Image Position (RET)
 653  *                 else 0.
 654  * @return up-left image corner Y position
 655  */
 656 float File::GetYOrigin()
 657 {
 658    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 659    if( !entry )
 660    {
 661       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 662       entry = GetDataEntry(0x0020,0x0030);
 663       if( !entry )
 664       {
 665          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 666          return 0.0f;
 667       }
 668    }
 669
 670    if( entry->GetValueCount() == 3 )
 671    {
 672       if (!entry->IsValueCountValid() )
 673       {
 674          gdcmErrorMacro( "Invalid Value Count" );
 675       }
 676       return (float)entry->GetValue(1);
 677    }
 678    return 0.0f;
 679 }
 680
 681 /**
 682  * \brief gets the info from 0020,0032 : Image Position Patient
 683  *                 else from 0020,0030 : Image Position (RET)
 684  *                 else from 0020,1041 : Slice Location
 685  *                 else from 0020,0050 : Location
 686  *                 else 0.
 687  * @return up-left image corner Z position
 688  */
 689 float File::GetZOrigin()
 690 {
 691    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 692    if( entry )
 693    {
 694       if( entry->GetValueCount() == 3 )
 695       {
 696          if (!entry->IsValueCountValid() )
 697          {
 698             gdcmErrorMacro( "Invalid Value Count" );
 699          }
 700          return (float)entry->GetValue(2);
 701       }
 702       gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
 703       return 0.0f;
 704    }
 705
 706    entry = GetDataEntry(0x0020,0x0030);
 707    if( entry )
 708    {
 709       if( entry->GetValueCount() == 3 )
 710       {
 711          if (!entry->IsValueCountValid() )
 712          {
 713             gdcmErrorMacro( "Invalid Value Count" );
 714          }
 715          return (float)entry->GetValue(2);
 716       }
 717       gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
 718       return 0.0f;
 719    }
 720
 721    // for *very* old ACR-NEMA images
 722    entry = GetDataEntry(0x0020,0x1041);
 723    if( entry )
 724    {
 725       if( entry->GetValueCount() == 1 )
 726       {
 727          if (!entry->IsValueCountValid() )
 728          {
 729             gdcmErrorMacro( "Invalid Value Count" );
 730          }
 731          return (float)entry->GetValue(0); // VM=1 !
 732       }
 733       gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
 734       return 0.0f;
 735    }
 736
 737    entry = GetDataEntry(0x0020,0x0050);
 738    if( entry )
 739    {
 740       if( entry->GetValueCount() == 1 )
 741       {
 742          if (!entry->IsValueCountValid() )
 743          {
 744             gdcmErrorMacro( "Invalid Value Count" );
 745          }
 746          return (float)entry->GetValue(0);
 747       }
 748       gdcmWarningMacro( "Wrong Location (0020,0050)");
 749       return 0.0f;
 750    }
 751    return 0.; // Hopeless
 752 }
 753
 754 /**
 755   * \brief gets the info from 0020,0037 : Image Orientation Patient
 756   *                   or from 0020 0035 : Image Orientation (RET)
 757   * (needed to organize DICOM files based on their x,y,z position)
 758   * @param iop adress of the (6)float array to receive values
 759   * @return true when one of the tag is found
 760   *         false when nothing is found
 761   */
 762 bool File::GetImageOrientationPatient( float iop[6] )
 763 {
 764    std::string strImOriPat;
 765    //iop is supposed to be float[6]
 766    iop[0] = iop[1] = iop[2] = iop[3] = iop[4] = iop[5] = 0.;
 767
 768    // 0020 0037 DS REL Image Orientation (Patient)
 769    if ( (strImOriPat = GetEntryString(0x0020,0x0037)) != GDCM_UNFOUND )
 770    {
 771       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
 772           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
 773       {
 774          gdcmWarningMacro( "Wrong Image Orientation Patient (0020,0037)."
 775                         << " Less than 6 values were found." );
 776          return false;
 777       }
 778    }
 779    //For ACR-NEMA
 780    // 0020 0035 DS REL Image Orientation (RET)
 781    else if ( (strImOriPat = GetEntryString(0x0020,0x0035)) != GDCM_UNFOUND )
 782    {
 783       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
 784           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
 785       {
 786          gdcmWarningMacro( "wrong Image Orientation Patient (0020,0035). "
 787                         << "Less than 6 values were found." );
 788          return false;
 789       }
 790    }
 791    return true;
 792 }
 793
 794 /**
 795  * \brief   Retrieve the number of Bits Stored (actually used)
 796  *          (as opposed to number of Bits Allocated)
 797  * @return  The encountered number of Bits Stored, 0 by default.
 798  *          0 means the file is NOT USABLE. The caller has to check it !
 799  */
 800 int File::GetBitsStored()
 801 {
 802    DataEntry *entry = GetDataEntry(0x0028,0x0101);
 803    if( !entry )
 804    {
 805       gdcmWarningMacro("BitsStored (0028,0101) is supposed to be mandatory");
 806       return 0;
 807    }
 808    return (int)entry->GetValue(0);
 809 }
 810
 811 /**
 812  * \brief   Retrieve the number of Bits Allocated
 813  *          (8, 12 -compacted ACR-NEMA files-, 16, 24 -old RGB ACR-NEMA files-,)
 814  * @return  The encountered Number of Bits Allocated, 0 by default.
 815  *          0 means the file is NOT USABLE. The caller has to check it !
 816  */
 817 int File::GetBitsAllocated()
 818 {
 819    DataEntry *entry = GetDataEntry(0x0028,0x0100);
 820    if( !entry )
 821    {
 822       gdcmWarningMacro("BitsAllocated (0028,0100) is supposed to be mandatory");
 823       return 0;
 824    }
 825    return (int)entry->GetValue(0);
 826 }
 827
 828 /**
 829  * \brief   Retrieve the high bit position.
 830  * \warning The method defaults to 0 when information is missing.
 831  *          The responsability of checking this value is left to the caller.
 832  * @return  The high bit position when present. 0 when missing.
 833  */
 834 int File::GetHighBitPosition()
 835 {
 836    DataEntry *entry = GetDataEntry(0x0028,0x0102);
 837    if( !entry )
 838    {
 839       gdcmWarningMacro("HighBitPosition (0028,0102) is supposed to be mandatory");
 840       return 0;
 841    }
 842    return (int)entry->GetValue(0);
 843 }
 844
 845 /**
 846  * \brief   Retrieve the number of Samples Per Pixel
 847  *          (1 : gray level, 3 : RGB/YBR -1 or 3 Planes-)
 848  * @return  The encountered number of Samples Per Pixel, 1 by default.
 849  *          (we assume Gray level Pixels)
 850  */
 851 int File::GetSamplesPerPixel()
 852 {
 853    DataEntry *entry = GetDataEntry(0x0028,0x0002);
 854    if( !entry )
 855    {
 856       gdcmWarningMacro("SamplesPerPixel (0028,0002) is supposed to be mandatory");
 857       return 1; // Well, it's supposed to be mandatory ...
 858                 // but sometimes it's missing : *we* assume Gray pixels
 859    }
 860    return (int)entry->GetValue(0);
 861 }
 862
 863 /**
 864  * \brief   Retrieve the Planar Configuration for RGB images
 865  *          (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
 866  * @return  The encountered Planar Configuration, 0 by default.
 867  */
 868 int File::GetPlanarConfiguration()
 869 {
 870    DataEntry *entry = GetDataEntry(0x0028,0x0006);
 871    if( !entry )
 872    {
 873       return 0;
 874    }
 875    return (int)entry->GetValue(0);
 876 }
 877
 878 /**
 879  * \brief   Return the size (in bytes) of a single pixel of data.
 880  * @return  The size in bytes of a single pixel of data; 0 by default
 881  *          0 means the file is NOT USABLE; the caller will have to check
 882  */
 883 int File::GetPixelSize()
 884 {
 885    // 0028 0100 US IMG Bits Allocated
 886    // (in order no to be messed up by old ACR-NEMA RGB images)
 887    assert( !(GetEntryString(0x0028,0x0100) == "24") );
 888
 889    std::string pixelType = GetPixelType();
 890    if ( pixelType ==  "8U" || pixelType == "8S" )
 891    {
 892       return 1;
 893    }
 894    if ( pixelType == "16U" || pixelType == "16S")
 895    {
 896       return 2;
 897    }
 898    if ( pixelType == "32U" || pixelType == "32S")
 899    {
 900       return 4;
 901    }
 902    if ( pixelType == "FD" )
 903    {
 904       return 8;
 905    }
 906    gdcmWarningMacro( "Unknown pixel type: " << pixelType);
 907    return 0;
 908 }
 909
 910 /**
 911  * \brief   Build the Pixel Type of the image.
 912  *          Possible values are:
 913  *          - 8U  unsigned  8 bit,
 914  *          - 8S    signed  8 bit,
 915  *          - 16U unsigned 16 bit,
 916  *          - 16S   signed 16 bit,
 917  *          - 32U unsigned 32 bit,
 918  *          - 32S   signed 32 bit,
 919  *          - FD floating double 64 bits (Not kosher DICOM, but so usefull!)
 920  * \warning 12 bit images appear as 16 bit.
 921  *          24 bit images appear as 8 bit + photochromatic interp ="RGB "
 922  *                                        + Planar Configuration = 0
 923  * @return  0S if nothing found. NOT USABLE file. The caller has to check
 924  */
 925 std::string File::GetPixelType()
 926 {
 927    std::string bitsAlloc = GetEntryString(0x0028, 0x0100); // Bits Allocated
 928    if ( bitsAlloc == GDCM_UNFOUND )
 929    {
 930       gdcmWarningMacro( "Bits Allocated (0028,0100) supposed to be mandatory");
 931       bitsAlloc = "16"; // default and arbitrary value, not to polute the output
 932    }
 933
 934    if ( bitsAlloc == "64" )
 935    {
 936       return "FD";
 937    }
 938    else if ( bitsAlloc == "12" )
 939    {
 940       // It will be unpacked
 941       bitsAlloc = "16";
 942    }
 943    else if ( bitsAlloc == "24" )
 944    {
 945       // (in order no to be messed up by old RGB images)
 946       bitsAlloc = "8";
 947    }
 948
 949    std::string sign;
 950    if( IsSignedPixelData() )
 951    {
 952       sign = "S";
 953    }
 954    else
 955    {
 956       sign = "U";
 957    }
 958    return bitsAlloc + sign;
 959 }
 960
 961 /**
 962  * \brief   Check whether the pixels are signed (1) or UNsigned (0) data.
 963  * \warning The method defaults to false (UNsigned) when tag 0028|0103
 964  *          is missing.
 965  *          The responsability of checking this value is left to the caller
 966  *          (NO transformation is performed on the pixels to make then >0)
 967  * @return  True when signed, false when UNsigned
 968  */
 969 bool File::IsSignedPixelData()
 970 {
 971    DataEntry *entry = GetDataEntry(0x0028, 0x0103);//"Pixel Representation"
 972    if( !entry )
 973    {
 974       gdcmWarningMacro( "Pixel Representation (0028,0103) supposed to be "
 975                       << "mandatory");
 976       return false;
 977    }
 978    return entry->GetValue(0) != 0;
 979 }
 980
 981 /**
 982  * \brief   Check whether this a monochrome picture (gray levels) or not,
 983  *          using "Photometric Interpretation" tag (0x0028,0x0004).
 984  * @return  true when "MONOCHROME1" or "MONOCHROME2". False otherwise.
 985  */
 986 bool File::IsMonochrome()
 987 {
 988    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
 989    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1")
 990       || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") )
 991    {
 992       return true;
 993    }
 994    if ( PhotometricInterp == GDCM_UNFOUND )
 995    {
 996       gdcmWarningMacro( "Photometric Interpretation (0028,0004) supposed to be "
 997                          << "mandatory");
 998    }
 999    return false;
1000 }
1001
1002 /**
1003  * \brief   Check whether this a MONOCHROME1 picture (high values = dark)
1004  *            or not using "Photometric Interpretation" tag (0x0028,0x0004).
1005  * @return  true when "MONOCHROME1" . False otherwise.
1006  */
1007 bool File::IsMonochrome1()
1008 {
1009    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1010    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1") )
1011    {
1012       return true;
1013    }
1014    if ( PhotometricInterp == GDCM_UNFOUND )
1015    {
1016       gdcmWarningMacro( "Photometric Interpretation (0028,0004) : supposed to"
1017       << " be mandatory! ");
1018    }
1019    return false;
1020 }
1021
1022 /**
1023  * \brief   Check whether this a "PALETTE COLOR" picture or not by accessing
1024  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1025  * @return  true when "PALETTE COLOR". False otherwise.
1026  */
1027 bool File::IsPaletteColor()
1028 {
1029    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1030    if (   PhotometricInterp == "PALETTE COLOR " )
1031    {
1032       return true;
1033    }
1034    if ( PhotometricInterp == GDCM_UNFOUND )
1035    {
1036       gdcmDebugMacro( "Not found : Palette color (0028,0004)");
1037    }
1038    return false;
1039 }
1040
1041 /**
1042  * \brief   Check whether this a "YBR_FULL" color picture or not by accessing
1043  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1044  * @return  true when "YBR_FULL". False otherwise.
1045  */
1046 bool File::IsYBRFull()
1047 {
1048    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1049    if (   PhotometricInterp == "YBR_FULL" )
1050    {
1051       return true;
1052    }
1053    if ( PhotometricInterp == GDCM_UNFOUND )
1054    {
1055       gdcmDebugMacro( "Not found : YBR Full (0028,0004)");
1056    }
1057    return false;
1058 }
1059
1060 /**
1061   * \brief tells us if LUT are used
1062   * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data'
1063   *          are NOT considered as LUT, since nobody knows
1064   *          how to deal with them
1065   *          Please warn me if you know sbdy that *does* know ... jprx
1066   * @return true if LUT Descriptors and LUT Tables were found
1067   */
1068 bool File::HasLUT()
1069 {
1070    // Check the presence of the LUT Descriptors, and LUT Tables
1071    // LutDescriptorRed
1072    if ( !GetDocEntry(0x0028,0x1101) )
1073    {
1074       return false;
1075    }
1076    // LutDescriptorGreen
1077    if ( !GetDocEntry(0x0028,0x1102) )
1078    {
1079       return false;
1080    }
1081    // LutDescriptorBlue
1082    if ( !GetDocEntry(0x0028,0x1103) )
1083    {
1084       return false;
1085    }
1086    // Red Palette Color Lookup Table Data
1087    if ( !GetDocEntry(0x0028,0x1201) )
1088    {
1089       return false;
1090    }
1091    // Green Palette Color Lookup Table Data
1092    if ( !GetDocEntry(0x0028,0x1202) )
1093    {
1094       return false;
1095    }
1096    // Blue Palette Color Lookup Table Data
1097    if ( !GetDocEntry(0x0028,0x1203) )
1098    {
1099       return false;
1100    }
1101
1102    // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent)
1103    //         NOT taken into account, but we don't know how to use it ...
1104    return true;
1105 }
1106
1107 /**
1108   * \brief gets the info from 0028,1101 : Lookup Table Desc-Red
1109   *             else 0
1110   * @return Lookup Table number of Bits , 0 by default
1111   *          when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
1112   * @ return bit number of each LUT item
1113   */
1114 int File::GetLUTNbits()
1115 {
1116    std::vector<std::string> tokens;
1117    int lutNbits;
1118
1119    //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red
1120    //                                = Lookup Table Desc-Blue
1121    // Consistency already checked in GetLUTLength
1122    std::string lutDescription = GetEntryString(0x0028,0x1101);
1123    if ( lutDescription == GDCM_UNFOUND )
1124    {
1125       return 0;
1126    }
1127
1128    tokens.clear(); // clean any previous value
1129    Util::Tokenize ( lutDescription, tokens, "\\" );
1130    //LutLength=atoi(tokens[0].c_str());
1131    //LutDepth=atoi(tokens[1].c_str());
1132
1133    lutNbits = atoi( tokens[2].c_str() );
1134    tokens.clear();
1135
1136    return lutNbits;
1137 }
1138
1139 /**
1140  *\brief gets the info from 0028,1052 : Rescale Intercept
1141  * @return Rescale Intercept
1142  */
1143 float File::GetRescaleIntercept()
1144 {
1145    // 0028 1052 DS IMG Rescale Intercept
1146    DataEntry *entry = GetDataEntry(0x0028, 0x1052);
1147    if( !entry )
1148    {
1149       gdcmWarningMacro( "Missing Rescale Intercept (0028,1052)");
1150       return 0.0f;
1151    }
1152    return (float)entry->GetValue(0);
1153
1154 }
1155
1156 /**
1157  *\brief   gets the info from 0028,1053 : Rescale Slope
1158  * @return Rescale Slope
1159  */
1160 float File::GetRescaleSlope()
1161 {
1162    // 0028 1053 DS IMG Rescale Slope
1163    DataEntry *entry = GetDataEntry(0x0028, 0x1053);
1164    if( !entry )
1165    {
1166       gdcmDebugMacro( "Missing Rescale Slope (0028,1053)");
1167       return 1.0f;
1168    }
1169    return (float)entry->GetValue(0);
1170 }
1171
1172 /**
1173  * \brief This function is intended to user who doesn't want
1174  *   to have to manage a LUT and expects to get an RBG Pixel image
1175  *   (or a monochrome one ...)
1176  * \warning to be used with GetImagePixels()
1177  * @return 1 if Gray level, 3 if Color (RGB, YBR, *or PALETTE COLOR*)
1178  */
1179 int File::GetNumberOfScalarComponents()
1180 {
1181    if ( GetSamplesPerPixel() == 3 )
1182    {
1183       return 3;
1184    }
1185
1186    // 0028 0100 US IMG Bits Allocated
1187    // (in order no to be messed up by old RGB images)
1188    if ( GetEntryString(0x0028,0x0100) == "24" )
1189    {
1190       return 3;
1191    }
1192
1193    std::string strPhotometricInterpretation = GetEntryString(0x0028,0x0004);
1194
1195    if ( ( strPhotometricInterpretation == "PALETTE COLOR ") )
1196    {
1197       if ( HasLUT() )// PALETTE COLOR is NOT enough
1198       {
1199          return 3;
1200       }
1201       else
1202       {
1203          return 1;
1204       }
1205    }
1206
1207    // beware of trailing space at end of string
1208    // DICOM tags are never of odd length
1209    if ( strPhotometricInterpretation == GDCM_UNFOUND   ||
1210         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") ||
1211         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") )
1212    {
1213       return 1;
1214    }
1215    else
1216    {
1217       // we assume that *all* kinds of YBR are dealt with
1218       return 3;
1219    }
1220 }
1221
1222 /**
1223  * \brief This function is intended to user that DOESN'T want
1224  *  to get RGB pixels image when it's stored as a PALETTE COLOR image
1225  *   - the (vtk) user is supposed to know how deal with LUTs -
1226  * \warning to be used with GetImagePixelsRaw()
1227  * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -)
1228  */
1229 int File::GetNumberOfScalarComponentsRaw()
1230 {
1231    // 0028 0100 US IMG Bits Allocated
1232    // (in order no to be messed up by old RGB images)
1233    if ( File::GetEntryString(0x0028,0x0100) == "24" )
1234    {
1235       return 3;
1236    }
1237
1238    // we assume that *all* kinds of YBR are dealt with
1239    return GetSamplesPerPixel();
1240 }
1241
1242 /**
1243  * \brief   Recover the offset (from the beginning of the file)
1244  *          of *image* pixels (not *icone image* pixels, if any !)
1245  * @return Pixel Offset
1246  */
1247 size_t File::GetPixelOffset()
1248 {
1249    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1250    if ( pxlElement )
1251    {
1252       return pxlElement->GetOffset();
1253    }
1254    else
1255    {
1256       gdcmWarningMacro( "Big trouble : Pixel Element ("
1257                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1258       return 0;
1259    }
1260 }
1261
1262 /**
1263  * \brief   Recover the pixel area length (in Bytes)
1264  * @return Pixel Element Length, as stored in the header
1265  *         (NOT the memory space necessary to hold the Pixels
1266  *          -in case of embeded compressed image-)
1267  *         0 : NOT USABLE file. The caller has to check.
1268  */
1269 size_t File::GetPixelAreaLength()
1270 {
1271    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1272    if ( pxlElement )
1273    {
1274       return pxlElement->GetLength();
1275    }
1276    else
1277    {
1278       gdcmWarningMacro( "Big trouble : Pixel Element ("
1279                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1280       return 0;
1281    }
1282 }
1283
1284 /**
1285  * \brief Adds the characteristics of a new element we want to anonymize
1286  * @param   group  Group number of the target tag.
1287  * @param   elem Element number of the target tag.
1288  * @param   value new value (string) to substitute with
1289  */
1290 void File::AddAnonymizeElement (uint16_t group, uint16_t elem,
1291                                 std::string const &value)
1292 {
1293    DicomElement el;
1294    el.Group = group;
1295    el.Elem  = elem;
1296    el.Value = value;
1297    UserAnonymizeList.push_back(el);
1298 }
1299
1300 /**
1301  * \brief Overwrites in the file the values of the DicomElements
1302  *       held in the list
1303  */
1304 void File::AnonymizeNoLoad()
1305 {
1306    std::fstream *fp = new std::fstream(Filename.c_str(),
1307                               std::ios::in | std::ios::out | std::ios::binary);
1308    gdcm::DocEntry *d;
1309    uint32_t offset;
1310    uint32_t lgth;
1311    uint32_t valLgth = 0;
1312    std::string *spaces;
1313    for (ListElements::iterator it = UserAnonymizeList.begin();
1314                                it != UserAnonymizeList.end();
1315                              ++it)
1316    {
1317       d = GetDocEntry( (*it).Group, (*it).Elem);
1318
1319       if ( d == NULL)
1320          continue;
1321
1322       if ( dynamic_cast<SeqEntry *>(d) )
1323       {
1324          gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1325          continue;
1326       }
1327
1328       offset = d->GetOffset();
1329       lgth =   d->GetLength();
1330       if (valLgth < lgth)
1331       {
1332          spaces = new std::string( lgth-valLgth, ' ');
1333          (*it).Value = (*it).Value + *spaces;
1334          delete spaces;
1335       }
1336       fp->seekp( offset, std::ios::beg );
1337       fp->write( (*it).Value.c_str(), lgth );
1338
1339    }
1340    fp->close();
1341    delete fp;
1342 }
1343
1344 /**
1345  * \brief anonymize a File (remove Patient's personal info passed with
1346  *        AddAnonymizeElement()
1347  * \note You cannot Anonymize a DataEntry (to be fixed)
1348  */
1349 bool File::AnonymizeFile()
1350 {
1351    // If Anonymisation list is empty, let's perform some basic anonymization
1352    if ( UserAnonymizeList.begin() == UserAnonymizeList.end() )
1353    {
1354       // If exist, replace by spaces
1355       SetEntryString("  ",0x0010, 0x2154); // Telephone
1356       SetEntryString("  ",0x0010, 0x1040); // Adress
1357       SetEntryString("  ",0x0010, 0x0020); // Patient ID
1358
1359       DocEntry *patientNameHE = GetDocEntry (0x0010, 0x0010);
1360
1361       if ( patientNameHE ) // we replace it by Study Instance UID (why not ?)
1362       {
1363          std::string studyInstanceUID =  GetEntryString (0x0020, 0x000d);
1364          if ( studyInstanceUID != GDCM_UNFOUND )
1365          {
1366             SetEntryString(studyInstanceUID, 0x0010, 0x0010);
1367          }
1368          else
1369          {
1370             SetEntryString("anonymized", 0x0010, 0x0010);
1371          }
1372       }
1373    }
1374    else
1375    {
1376       gdcm::DocEntry *d;
1377       for (ListElements::iterator it = UserAnonymizeList.begin();
1378                                   it != UserAnonymizeList.end();
1379                                 ++it)
1380       {
1381          d = GetDocEntry( (*it).Group, (*it).Elem);
1382
1383          if ( d == NULL)
1384             continue;
1385
1386          if ( dynamic_cast<SeqEntry *>(d) )
1387          {
1388             gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1389             continue;
1390          }
1391
1392          if ( dynamic_cast<DataEntry *>(d) )
1393          {
1394             gdcmWarningMacro( "To 'Anonymize' a DataEntry, better use AnonymizeNoLoad (FIXME) ");
1395             continue;
1396          }
1397          else
1398             SetEntryString ((*it).Value, (*it).Group, (*it).Elem);
1399       }
1400 }
1401
1402   // In order to make definitively impossible any further identification
1403   // remove or replace all the stuff that contains a Date
1404
1405 //0008 0012 DA ID Instance Creation Date
1406 //0008 0020 DA ID Study Date
1407 //0008 0021 DA ID Series Date
1408 //0008 0022 DA ID Acquisition Date
1409 //0008 0023 DA ID Content Date
1410 //0008 0024 DA ID Overlay Date
1411 //0008 0025 DA ID Curve Date
1412 //0008 002a DT ID Acquisition Datetime
1413 //0018 9074 DT ACQ Frame Acquisition Datetime
1414 //0018 9151 DT ACQ Frame Reference Datetime
1415 //0018 a002 DT ACQ Contribution Date Time
1416 //0020 3403 SH REL Modified Image Date (RET)
1417 //0032 0032 DA SDY Study Verified Date
1418 //0032 0034 DA SDY Study Read Date
1419 //0032 1000 DA SDY Scheduled Study Start Date
1420 //0032 1010 DA SDY Scheduled Study Stop Date
1421 //0032 1040 DA SDY Study Arrival Date
1422 //0032 1050 DA SDY Study Completion Date
1423 //0038 001a DA VIS Scheduled Admission Date
1424 //0038 001c DA VIS Scheduled Discharge Date
1425 //0038 0020 DA VIS Admitting Date
1426 //0038 0030 DA VIS Discharge Date
1427 //0040 0002 DA PRC Scheduled Procedure Step Start Date
1428 //0040 0004 DA PRC Scheduled Procedure Step End Date
1429 //0040 0244 DA PRC Performed Procedure Step Start Date
1430 //0040 0250 DA PRC Performed Procedure Step End Date
1431 //0040 2004 DA PRC Issue Date of Imaging Service Request
1432 //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
1433 //0040 4011 DT PRC Expected Completion Date and Time
1434 //0040 a030 DT PRC Verification Date Time
1435 //0040 a032 DT PRC Observation Date Time
1436 //0040 a120 DT PRC DateTime
1437 //0040 a121 DA PRC Date
1438 //0040 a13a DT PRC Referenced Datetime
1439 //0070 0082 DA ??? Presentation Creation Date
1440 //0100 0420 DT ??? SOP Autorization Date and Time
1441 //0400 0105 DT ??? Digital Signature DateTime
1442 //2100 0040 DA PJ Creation Date
1443 //3006 0008 DA SSET Structure Set Date
1444 //3008 0024 DA ??? Treatment Control Point Date
1445 //3008 0054 DA ??? First Treatment Date
1446 //3008 0056 DA ??? Most Recent Treatment Date
1447 //3008 0162 DA ??? Safe Position Exit Date
1448 //3008 0166 DA ??? Safe Position Return Date
1449 //3008 0250 DA ??? Treatment Date
1450 //300a 0006 DA RT RT Plan Date
1451 //300a 022c DA RT Air Kerma Rate Reference Date
1452 //300e 0004 DA RT Review Date
1453
1454    return true;
1455 }
1456
1457 /**
1458  * \brief Performs some consistency checking on various 'File related'
1459  *       (as opposed to 'DicomDir related') entries
1460  *       then writes in a file all the (Dicom Elements) included the Pixels
1461  * @param fileName file name to write to
1462  * @param writetype type of the file to be written
1463  *          (ACR, ExplicitVR, ImplicitVR)
1464  */
1465 bool File::Write(std::string fileName, FileType writetype)
1466 {
1467    std::ofstream *fp = new std::ofstream(fileName.c_str(),
1468                                          std::ios::out | std::ios::binary);
1469    if (*fp == NULL)
1470    {
1471       gdcmWarningMacro("Failed to open (write) File: " << fileName.c_str());
1472       return false;
1473    }
1474
1475    // Entry : 0002|0000 = group length -> recalculated
1476    DataEntry *e0000 = GetDataEntry(0x0002,0x0000);
1477    if ( e0000 )
1478    {
1479       std::ostringstream sLen;
1480       sLen << ComputeGroup0002Length( );
1481       e0000->SetString(sLen.str());
1482    }
1483
1484    // FIXME : Derma?.dcm does not have it...let's remove it ?!? JPRx
1485    if( writetype != JPEG )
1486    {
1487       int i_lgPix = GetEntryLength(GrPixel, NumPixel);
1488       if (i_lgPix != -2)
1489       {
1490          // no (GrPixel, NumPixel) element
1491          std::string s_lgPix = Util::Format("%d", i_lgPix+12);
1492          s_lgPix = Util::DicomString( s_lgPix.c_str() );
1493          InsertEntryString(s_lgPix,GrPixel, 0x0000);
1494       }
1495    }
1496    Document::WriteContent(fp, writetype);
1497
1498    fp->close();
1499    delete fp;
1500
1501    return true;
1502 }
1503
1504 //-----------------------------------------------------------------------------
1505 // Protected
1506
1507
1508 //-----------------------------------------------------------------------------
1509 // Private
1510 /**
1511  * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
1512  *        Compute the RLE extra information and store it in \ref RLEInfo
1513  *        for later pixel retrieval usage.
1514  */
1515 void File::ComputeRLEInfo()
1516 {
1517    std::string ts = GetTransferSyntax();
1518    if ( !Global::GetTS()->IsRLELossless(ts) )
1519    {
1520       return;
1521    }
1522
1523    // Encoded pixel data: for the time being we are only concerned with
1524    // Jpeg or RLE Pixel data encodings.
1525    // As stated in PS 3.5-2003, section 8.2 p44:
1526    // "If sent in Encapsulated Format (i.e. other than the Native Format) the
1527    //  value representation OB is used".
1528    // Hence we expect an OB value representation. Concerning OB VR,
1529    // the section PS 3.5-2003, section A.4.c p 58-59, states:
1530    // "For the Value Representations OB and OW, the encoding shall meet the
1531    //   following specifications depending on the Data element tag:"
1532    //   [...snip...]
1533    //    - the first item in the sequence of items before the encoded pixel
1534    //      data stream shall be basic offset table item. The basic offset table
1535    //      item value, however, is not required to be present"
1536    ReadEncapsulatedBasicOffsetTable();
1537
1538    // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
1539    // Loop on the individual frame[s] and store the information
1540    // on the RLE fragments in a RLEFramesInfo.
1541    // Note: - when only a single frame is present, this is a
1542    //         classical image.
1543    //       - when more than one frame are present, then we are in
1544    //         the case of a multi-frame image.
1545    long frameLength;
1546    int i=0;
1547    uint32_t sum = 0;
1548    while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
1549    {
1550       // Since we have read the basic offset table, let's check the value were correct
1551       // or else produce a warning:
1552       if ( BasicOffsetTableItemValue )
1553         {
1554         // If a BasicOffsetTableItemValue was read
1555         uint32_t individualLength = BasicOffsetTableItemValue[i];
1556         assert( individualLength == sum ); // REMOVE that if this is a problem
1557         if( individualLength != sum )
1558           {
1559           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght" );
1560           }
1561         sum += frameLength + 8;
1562         i++;
1563         }
1564       // Parse the RLE Header and store the corresponding RLE Segment
1565       // Offset Table information on fragments of this current Frame.
1566       // Note that the fragment pixels themselves are not loaded
1567       // (but just skipped).
1568       long frameOffset = Fp->tellg();
1569
1570       uint32_t nbRleSegments = ReadInt32();
1571       if ( nbRleSegments > 16 )
1572       {
1573          // There should be at most 15 segments (refer to RLEFrame class)
1574          gdcmWarningMacro( "Too many segments.");
1575       }
1576
1577       uint32_t rleSegmentOffsetTable[16];
1578       for( int k = 1; k <= 15; k++ )
1579       {
1580          rleSegmentOffsetTable[k] = ReadInt32();
1581       }
1582
1583       // Deduce from both RLE Header and frameLength
1584       // the fragment length, and again store this info
1585       // in a RLEFramesInfo.
1586       long rleSegmentLength[15];
1587       // skipping (not reading) RLE Segments
1588       if ( nbRleSegments > 1)
1589       {
1590          for(unsigned int k = 1; k <= nbRleSegments-1; k++)
1591          {
1592              rleSegmentLength[k] =  rleSegmentOffsetTable[k+1]
1593                                   - rleSegmentOffsetTable[k];
1594              SkipBytes(rleSegmentLength[k]);
1595           }
1596        }
1597
1598        rleSegmentLength[nbRleSegments] = frameLength
1599                                       - rleSegmentOffsetTable[nbRleSegments];
1600        SkipBytes(rleSegmentLength[nbRleSegments]);
1601
1602        // Store the collected info
1603        RLEFrame *newFrame = new RLEFrame;
1604        newFrame->SetNumberOfFragments(nbRleSegments);
1605        for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
1606        {
1607           newFrame->SetOffset(uk,frameOffset + rleSegmentOffsetTable[uk]);
1608           newFrame->SetLength(uk,rleSegmentLength[uk]);
1609        }
1610        RLEInfo->AddFrame(newFrame);
1611    }
1612
1613    // Make sure that  we encounter a 'Sequence Delimiter Item'
1614    // at the end of the item :
1615    if ( !ReadTag(0xfffe, 0xe0dd) )
1616    {
1617       gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
1618    }
1619 }
1620
1621 /**
1622  * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
1623  *        Compute the jpeg extra information (fragment[s] offset[s] and
1624  *        length) and store it[them] in \ref JPEGInfo for later pixel
1625  *        retrieval usage.
1626  */
1627 void File::ComputeJPEGFragmentInfo()
1628 {
1629    // If you need to, look for comments of ComputeRLEInfo().
1630    std::string ts = GetTransferSyntax();
1631    if ( ! Global::GetTS()->IsJPEG(ts) )
1632    {
1633       return;
1634    }
1635
1636    ReadEncapsulatedBasicOffsetTable();
1637
1638    // Loop on the fragments[s] and store the parsed information in a
1639    // JPEGInfo.
1640    long fragmentLength;
1641    int i=0;
1642    uint32_t sum = 0;
1643    while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
1644    {
1645       // Since we have read the basic offset table, let's check the value were correct
1646       // or else produce a warning:
1647       // A.4 Transfer syntaxes for encapsulation of encoded pixel data:
1648       // When the Item Value is present, the Basic Offset Table Item Value shall contain
1649       // concatenated 32-bit unsigned integer values that are byte offsets to the first
1650       // byte of the Item Tag of the first fragment for each frame in the Sequence of
1651       // Items. These offsets are measured from the first byte of the first Item Tag
1652       // following the Basic Offset Table item (See Table A.4-2).
1653
1654       if ( BasicOffsetTableItemValue )
1655         {
1656         // If a BasicOffsetTableItemValue was read
1657         uint32_t individualLength = BasicOffsetTableItemValue[i];
1658         //assert( individualLength == sum ); // Seems like 00191113.dcm is off by one ??
1659         if( individualLength != sum )
1660           {
1661           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght:" <<
1662               individualLength << " != " << sum );
1663           }
1664         sum += fragmentLength + 8;
1665         i++;
1666         }
1667
1668       long fragmentOffset = Fp->tellg();
1669       // Store the collected info
1670       JPEGFragment *newFragment = new JPEGFragment;
1671       newFragment->SetOffset(fragmentOffset);
1672       newFragment->SetLength(fragmentLength);
1673       JPEGInfo->AddFragment(newFragment);
1674
1675       SkipBytes(fragmentLength);
1676    }
1677
1678    // Make sure that  we encounter a 'Sequence Delimiter Item'
1679    // at the end of the item :
1680    if ( !ReadTag(0xfffe, 0xe0dd) )
1681    {
1682       gdcmWarningMacro( "No sequence delimiter item at end of JPEG item sequence");
1683    }
1684 }
1685
1686 /**
1687  * \brief   Assuming the internal file pointer \ref Document::Fp
1688  *          is placed at the beginning of a tag, check whether this
1689  *          tag is (TestGroup, TestElem).
1690  * \warning On success the internal file pointer \ref Document::Fp
1691  *          is modified to point after the tag.
1692  *          On failure (i.e. when the tag wasn't the expected tag
1693  *          (TestGroup, TestElem) the internal file pointer
1694  *          \ref Document::Fp is restored to it's original position.
1695  * @param   testGroup The expected group   of the tag.
1696  * @param   testElem  The expected Element of the tag.
1697  * @return  True on success, false otherwise.
1698  */
1699 bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
1700 {
1701    long positionOnEntry = Fp->tellg();
1702    long currentPosition = Fp->tellg();          // On debugging purposes
1703
1704    // Read the Item Tag group and element, and make
1705    // sure they are what we expected:
1706    uint16_t itemTagGroup;
1707    uint16_t itemTagElem;
1708    try
1709    {
1710       itemTagGroup = ReadInt16();
1711       itemTagElem  = ReadInt16();
1712    }
1713    catch ( FormatError )
1714    {
1715       gdcmErrorMacro( "Can not read tag for "
1716        << "   We should have found tag ("
1717        << DictEntry::TranslateToKey(testGroup,testElem) << ")"
1718        ) ;
1719
1720       return false;
1721    }
1722    if ( itemTagGroup != testGroup || itemTagElem != testElem )
1723    {
1724        // in order not to pollute output we don't warn on 'delimitors'
1725       if (itemTagGroup != 0xfffe ||  testGroup != 0xfffe )
1726          gdcmWarningMacro( "Wrong Item Tag found:"
1727           << "   We should have found tag ("
1728           << DictEntry::TranslateToKey(testGroup,testElem) << ")" << std::endl
1729           << "   but instead we encountered tag ("
1730           << DictEntry::TranslateToKey(itemTagGroup,itemTagElem) << ")"
1731           << "  at address: " << "  0x(" << std::hex
1732           << (unsigned int)currentPosition  << std::dec << ")"
1733           ) ;
1734       Fp->seekg(positionOnEntry, std::ios::beg);
1735
1736       return false;
1737    }
1738    return true;
1739 }
1740
1741 /**
1742  * \brief   Assuming the internal file pointer \ref Document::Fp
1743  *          is placed at the beginning of a tag (TestGroup, TestElement),
1744  *          read the length associated to the Tag.
1745  * \warning On success the internal file pointer \ref Document::Fp
1746  *          is modified to point after the tag and it's length.
1747  *          On failure (i.e. when the tag wasn't the expected tag
1748  *          (TestGroup, TestElement) the internal file pointer
1749  *          \ref Document::Fp is restored to it's original position.
1750  * @param   testGroup The expected Group   of the tag.
1751  * @param   testElem  The expected Element of the tag.
1752  * @return  On success returns the length associated to the tag. On failure
1753  *          returns 0.
1754  */
1755 uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElem)
1756 {
1757
1758    if ( !ReadTag(testGroup, testElem) )
1759    {
1760       // Avoid polutting output
1761       if ( testGroup != 0xfffe )
1762          gdcmErrorMacro( "ReadTag did not succeed for ("
1763                     << DictEntry::TranslateToKey(testGroup,testElem)
1764                     << ")..." );
1765       return 0;
1766    }
1767
1768    //// Then read the associated Item Length
1769    long currentPosition = Fp->tellg();
1770    uint32_t itemLength  = ReadInt32();
1771    gdcmDebugMacro( "Basic Item Length is: " << itemLength
1772         << "  at address: " << std::hex << (unsigned int)currentPosition);
1773    return itemLength;
1774 }
1775
1776 /**
1777  * \brief When parsing the Pixel Data of an encapsulated file, read
1778  *        the basic offset table (when present, and BTW dump it).
1779  */
1780 void File::ReadEncapsulatedBasicOffsetTable()
1781 {
1782    //// Read the Basic Offset Table Item Tag length...
1783    uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
1784
1785    // When present, read the basic offset table itself.
1786    // Notes: - since the presence of this basic offset table is optional
1787    //          we can't rely on it for the implementation, and we will simply
1788    //          trash it's content (when present).
1789    //        - still, when present, we could add some further checks on the
1790    //          lengths, but we won't bother with such fuses for the time being.
1791    if ( itemLength != 0 )
1792    {
1793       char *charBasicOffsetTableItemValue = new char[itemLength];
1794       Fp->read(charBasicOffsetTableItemValue, itemLength);
1795       unsigned int nbEntries = itemLength/4;
1796       assert( nbEntries*4 == itemLength); // Make sure this is a multiple
1797       BasicOffsetTableItemValue = new uint32_t[nbEntries];
1798
1799       for (unsigned int i=0; i < nbEntries; i++ )
1800       {
1801          BasicOffsetTableItemValue[i] = *((uint32_t*)(&charBasicOffsetTableItemValue[4*i]));
1802 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
1803          uint32_t val = BasicOffsetTableItemValue[i];
1804          BasicOffsetTableItemValue[i]
1805            = (  (val<<24)               | ((val<<8)  & 0x00ff0000) |
1806               ( (val>>8)  & 0x0000ff00) |  (val>>24)               );
1807 #endif
1808          gdcmDebugMacro( "Read one length for: " <<
1809                           std::hex << BasicOffsetTableItemValue[i] );
1810       }
1811
1812       delete[] charBasicOffsetTableItemValue;
1813    }
1814 }
1815
1816 // These are the deprecated method that one day should be removed (after the next release)
1817
1818 //#ifndef GDCM_LEGACY_REMOVE
1819 /*
1820  * \ brief   Loader. (DEPRECATED :  temporaryly kept not to break the API)
1821  * @ param   fileName file to be open for parsing
1822  * @ return false if file cannot be open or no swap info was found,
1823  *         or no tag was found.
1824  * @ deprecated Use the Load() [ + SetLoadMode() ] + SetFileName() functions instead
1825  */
1826  /*
1827 bool File::Load( std::string const &fileName )
1828 {
1829    GDCM_LEGACY_REPLACED_BODY(File::Load(std::string), "1.2",
1830                              File::Load());
1831    SetFileName( fileName );
1832    if ( ! this->Document::Load( ) )
1833       return false;
1834
1835    return DoTheLoadingJob( );
1836 }
1837 */
1838 //#endif
1839
1840 //-----------------------------------------------------------------------------
1841 // Print
1842
1843 //-----------------------------------------------------------------------------
1844 } // end namespace gdcm