src/gdcmFile.cxx

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