src/gdcmFile.cxx

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