src/gdcmFile.cxx

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