src/gdcmFile.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2006/06/15 14:25:26 $
   7   Version:   $Revision: 1.322 $
   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       nbValue = entry->GetValueCount();
 575       if( nbValue !=2 ) {
 576          gdcmWarningMacro("PixelAspectRatio (0x0028,0x0034) "
 577          << "has a wrong number of values :" << nbValue);
 578       }
 579       xspacing = 1.0; // We get Pixel Aspect Ratio, not Spacing ...
 580       ok = true;
 581    }
 582
 583    if (ok)
 584       return xspacing;
 585
 586 /*
 587    if (Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.1") )
 588    // Computed Radiography Image Storage
 589
 590    // CR is in Imager Pixel Spacing (0018,1164)//
 591
 592 */
 593    // go on with old method ...
 594    // ---------------------
 595    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 596
 597    entry = GetDataEntry(0x0018,0x1164);
 598    if( entry )
 599    {
 600       nbValue = entry->GetValueCount();
 601       // Can't use IsValueCountValid because of the complex heuristic.
 602       if( nbValue !=2 )
 603          gdcmWarningMacro("ImagerPixelSpacing (0x0018,0x1164) "
 604          << "has a wrong number of values :" << nbValue);
 605
 606       if( nbValue >= 3 )
 607          xspacing = (float)entry->GetValue(2);
 608       else if( nbValue >= 2 )
 609          xspacing = (float)entry->GetValue(1);
 610       else
 611          xspacing = (float)entry->GetValue(0);
 612
 613       if ( xspacing == 0.0 )
 614          xspacing = 1.0;
 615       return xspacing;
 616    }
 617    else
 618    {
 619       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 620    }
 621
 622    entry = GetDataEntry(0x0028,0x0030);
 623    if( entry )
 624    {
 625       nbValue = entry->GetValueCount();
 626       if( nbValue !=2 )
 627          gdcmWarningMacro("PixelSpacing (0x0018,0x0030) "
 628           << "has a wrong number of values :" << nbValue);
 629
 630       if( nbValue >= 3 )
 631          xspacing = (float)entry->GetValue(2);
 632       else if( nbValue >= 2 )
 633          xspacing = (float)entry->GetValue(1);
 634       else
 635          xspacing = (float)entry->GetValue(0);
 636
 637       if ( xspacing == 0.0 )
 638          xspacing = 1.0;
 639       return xspacing;
 640    }
 641    else
 642    {
 643       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 644    }
 645    return xspacing;
 646 }
 647
 648 /**
 649   * \brief gets the info from 0018,1164 : ImagerPixelSpacing
 650   *               then from   0028,0030 : Pixel Spacing
 651   *             else 1.0
 652   * @return Y dimension of a pixel
 653   */
 654 float File::GetYSpacing()
 655 {
 656    float yspacing;
 657    uint32_t nbValue;
 658    DataEntry *entry;
 659    bool ok = false;
 660
 661    std::string SOPClassUID = GetEntryString(0x0008,0x0016);
 662
 663    /// \todo check the various SOP Class
 664    ///       to get the Pixel Spacing at the proper location
 665
 666    ///\todo find images to check if it *actually* works
 667
 668    if (Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6")
 669    // Ultrasound Image Storage (Retired)
 670     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6.1")
 671    // Ultrasound Image Storage
 672     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3")
 673    // Ultrasound Multi-Frame Storage (Retired)
 674     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3.1") )
 675    // Ultrasound Multi-FrameImage Storage
 676    {
 677       // - check if  SOPClassUID contains 2 parts (e.g. "4\3")
 678       // - no way to deduce the spacing/
 679
 680       entry = GetDataEntry(0x0028,0x0034);
 681       nbValue = entry->GetValueCount();
 682       if( nbValue !=2 ) {
 683          gdcmWarningMacro("PixelAspectRatio (0x0028,0x0034) "
 684          << "has a wrong number of values :" << nbValue);
 685       }
 686       yspacing = (float)entry->GetValue(0)/(float)entry->GetValue(1);
 687       std::cout << "ys " << yspacing << std::endl;
 688       ok = true;
 689    }
 690
 691    if (ok)
 692       return yspacing;
 693
 694
 695
 696    // go on with old method ...
 697    // ---------------------
 698    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 699    yspacing = 1.0;
 700    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 701
 702    entry = GetDataEntry(0x0018,0x1164);
 703    if( entry )
 704    {
 705       yspacing = (float)entry->GetValue(0);
 706
 707       if ( yspacing == 0.0 )
 708          yspacing = 1.0;
 709       return yspacing;
 710    }
 711    else
 712    {
 713       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 714    }
 715
 716    entry = GetDataEntry(0x0028,0x0030);
 717    if( entry )
 718    {
 719       yspacing = (float)entry->GetValue(0);
 720
 721       if ( yspacing == 0.0 )
 722          yspacing = 1.0;
 723       return yspacing;
 724    }
 725    else
 726    {
 727       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 728    }
 729
 730    return yspacing;
 731 }
 732
 733 /**
 734  * \brief gets the info from 0018,0088 : Space Between Slices
 735  *                 else from 0018,0050 : Slice Thickness
 736  *                 else 1.0
 737  *
 738  * When an element is missing, we suppose slices join together
 739  * (no overlapping, no interslice gap) but we have no way to check it !
 740  * For *Dicom* images, ZSpacing *should be* calculated using
 741  * XOrigin, YOrigin, ZOrigin (of the top left image corner)
 742  * of 2 consecutive images, and the Orientation
 743  * Computing ZSpacing on a single image is not really meaningfull !
 744  * @return Z dimension of a voxel-to be
 745  */
 746 float File::GetZSpacing()
 747 {
 748
 749    float zspacing = 1.0f;
 750
 751    // Spacing Between Slices : distance between the middle of 2 slices
 752    // Slices may be :
 753    //   jointives     (Spacing between Slices = Slice Thickness)
 754    //   overlapping   (Spacing between Slices < Slice Thickness)
 755    //   disjointes    (Spacing between Slices > Slice Thickness)
 756    // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
 757    //   It only concerns the MRI guys, not people wanting to visualize volumes
 758    //   If Spacing Between Slices is missing,
 759    //   we suppose slices joint together
 760    DataEntry *entry = GetDataEntry(0x0018,0x0088);
 761    if( entry )
 762    {
 763       zspacing = (float)entry->GetValue(0);
 764
 765       if ( zspacing == 0.0 )
 766          zspacing = 1.0;
 767       return zspacing;
 768    }
 769    else
 770       gdcmWarningMacro("Unfound Spacing Between Slices (0018,0088)");
 771
 772    // if no 'Spacing Between Slices' is found,
 773    // we assume slices join together
 774    // (no overlapping, no interslice gap)
 775    entry = GetDataEntry(0x0018,0x0050);
 776    if( entry )
 777    {
 778       zspacing = (float)entry->GetValue(0);
 779
 780       if ( zspacing == 0.0 )
 781          zspacing = 1.0;
 782       return zspacing;
 783    }
 784    else
 785       gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
 786
 787    // if no 'Spacing Between Slices' is found,
 788    // we assume slices join together
 789    // (no overlapping, no interslice gap)
 790    entry = GetDataEntry(0x3004,0x000c);
 791    if( entry )
 792    {
 793       float z1 = (float)entry->GetValue(0);
 794       float z2 = (float)entry->GetValue(1);
 795       zspacing = z2 - z1; // can be negative...
 796
 797       if ( zspacing == 0.0 )
 798          zspacing = 1.0;
 799       return zspacing;
 800    }
 801
 802    return zspacing;
 803 }
 804
 805 /**
 806  * \brief gets the info from 0020,0032 : Image Position Patient
 807  *                 else from 0020,0030 : Image Position (RET)
 808  *                 else 0.
 809  * @return up-left image corner X position
 810  */
 811 float File::GetXOrigin()
 812 {
 813    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 814    if( !entry )
 815    {
 816       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 817       entry = GetDataEntry(0x0020,0x0030);
 818       if( !entry )
 819       {
 820          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 821          return 0.0f;
 822       }
 823    }
 824
 825    if( entry->GetValueCount() == 3 )
 826    {
 827       if (!entry->IsValueCountValid() )
 828       {
 829          gdcmErrorMacro( "Invalid Value Count" );
 830       }
 831       return (float)entry->GetValue(0);
 832    }
 833    return 0.0f;
 834 }
 835
 836 /**
 837  * \brief gets the info from 0020,0032 : Image Position Patient
 838  *                 else from 0020,0030 : Image Position (RET)
 839  *                 else 0.
 840  * @return up-left image corner Y position
 841  */
 842 float File::GetYOrigin()
 843 {
 844    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 845    if( !entry )
 846    {
 847       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 848       entry = GetDataEntry(0x0020,0x0030);
 849       if( !entry )
 850       {
 851          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 852          return 0.0f;
 853       }
 854    }
 855
 856    if( entry->GetValueCount() == 3 )
 857    {
 858       if (!entry->IsValueCountValid() )
 859       {
 860          gdcmErrorMacro( "Invalid Value Count" );
 861       }
 862       return (float)entry->GetValue(1);
 863    }
 864    return 0.0f;
 865 }
 866
 867 /**
 868  * \brief gets the info from 0020,0032 : Image Position Patient
 869  *                 else from 0020,0030 : Image Position (RET)
 870  *                 else from 0020,1041 : Slice Location
 871  *                 else from 0020,0050 : Location
 872  *                 else 0.
 873  * @return up-left image corner Z position
 874  */
 875 float File::GetZOrigin()
 876 {
 877    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 878    if( entry )
 879    {
 880       if( entry->GetValueCount() == 3 )
 881       {
 882          if (!entry->IsValueCountValid() )
 883          {
 884             gdcmErrorMacro( "Invalid Value Count" );
 885          }
 886          return (float)entry->GetValue(2);
 887       }
 888       gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
 889       return 0.0f;
 890    }
 891
 892    entry = GetDataEntry(0x0020,0x0030);
 893    if( entry )
 894    {
 895       if( entry->GetValueCount() == 3 )
 896       {
 897          if (!entry->IsValueCountValid() )
 898          {
 899             gdcmErrorMacro( "Invalid Value Count" );
 900          }
 901          return (float)entry->GetValue(2);
 902       }
 903       gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
 904       return 0.0f;
 905    }
 906
 907    // for *very* old ACR-NEMA images
 908    entry = GetDataEntry(0x0020,0x1041);
 909    if( entry )
 910    {
 911       if( entry->GetValueCount() == 1 )
 912       {
 913          if (!entry->IsValueCountValid() )
 914          {
 915             gdcmErrorMacro( "Invalid Value Count" );
 916          }
 917          return (float)entry->GetValue(0); // VM=1 !
 918       }
 919       gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
 920       return 0.0f;
 921    }
 922
 923    entry = GetDataEntry(0x0020,0x0050);
 924    if( entry )
 925    {
 926       if( entry->GetValueCount() == 1 )
 927       {
 928          if (!entry->IsValueCountValid() )
 929          {
 930             gdcmErrorMacro( "Invalid Value Count" );
 931          }
 932          return (float)entry->GetValue(0);
 933       }
 934       gdcmWarningMacro( "Wrong Location (0020,0050)");
 935       return 0.0f;
 936    }
 937    return 0.; // Hopeless
 938 }
 939
 940 /**
 941   * \brief gets the info from 0020,0037 : Image Orientation Patient
 942   *                   or from 0020 0035 : Image Orientation (RET)
 943   *
 944   * (needed to organize DICOM files based on their x,y,z position)
 945   *
 946   * @param iop adress of the (6)float array to receive values.
 947   *        (defaulted as 1.,0.,0.,0.,1.,0. if nothing -or inconsistent stuff-
 948   *        is found.
 949   * @return true when one of the tag -with consistent values- is found
 950   *         false when nothing or inconsistent stuff - is found
 951   */
 952 bool File::GetImageOrientationPatient( float iop[6] )
 953 {
 954    std::string strImOriPat;
 955    //iop is supposed to be float[6]
 956    iop[0] = iop[4] = 1.;
 957    iop[1] = iop[2] = iop[3] = iop[5] = 0.;
 958
 959    // 0020 0037 DS REL Image Orientation (Patient)
 960    if ( (strImOriPat = GetEntryString(0x0020,0x0037)) != GDCM_UNFOUND )
 961    {
 962       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
 963           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
 964       {
 965          gdcmWarningMacro( "Wrong Image Orientation Patient (0020,0037)."
 966                         << " Less than 6 values were found." );
 967          return false;
 968       }
 969       return true;
 970    }
 971    //For ACR-NEMA
 972    // 0020 0035 DS REL Image Orientation (RET)
 973    else if ( (strImOriPat = GetEntryString(0x0020,0x0035)) != GDCM_UNFOUND )
 974    {
 975       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
 976           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
 977       {
 978          gdcmWarningMacro( "wrong Image Orientation Patient (0020,0035). "
 979                         << "Less than 6 values were found." );
 980          return false;
 981       }
 982       return true;
 983    }
 984    return false;
 985 }
 986
 987 /**
 988  * \brief   Retrieve the number of Bits Stored (actually used)
 989  *          (as opposed to number of Bits Allocated)
 990  * @return  The encountered number of Bits Stored, 0 by default.
 991  *          0 means the file is NOT USABLE. The caller has to check it !
 992  */
 993 int File::GetBitsStored()
 994 {
 995    DataEntry *entry = GetDataEntry(0x0028,0x0101);
 996    if( !entry )
 997    {
 998       gdcmWarningMacro("BitsStored (0028,0101) is supposed to be mandatory");
 999       return 0;
1000    }
1001    return (int)entry->GetValue(0);
1002 }
1003
1004 /**
1005  * \brief   Retrieve the number of Bits Allocated
1006  *          (8, 12 -compacted ACR-NEMA files-, 16, 24 -old RGB ACR-NEMA files-,)
1007  * @return  The encountered Number of Bits Allocated, 0 by default.
1008  *          0 means the file is NOT USABLE. The caller has to check it !
1009  */
1010 int File::GetBitsAllocated()
1011 {
1012    DataEntry *entry = GetDataEntry(0x0028,0x0100);
1013    if( !entry )
1014    {
1015       gdcmWarningMacro("BitsAllocated (0028,0100) is supposed to be mandatory");
1016       return 0;
1017    }
1018    return (int)entry->GetValue(0);
1019 }
1020
1021 /**
1022  * \brief   Retrieve the high bit position.
1023  * \warning The method defaults to 0 when information is missing.
1024  *          The responsability of checking this value is left to the caller.
1025  * @return  The high bit position when present. 0 when missing.
1026  */
1027 int File::GetHighBitPosition()
1028 {
1029    DataEntry *entry = GetDataEntry(0x0028,0x0102);
1030    if( !entry )
1031    {
1032       gdcmWarningMacro("HighBitPosition (0028,0102) is supposed to be mandatory");
1033       return 0;
1034    }
1035    return (int)entry->GetValue(0);
1036 }
1037
1038 /**
1039  * \brief   Retrieve the number of Samples Per Pixel
1040  *          (1 : gray level, 3 : RGB/YBR -1 or 3 Planes-)
1041  * @return  The encountered number of Samples Per Pixel, 1 by default.
1042  *          (we assume Gray level Pixels)
1043  */
1044 int File::GetSamplesPerPixel()
1045 {
1046    DataEntry *entry = GetDataEntry(0x0028,0x0002);
1047    if( !entry )
1048    {
1049       gdcmWarningMacro("SamplesPerPixel (0028,0002) is supposed to be mandatory");
1050       return 1; // Well, it's supposed to be mandatory ...
1051                 // but sometimes it's missing : *we* assume Gray pixels
1052    }
1053    return (int)entry->GetValue(0);
1054 }
1055
1056 /**
1057  * \brief   Retrieve the Planar Configuration for RGB images
1058  *          (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
1059  * @return  The encountered Planar Configuration, 0 by default.
1060  */
1061 int File::GetPlanarConfiguration()
1062 {
1063    DataEntry *entry = GetDataEntry(0x0028,0x0006);
1064    if( !entry )
1065    {
1066       return 0;
1067    }
1068    return (int)entry->GetValue(0);
1069 }
1070
1071 /**
1072  * \brief   Return the size (in bytes) of a single pixel of data.
1073  * @return  The size in bytes of a single pixel of data; 0 by default
1074  *          0 means the file is NOT USABLE; the caller will have to check
1075  */
1076 int File::GetPixelSize()
1077 {
1078    // 0028 0100 US IMG Bits Allocated
1079    // (in order no to be messed up by old ACR-NEMA RGB images)
1080    assert( !(GetEntryString(0x0028,0x0100) == "24") );
1081
1082    std::string pixelType = GetPixelType();
1083    if ( pixelType ==  "8U" || pixelType == "8S" )
1084    {
1085       return 1;
1086    }
1087    if ( pixelType == "16U" || pixelType == "16S")
1088    {
1089       return 2;
1090    }
1091    if ( pixelType == "32U" || pixelType == "32S")
1092    {
1093       return 4;
1094    }
1095    if ( pixelType == "FD" )
1096    {
1097       return 8;
1098    }
1099    gdcmWarningMacro( "Unknown pixel type: " << pixelType);
1100    return 0;
1101 }
1102
1103 /**
1104  * \brief   Build the Pixel Type of the image.
1105  *          Possible values are:
1106  *          - 8U  unsigned  8 bit,
1107  *          - 8S    signed  8 bit,
1108  *          - 16U unsigned 16 bit,
1109  *          - 16S   signed 16 bit,
1110  *          - 32U unsigned 32 bit,
1111  *          - 32S   signed 32 bit,
1112  *          - FD floating double 64 bits (Not kosher DICOM, but so usefull!)
1113  * \warning 12 bit images appear as 16 bit.
1114  *          24 bit images appear as 8 bit + photochromatic interp ="RGB "
1115  *                                        + Planar Configuration = 0
1116  * @return  0S if nothing found. NOT USABLE file. The caller has to check
1117  */
1118 std::string File::GetPixelType()
1119 {
1120    std::string bitsAlloc = GetEntryString(0x0028, 0x0100); // Bits Allocated
1121    if ( bitsAlloc == GDCM_UNFOUND )
1122    {
1123       gdcmWarningMacro( "Bits Allocated (0028,0100) supposed to be mandatory");
1124       bitsAlloc = "16"; // default and arbitrary value, not to polute the output
1125    }
1126
1127    if ( bitsAlloc == "64" )
1128    {
1129       return "FD";
1130    }
1131    else if ( bitsAlloc == "12" )
1132    {
1133       // It will be unpacked
1134       bitsAlloc = "16";
1135    }
1136    else if ( bitsAlloc == "24" )
1137    {
1138       // (in order no to be messed up by old RGB images)
1139       bitsAlloc = "8";
1140    }
1141
1142    std::string sign;
1143    if( IsSignedPixelData() )
1144    {
1145       sign = "S";
1146    }
1147    else
1148    {
1149       sign = "U";
1150    }
1151    return bitsAlloc + sign;
1152 }
1153
1154 /**
1155  * \brief   Check whether the pixels are signed (1) or UNsigned (0) data.
1156  * \warning The method defaults to false (UNsigned) when tag 0028|0103
1157  *          is missing.
1158  *          The responsability of checking this value is left to the caller
1159  *          (NO transformation is performed on the pixels to make then >0)
1160  * @return  True when signed, false when UNsigned
1161  */
1162 bool File::IsSignedPixelData()
1163 {
1164    DataEntry *entry = GetDataEntry(0x0028, 0x0103);//"Pixel Representation"
1165    if( !entry )
1166    {
1167       gdcmWarningMacro( "Pixel Representation (0028,0103) supposed to be "
1168                       << "mandatory");
1169       return false;
1170    }
1171    return entry->GetValue(0) != 0;
1172 }
1173
1174 /**
1175  * \brief   Check whether this a monochrome picture (gray levels) or not,
1176  *          using "Photometric Interpretation" tag (0x0028,0x0004).
1177  * @return  true when "MONOCHROME1" or "MONOCHROME2". False otherwise.
1178  */
1179 bool File::IsMonochrome()
1180 {
1181    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1182    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1")
1183       || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") )
1184    {
1185       return true;
1186    }
1187    if ( PhotometricInterp == GDCM_UNFOUND )
1188    {
1189       gdcmWarningMacro( "Photometric Interpretation (0028,0004) supposed to be "
1190                          << "mandatory");
1191    }
1192    return false;
1193 }
1194
1195 /**
1196  * \brief   Check whether this a MONOCHROME1 picture (high values = dark)
1197  *            or not using "Photometric Interpretation" tag (0x0028,0x0004).
1198  * @return  true when "MONOCHROME1" . False otherwise.
1199  */
1200 bool File::IsMonochrome1()
1201 {
1202    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1203    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1") )
1204    {
1205       return true;
1206    }
1207    if ( PhotometricInterp == GDCM_UNFOUND )
1208    {
1209       gdcmWarningMacro( "Photometric Interpretation (0028,0004) : supposed to"
1210       << " be mandatory! ");
1211    }
1212    return false;
1213 }
1214
1215 /**
1216  * \brief   Check whether this a "PALETTE COLOR" picture or not by accessing
1217  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1218  * @return  true when "PALETTE COLOR". False otherwise.
1219  */
1220 bool File::IsPaletteColor()
1221 {
1222    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1223    if (   PhotometricInterp == "PALETTE COLOR " )
1224    {
1225       return true;
1226    }
1227    if ( PhotometricInterp == GDCM_UNFOUND )
1228    {
1229       gdcmDebugMacro( "Not found : Palette color (0028,0004)");
1230    }
1231    return false;
1232 }
1233
1234 /**
1235  * \brief   Check whether this a "YBR_FULL" color picture or not by accessing
1236  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1237  * @return  true when "YBR_FULL". False otherwise.
1238  */
1239 bool File::IsYBRFull()
1240 {
1241    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1242    if (   PhotometricInterp == "YBR_FULL" )
1243    {
1244       return true;
1245    }
1246    if ( PhotometricInterp == GDCM_UNFOUND )
1247    {
1248       gdcmDebugMacro( "Not found : YBR Full (0028,0004)");
1249    }
1250    return false;
1251 }
1252
1253 /**
1254   * \brief tells us if LUT are used
1255   * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data'
1256   *          are NOT considered as LUT, since nobody knows
1257   *          how to deal with them
1258   *          Please warn me if you know sbdy that *does* know ... jprx
1259   * @return true if LUT Descriptors and LUT Tables were found
1260   */
1261 bool File::HasLUT()
1262 {
1263    // Check the presence of the LUT Descriptors, and LUT Tables
1264    // LutDescriptorRed
1265    if ( !GetDocEntry(0x0028,0x1101) )
1266    {
1267       return false;
1268    }
1269    // LutDescriptorGreen
1270    if ( !GetDocEntry(0x0028,0x1102) )
1271    {
1272       return false;
1273    }
1274    // LutDescriptorBlue
1275    if ( !GetDocEntry(0x0028,0x1103) )
1276    {
1277       return false;
1278    }
1279    // Red Palette Color Lookup Table Data
1280    if ( !GetDocEntry(0x0028,0x1201) )
1281    {
1282       return false;
1283    }
1284    // Green Palette Color Lookup Table Data
1285    if ( !GetDocEntry(0x0028,0x1202) )
1286    {
1287       return false;
1288    }
1289    // Blue Palette Color Lookup Table Data
1290    if ( !GetDocEntry(0x0028,0x1203) )
1291    {
1292       return false;
1293    }
1294
1295    // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent)
1296    //         NOT taken into account, but we don't know how to use it ...
1297    return true;
1298 }
1299
1300 /**
1301   * \brief gets the info from 0028,1101 : Lookup Table Desc-Red
1302   *             else 0
1303   * @return Lookup Table number of Bits , 0 by default
1304   *          when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
1305   * @ return bit number of each LUT item
1306   */
1307 int File::GetLUTNbits()
1308 {
1309    std::vector<std::string> tokens;
1310    int lutNbits;
1311
1312    //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red
1313    //                                = Lookup Table Desc-Blue
1314    // Consistency already checked in GetLUTLength
1315    std::string lutDescription = GetEntryString(0x0028,0x1101);
1316    if ( lutDescription == GDCM_UNFOUND )
1317    {
1318       return 0;
1319    }
1320
1321    tokens.clear(); // clean any previous value
1322    Util::Tokenize ( lutDescription, tokens, "\\" );
1323    //LutLength=atoi(tokens[0].c_str());
1324    //LutDepth=atoi(tokens[1].c_str());
1325
1326    lutNbits = atoi( tokens[2].c_str() );
1327    tokens.clear();
1328
1329    return lutNbits;
1330 }
1331
1332 /**
1333  *\brief gets the info from 0028,1052 : Rescale Intercept
1334  * @return Rescale Intercept. defaulted to 0.0 is not found or empty
1335  */
1336 float File::GetRescaleIntercept()
1337 {
1338    // 0028 1052 DS IMG Rescale Intercept
1339    DataEntry *entry = GetDataEntry(0x0028, 0x1052);
1340    if( !entry )
1341    {
1342       gdcmWarningMacro( "Missing Rescale Intercept (0028,1052)");
1343       return 0.0f;
1344    }
1345    return (float)entry->GetValue(0);
1346
1347 }
1348
1349 /**
1350  *\brief   gets the info from 0028,1053 : Rescale Slope
1351  * @return Rescale Slope. defaulted to 1.0 is not found or empty
1352  */
1353 float File::GetRescaleSlope()
1354 {
1355    // 0028 1053 DS IMG Rescale Slope
1356    DataEntry *entry = GetDataEntry(0x0028, 0x1053);
1357    if( !entry )
1358    {
1359       gdcmDebugMacro( "Missing Rescale Slope (0028,1053)");
1360       return 1.0f;
1361    }
1362    return (float)entry->GetValue(0);
1363 }
1364
1365 /**
1366  * \brief This function is intended to user who doesn't want
1367  *   to have to manage a LUT and expects to get an RBG Pixel image
1368  *   (or a monochrome one, if no LUT found ...)
1369  * \warning to be used with GetImagePixels()
1370  * @return 1 if Gray level, 3 if Color (RGB, YBR, *or PALETTE COLOR*)
1371  */
1372 int File::GetNumberOfScalarComponents()
1373 {
1374    if ( GetSamplesPerPixel() == 3 )
1375    {
1376       return 3;
1377    }
1378
1379    // 0028 0100 US IMG Bits Allocated
1380    // (in order no to be messed up by old RGB images)
1381    if ( GetEntryString(0x0028,0x0100) == "24" )
1382    {
1383       return 3;
1384    }
1385
1386    std::string strPhotometricInterpretation = GetEntryString(0x0028,0x0004);
1387
1388    if ( ( strPhotometricInterpretation == "PALETTE COLOR ") )
1389    {
1390       if ( HasLUT() )// PALETTE COLOR is NOT enough
1391       {
1392          return 3;
1393       }
1394       else
1395       {
1396          return 1;
1397       }
1398    }
1399
1400    // beware of trailing space at end of string
1401    // DICOM tags are never of odd length
1402    if ( strPhotometricInterpretation == GDCM_UNFOUND   ||
1403         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") ||
1404         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") )
1405    {
1406       return 1;
1407    }
1408    else
1409    {
1410       // we assume that *all* kinds of YBR are dealt with
1411       return 3;
1412    }
1413 }
1414
1415 /**
1416  * \brief This function is intended to user that DOESN'T want
1417  *  to get RGB pixels image when it's stored as a PALETTE COLOR image
1418  *   - the (vtk) user is supposed to know how deal with LUTs -
1419  * \warning to be used with GetImagePixelsRaw()
1420  * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -)
1421  */
1422 int File::GetNumberOfScalarComponentsRaw()
1423 {
1424    // 0028 0100 US IMG Bits Allocated
1425    // (in order no to be messed up by old RGB images)
1426    if ( File::GetEntryString(0x0028,0x0100) == "24" )
1427    {
1428       return 3;
1429    }
1430
1431    // we assume that *all* kinds of YBR are dealt with
1432    return GetSamplesPerPixel();
1433 }
1434
1435 /**
1436  * \brief   Recover the offset (from the beginning of the file)
1437  *          of *image* pixels (not *icone image* pixels, if any !)
1438  * @return Pixel Offset
1439  */
1440 size_t File::GetPixelOffset()
1441 {
1442    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1443    if ( pxlElement )
1444    {
1445       return pxlElement->GetOffset();
1446    }
1447    else
1448    {
1449       gdcmWarningMacro( "Big trouble : Pixel Element ("
1450                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1451       return 0;
1452    }
1453 }
1454
1455 /**
1456  * \brief   Recover the pixel area length (in Bytes)
1457  * @return Pixel Element Length, as stored in the header
1458  *         (NOT the memory space necessary to hold the Pixels
1459  *          -in case of embeded compressed image-)
1460  *         0 : NOT USABLE file. The caller has to check.
1461  */
1462 size_t File::GetPixelAreaLength()
1463 {
1464    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1465    if ( pxlElement )
1466    {
1467       return pxlElement->GetLength();
1468    }
1469    else
1470    {
1471       gdcmWarningMacro( "Big trouble : Pixel Element ("
1472                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1473       return 0;
1474    }
1475 }
1476
1477 /**
1478  * \brief Adds the characteristics of a new element we want to anonymize
1479  * @param   group  Group number of the target tag.
1480  * @param   elem Element number of the target tag.
1481  * @param   value new value (string) to substitute with
1482  */
1483 void File::AddAnonymizeElement (uint16_t group, uint16_t elem,
1484                                 std::string const &value)
1485 {
1486    DicomElement el;
1487    el.Group = group;
1488    el.Elem  = elem;
1489    el.Value = value;
1490    UserAnonymizeList.push_back(el);
1491 }
1492
1493 /**
1494  * \brief Overwrites in the file the values of the DicomElements
1495  *       held in the list
1496  */
1497 void File::AnonymizeNoLoad()
1498 {
1499    std::fstream *fp = new std::fstream(Filename.c_str(),
1500                               std::ios::in | std::ios::out | std::ios::binary);
1501    gdcm::DocEntry *d;
1502    uint32_t offset;
1503    uint32_t lgth;
1504    uint32_t valLgth = 0;
1505    std::string *spaces;
1506    for (ListElements::iterator it = UserAnonymizeList.begin();
1507                                it != UserAnonymizeList.end();
1508                              ++it)
1509    {
1510
1511       //std::cout << "File::AnonymizeNoLoad -------" << std::hex <<(*it).Group <<"|"<<
1512       //         (*it).Elem
1513       //         << "[" << (*it).Value << "] "<< std::dec << std::endl;
1514       d = GetDocEntry( (*it).Group, (*it).Elem);
1515
1516       if ( d == NULL)
1517          continue;
1518
1519       if ( dynamic_cast<SeqEntry *>(d) )
1520       {
1521          gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1522          continue;
1523       }
1524
1525       valLgth = (*it).Value.size();
1526       if (valLgth == 0)
1527          continue;
1528
1529       offset = d->GetOffset();
1530       lgth =   d->GetLength();
1531
1532       //std::cout << "lgth " << lgth << " valLgth " << valLgth << std::endl;
1533       if (valLgth < lgth)
1534       {
1535          spaces = new std::string( lgth-valLgth, ' ');
1536          (*it).Value = (*it).Value + *spaces;
1537          //std::cout << "[" << (*it).Value << "] " << lgth << std::endl;
1538          delete spaces;
1539       }
1540       fp->seekp( offset, std::ios::beg );
1541       fp->write( (*it).Value.c_str(), lgth );
1542
1543    }
1544    fp->close();
1545    delete fp;
1546 }
1547
1548 /**
1549  * \brief anonymize a File (remove Patient's personal info passed with
1550  *        AddAnonymizeElement()
1551  * \note You cannot Anonymize a DataEntry (to be fixed)
1552  */
1553 bool File::AnonymizeFile()
1554 {
1555    // If Anonymisation list is empty, let's perform some basic anonymization
1556    if ( UserAnonymizeList.begin() == UserAnonymizeList.end() )
1557    {
1558       // If exist, replace by spaces
1559       SetEntryString("  ",0x0010, 0x2154); // Telephone
1560       SetEntryString("  ",0x0010, 0x1040); // Adress
1561       SetEntryString("  ",0x0010, 0x0020); // Patient ID
1562
1563       DocEntry *patientNameHE = GetDocEntry (0x0010, 0x0010);
1564
1565       if ( patientNameHE ) // we replace it by Study Instance UID (why not ?)
1566       {
1567          std::string studyInstanceUID =  GetEntryString (0x0020, 0x000d);
1568          if ( studyInstanceUID != GDCM_UNFOUND )
1569          {
1570             SetEntryString(studyInstanceUID, 0x0010, 0x0010);
1571          }
1572          else
1573          {
1574             SetEntryString("anonymized", 0x0010, 0x0010);
1575          }
1576       }
1577    }
1578    else
1579    {
1580       gdcm::DocEntry *d;
1581       for (ListElements::iterator it = UserAnonymizeList.begin();
1582                                   it != UserAnonymizeList.end();
1583                                 ++it)
1584       {
1585          d = GetDocEntry( (*it).Group, (*it).Elem);
1586
1587          if ( d == NULL)
1588             continue;
1589
1590          if ( dynamic_cast<SeqEntry *>(d) )
1591          {
1592             gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1593             continue;
1594          }
1595
1596          if ( dynamic_cast<DataEntry *>(d) )
1597          {
1598             gdcmWarningMacro( "To 'Anonymize' a DataEntry, better use AnonymizeNoLoad (FIXME) ");
1599             continue;
1600          }
1601          else
1602             SetEntryString ((*it).Value, (*it).Group, (*it).Elem);
1603       }
1604 }
1605
1606   // In order to make definitively impossible any further identification
1607   // remove or replace all the stuff that contains a Date
1608
1609 //0008 0012 DA ID Instance Creation Date
1610 //0008 0020 DA ID Study Date
1611 //0008 0021 DA ID Series Date
1612 //0008 0022 DA ID Acquisition Date
1613 //0008 0023 DA ID Content Date
1614 //0008 0024 DA ID Overlay Date
1615 //0008 0025 DA ID Curve Date
1616 //0008 002a DT ID Acquisition Datetime
1617 //0018 9074 DT ACQ Frame Acquisition Datetime
1618 //0018 9151 DT ACQ Frame Reference Datetime
1619 //0018 a002 DT ACQ Contribution Date Time
1620 //0020 3403 SH REL Modified Image Date (RET)
1621 //0032 0032 DA SDY Study Verified Date
1622 //0032 0034 DA SDY Study Read Date
1623 //0032 1000 DA SDY Scheduled Study Start Date
1624 //0032 1010 DA SDY Scheduled Study Stop Date
1625 //0032 1040 DA SDY Study Arrival Date
1626 //0032 1050 DA SDY Study Completion Date
1627 //0038 001a DA VIS Scheduled Admission Date
1628 //0038 001c DA VIS Scheduled Discharge Date
1629 //0038 0020 DA VIS Admitting Date
1630 //0038 0030 DA VIS Discharge Date
1631 //0040 0002 DA PRC Scheduled Procedure Step Start Date
1632 //0040 0004 DA PRC Scheduled Procedure Step End Date
1633 //0040 0244 DA PRC Performed Procedure Step Start Date
1634 //0040 0250 DA PRC Performed Procedure Step End Date
1635 //0040 2004 DA PRC Issue Date of Imaging Service Request
1636 //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
1637 //0040 4011 DT PRC Expected Completion Date and Time
1638 //0040 a030 DT PRC Verification Date Time
1639 //0040 a032 DT PRC Observation Date Time
1640 //0040 a120 DT PRC DateTime
1641 //0040 a121 DA PRC Date
1642 //0040 a13a DT PRC Referenced Datetime
1643 //0070 0082 DA ??? Presentation Creation Date
1644 //0100 0420 DT ??? SOP Autorization Date and Time
1645 //0400 0105 DT ??? Digital Signature DateTime
1646 //2100 0040 DA PJ Creation Date
1647 //3006 0008 DA SSET Structure Set Date
1648 //3008 0024 DA ??? Treatment Control Point Date
1649 //3008 0054 DA ??? First Treatment Date
1650 //3008 0056 DA ??? Most Recent Treatment Date
1651 //3008 0162 DA ??? Safe Position Exit Date
1652 //3008 0166 DA ??? Safe Position Return Date
1653 //3008 0250 DA ??? Treatment Date
1654 //300a 0006 DA RT RT Plan Date
1655 //300a 022c DA RT Air Kerma Rate Reference Date
1656 //300e 0004 DA RT Review Date
1657
1658    return true;
1659 }
1660
1661 /**
1662  * \brief Performs some consistency checking on various 'File related'
1663  *       (as opposed to 'DicomDir related') entries
1664  *       then writes in a file all the (Dicom Elements) included the Pixels
1665  * @param fileName file name to write to
1666  * @param writetype type of the file to be written
1667  *          (ACR, ExplicitVR, ImplicitVR)
1668  */
1669 bool File::Write(std::string fileName, FileType writetype)
1670 {
1671    std::ofstream *fp = new std::ofstream(fileName.c_str(),
1672                                          std::ios::out | std::ios::binary);
1673    if (*fp == NULL)
1674    {
1675       gdcmWarningMacro("Failed to open (write) File: " << fileName.c_str());
1676       return false;
1677    }
1678
1679    // Entry : 0002|0000 = group length -> recalculated
1680    DataEntry *e0000 = GetDataEntry(0x0002,0x0000);
1681    if ( e0000 )
1682    {
1683       std::ostringstream sLen;
1684       sLen << ComputeGroup0002Length( );
1685       e0000->SetString(sLen.str());
1686    }
1687
1688    /// \todo FIXME : Derma?.dcm does not have it...let's remove it ?!? JPRx
1689    if( writetype != JPEG )
1690    {
1691       int i_lgPix = GetEntryLength(GrPixel, NumPixel);
1692       if (i_lgPix != -2)
1693       {
1694          // no (GrPixel, NumPixel) element
1695          std::string s_lgPix = Util::Format("%d", i_lgPix+12);
1696          s_lgPix = Util::DicomString( s_lgPix.c_str() );
1697          InsertEntryString(s_lgPix,GrPixel, 0x0000, "UL");
1698       }
1699    }
1700    Document::WriteContent(fp, writetype);
1701
1702    fp->close();
1703    delete fp;
1704
1705    return true;
1706 }
1707
1708 //-----------------------------------------------------------------------------
1709 // Protected
1710
1711
1712 //-----------------------------------------------------------------------------
1713 // Private
1714 /**
1715  * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
1716  *        Compute the RLE extra information and store it in \ref RLEInfo
1717  *        for later pixel retrieval usage.
1718  */
1719 void File::ComputeRLEInfo()
1720 {
1721    std::string ts = GetTransferSyntax();
1722    if ( !Global::GetTS()->IsRLELossless(ts) )
1723    {
1724       return;
1725    }
1726
1727    // Encoded pixel data: for the time being we are only concerned with
1728    // Jpeg or RLE Pixel data encodings.
1729    // As stated in PS 3.5-2003, section 8.2 p44:
1730    // "If sent in Encapsulated Format (i.e. other than the Native Format) the
1731    //  value representation OB is used".
1732    // Hence we expect an OB value representation. Concerning OB VR,
1733    // the section PS 3.5-2003, section A.4.c p 58-59, states:
1734    // "For the Value Representations OB and OW, the encoding shall meet the
1735    //   following specifications depending on the Data element tag:"
1736    //   [...snip...]
1737    //    - the first item in the sequence of items before the encoded pixel
1738    //      data stream shall be basic offset table item. The basic offset table
1739    //      item value, however, is not required to be present"
1740    ReadEncapsulatedBasicOffsetTable();
1741
1742    // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
1743    // Loop on the individual frame[s] and store the information
1744    // on the RLE fragments in a RLEFramesInfo.
1745    // Note: - when only a single frame is present, this is a
1746    //         classical image.
1747    //       - when more than one frame are present, then we are in
1748    //         the case of a multi-frame image.
1749    long frameLength;
1750    int i=0;
1751    uint32_t sum = 0;
1752    while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
1753    {
1754       // Since we have read the basic offset table, let's check the value were correct
1755       // or else produce a warning:
1756       if ( BasicOffsetTableItemValue )
1757         {
1758         // If a BasicOffsetTableItemValue was read
1759         uint32_t individualLength = BasicOffsetTableItemValue[i];
1760         assert( individualLength == sum ); // REMOVE that if this is a problem
1761         if( individualLength != sum )
1762           {
1763           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght" );
1764           }
1765         sum += frameLength + 8;
1766         i++;
1767         }
1768       // Parse the RLE Header and store the corresponding RLE Segment
1769       // Offset Table information on fragments of this current Frame.
1770       // Note that the fragment pixels themselves are not loaded
1771       // (but just skipped).
1772       long frameOffset = Fp->tellg(); // once per fragment
1773
1774       uint32_t nbRleSegments = ReadInt32();
1775       if ( nbRleSegments > 16 )
1776       {
1777          // There should be at most 15 segments (refer to RLEFrame class)
1778          gdcmWarningMacro( "Too many segments.");
1779       }
1780
1781       uint32_t rleSegmentOffsetTable[16];
1782       for( int k = 1; k <= 15; k++ )
1783       {
1784          rleSegmentOffsetTable[k] = ReadInt32();
1785       }
1786
1787       // Deduce from both RLE Header and frameLength
1788       // the fragment length, and again store this info
1789       // in a RLEFramesInfo.
1790       long rleSegmentLength[15];
1791       // skipping (not reading) RLE Segments
1792       if ( nbRleSegments > 1)
1793       {
1794          for(unsigned int k = 1; k <= nbRleSegments-1; k++)
1795          {
1796              rleSegmentLength[k] =  rleSegmentOffsetTable[k+1]
1797                                   - rleSegmentOffsetTable[k];
1798              SkipBytes(rleSegmentLength[k]);
1799           }
1800        }
1801
1802        rleSegmentLength[nbRleSegments] = frameLength
1803                                       - rleSegmentOffsetTable[nbRleSegments];
1804        SkipBytes(rleSegmentLength[nbRleSegments]);
1805
1806        // Store the collected info
1807        RLEFrame *newFrame = new RLEFrame;
1808        newFrame->SetNumberOfFragments(nbRleSegments);
1809        for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
1810        {
1811           newFrame->SetOffset(uk,frameOffset + rleSegmentOffsetTable[uk]);
1812           newFrame->SetLength(uk,rleSegmentLength[uk]);
1813        }
1814        RLEInfo->AddFrame(newFrame);
1815    }
1816
1817    // Make sure that  we encounter a 'Sequence Delimiter Item'
1818    // at the end of the item :
1819    if ( !ReadTag(0xfffe, 0xe0dd) ) // once per RLE File
1820    {
1821       gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
1822    }
1823 }
1824
1825 /**
1826  * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
1827  *        Compute the jpeg extra information (fragment[s] offset[s] and
1828  *        length) and store it[them] in \ref JPEGInfo for later pixel
1829  *        retrieval usage.
1830  */
1831 void File::ComputeJPEGFragmentInfo()
1832 {
1833    // If you need to, look for comments of ComputeRLEInfo().
1834    std::string ts = GetTransferSyntax();
1835    if ( ! Global::GetTS()->IsJPEG(ts) )
1836    {
1837       return;
1838    }
1839
1840    ReadEncapsulatedBasicOffsetTable();
1841
1842    // Loop on the fragments[s] and store the parsed information in a
1843    // JPEGInfo.
1844    long fragmentLength;
1845    int i=0;
1846    uint32_t sum = 0;
1847    while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
1848    {
1849       // Since we have read the basic offset table, let's check the value were correct
1850       // or else produce a warning:
1851       // A.4 Transfer syntaxes for encapsulation of encoded pixel data:
1852       // When the Item Value is present, the Basic Offset Table Item Value shall contain
1853       // concatenated 32-bit unsigned integer values that are byte offsets to the first
1854       // byte of the Item Tag of the first fragment for each frame in the Sequence of
1855       // Items. These offsets are measured from the first byte of the first Item Tag
1856       // following the Basic Offset Table item (See Table A.4-2).
1857
1858       if ( BasicOffsetTableItemValue )
1859         {
1860         // If a BasicOffsetTableItemValue was read
1861         uint32_t individualLength = BasicOffsetTableItemValue[i];
1862         //assert( individualLength == sum ); // Seems like 00191113.dcm is off by one ??
1863         if( individualLength != sum )
1864           {
1865           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght:" <<
1866               individualLength << " != " << sum );
1867           }
1868         sum += fragmentLength + 8;
1869         i++;
1870         }
1871
1872       long fragmentOffset = Fp->tellg(); // Once per fragment
1873       // Store the collected info
1874       JPEGFragment *newFragment = new JPEGFragment;
1875       newFragment->SetOffset(fragmentOffset);
1876       newFragment->SetLength(fragmentLength);
1877       JPEGInfo->AddFragment(newFragment);
1878
1879       SkipBytes(fragmentLength);
1880    }
1881
1882    // Make sure that  we encounter a 'Sequence Delimiter Item'
1883    // at the end of the item :
1884    if ( !ReadTag(0xfffe, 0xe0dd) )
1885    {
1886       gdcmWarningMacro( "No sequence delimiter item at end of JPEG item sequence");
1887    }
1888 }
1889
1890 /**
1891  * \brief   Assuming the internal file pointer \ref Document::Fp
1892  *          is placed at the beginning of a tag, check whether this
1893  *          tag is (TestGroup, TestElem).
1894  * \warning On success the internal file pointer \ref Document::Fp
1895  *          is modified to point after the tag.
1896  *          On failure (i.e. when the tag wasn't the expected tag
1897  *          (TestGroup, TestElem) the internal file pointer
1898  *          \ref Document::Fp is restored to it's original position.
1899  * @param   testGroup The expected group   of the tag.
1900  * @param   testElem  The expected Element of the tag.
1901  * @return  True on success, false otherwise.
1902  */
1903 bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
1904 {
1905    long positionOnEntry = Fp->tellg(); // Only when reading fragments
1906    //long currentPosition = positionOnEntry;      // On debugging purposes
1907
1908    // Read the Item Tag group and element, and make
1909    // sure they are what we expected:
1910    uint16_t itemTagGroup;
1911    uint16_t itemTagElem;
1912    try
1913    {
1914       itemTagGroup = ReadInt16();
1915       itemTagElem  = ReadInt16();
1916    }
1917    catch ( FormatError )
1918    {
1919       gdcmErrorMacro( "Can not read tag for "
1920        << "   We should have found tag ("
1921        << DictEntry::TranslateToKey(testGroup,testElem) << ")"
1922        ) ;
1923
1924       return false;
1925    }
1926    if ( itemTagGroup != testGroup || itemTagElem != testElem )
1927    {
1928        // in order not to pollute output we don't warn on 'delimitors'
1929       if (itemTagGroup != 0xfffe ||  testGroup != 0xfffe )
1930          gdcmWarningMacro( "Wrong Item Tag found:"
1931           << "   We should have found tag ("
1932           << DictEntry::TranslateToKey(testGroup,testElem) << ")" << std::endl
1933           << "   but instead we encountered tag ("
1934           << DictEntry::TranslateToKey(itemTagGroup,itemTagElem) << ")"
1935           << "  at address: " << "  0x(" << std::hex
1936           << (unsigned int)positionOnEntry  << std::dec << ")"
1937           ) ;
1938       Fp->seekg(positionOnEntry, std::ios::beg);
1939
1940       return false;
1941    }
1942    return true;
1943 }
1944
1945 /**
1946  * \brief   Assuming the internal file pointer \ref Document::Fp
1947  *          is placed at the beginning of a tag (TestGroup, TestElement),
1948  *          read the length associated to the Tag.
1949  * \warning On success the internal file pointer \ref Document::Fp
1950  *          is modified to point after the tag and it's length.
1951  *          On failure (i.e. when the tag wasn't the expected tag
1952  *          (TestGroup, TestElement) the internal file pointer
1953  *          \ref Document::Fp is restored to it's original position.
1954  * @param   testGroup The expected Group   of the tag.
1955  * @param   testElem  The expected Element of the tag.
1956  * @return  On success returns the length associated to the tag. On failure
1957  *          returns 0.
1958  */
1959 uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElem)
1960 {
1961
1962    if ( !ReadTag(testGroup, testElem) )
1963    {
1964       // Avoid polutting output
1965       if ( testGroup != 0xfffe )
1966          gdcmErrorMacro( "ReadTag did not succeed for ("
1967                     << DictEntry::TranslateToKey(testGroup,testElem)
1968                     << ")..." );
1969       return 0;
1970    }
1971
1972    //// Then read the associated Item Length
1973
1974    // long currentPosition = Fp->tellg(); // save time // JPRx
1975    uint32_t itemLength  = ReadInt32();
1976    gdcmDebugMacro( "Basic Item Length is: " << itemLength
1977 //        << "  at address: " << std::hex << (unsigned int)currentPosition
1978    );
1979    return itemLength;
1980 }
1981
1982 /**
1983  * \brief When parsing the Pixel Data of an encapsulated file, read
1984  *        the basic offset table (when present, and BTW dump it).
1985  */
1986 void File::ReadEncapsulatedBasicOffsetTable()
1987 {
1988    //// Read the Basic Offset Table Item Tag length...
1989    uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
1990
1991    // When present, read the basic offset table itself.
1992    // Notes: - since the presence of this basic offset table is optional
1993    //          we can't rely on it for the implementation, and we will simply
1994    //          trash it's content (when present).
1995    //        - still, when present, we could add some further checks on the
1996    //          lengths, but we won't bother with such fuses for the time being.
1997    if ( itemLength != 0 )
1998    {
1999       char *charBasicOffsetTableItemValue = new char[itemLength];
2000       Fp->read(charBasicOffsetTableItemValue, itemLength);
2001       unsigned int nbEntries = itemLength/4;
2002       assert( nbEntries*4 == itemLength); // Make sure this is a multiple
2003       BasicOffsetTableItemValue = new uint32_t[nbEntries];
2004
2005       for (unsigned int i=0; i < nbEntries; i++ )
2006       {
2007          BasicOffsetTableItemValue[i] = *((uint32_t*)(&charBasicOffsetTableItemValue[4*i]));
2008 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
2009          uint32_t val = BasicOffsetTableItemValue[i];
2010          BasicOffsetTableItemValue[i]
2011            = (  (val<<24)               | ((val<<8)  & 0x00ff0000) |
2012               ( (val>>8)  & 0x0000ff00) |  (val>>24)               );
2013 #endif
2014          gdcmDebugMacro( "Read one length for: " <<
2015                           std::hex << BasicOffsetTableItemValue[i] );
2016       }
2017
2018       delete[] charBasicOffsetTableItemValue;
2019    }
2020 }
2021
2022 // These are the deprecated method that one day should be removed (after the next release)
2023
2024 //#ifndef GDCM_LEGACY_REMOVE
2025 /*
2026  * \ brief   Loader. (DEPRECATED :  temporaryly kept not to break the API)
2027  * @ param   fileName file to be open for parsing
2028  * @ return false if file cannot be open or no swap info was found,
2029  *         or no tag was found.
2030  * @deprecated Use the Load() [ + SetLoadMode() ] + SetFileName() functions instead
2031  */
2032  /*
2033 bool File::Load( std::string const &fileName )
2034 {
2035    GDCM_LEGACY_REPLACED_BODY(File::Load(std::string), "1.2",
2036                              File::Load());
2037    SetFileName( fileName );
2038    if ( ! this->Document::Load( ) )
2039       return false;
2040
2041    return DoTheLoadingJob( );
2042 }
2043 #endif
2044 */
2045 //-----------------------------------------------------------------------------
2046 // Print
2047
2048 //-----------------------------------------------------------------------------
2049 } // end namespace gdcm