src/gdcmFile.cxx

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