src/gdcmHeader.cxx

   1
   2 // $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.cxx,v 1.74 2003/07/01 15:48:27 jpr Exp $
   3
   4 #include <stdio.h>
   5 #include <cerrno>
   6 // For nthos:
   7 #ifdef _MSC_VER
   8 #include <winsock.h>
   9 #else
  10 #include <netinet/in.h>
  11 #endif
  12 #include <cctype>    // for isalpha
  13 #include <sstream>
  14 #include "gdcmUtil.h"
  15 #include "gdcmHeader.h"
  16 using namespace std;
  17
  18
  19 // TODO : remove DEBUG
  20 #define DEBUG 0
  21
  22 // Refer to gdcmHeader::CheckSwap()
  23 #define HEADER_LENGTH_TO_READ       256
  24 // Refer to gdcmHeader::SetMaxSizeLoadElementValue()
  25 #define _MaxSizeLoadElementValue_   1024
  26
  27 /**
  28  * \ingroup gdcmHeader
  29  * \brief
  30  */
  31 void gdcmHeader::Initialise(void) {
  32    dicom_vr = gdcmGlobal::GetVR();
  33    dicom_ts = gdcmGlobal::GetTS();
  34    Dicts =    gdcmGlobal::GetDicts();
  35    RefPubDict = Dicts->GetDefaultPubDict();
  36    RefShaDict = (gdcmDict*)0;
  37 }
  38
  39 /**
  40  * \ingroup gdcmHeader
  41  * \brief
  42  * @param   InFilename
  43  * @param   exception_on_error
  44  */
  45  gdcmHeader::gdcmHeader(const char *InFilename, bool exception_on_error) {
  46   SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_);
  47   filename = InFilename;
  48   Initialise();
  49   if ( !OpenFile(exception_on_error))
  50      return;
  51   ParseHeader();
  52   LoadElements();
  53   CloseFile();
  54 }
  55
  56 /**
  57  * \ingroup gdcmHeader
  58  * \brief
  59  * @param   exception_on_error
  60  */
  61 gdcmHeader::gdcmHeader(bool exception_on_error) {
  62   SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_);
  63   Initialise();
  64 }
  65
  66 /**
  67  * \ingroup gdcmHeader
  68  * \brief
  69  * @param   exception_on_error
  70  * @return
  71  */
  72  bool gdcmHeader::OpenFile(bool exception_on_error)
  73   throw(gdcmFileError) {
  74   fp=fopen(filename.c_str(),"rb");
  75   if(exception_on_error) {
  76     if(!fp)
  77       throw gdcmFileError("gdcmHeader::gdcmHeader(const char *, bool)");
  78   }
  79   if ( fp )
  80      return true;
  81   dbg.Verbose(0, "gdcmHeader::gdcmHeader cannot open file", filename.c_str());
  82   return false;
  83 }
  84
  85 /**
  86  * \ingroup gdcmHeader
  87  * \brief
  88  * @return
  89  */
  90 bool gdcmHeader::CloseFile(void) {
  91   int closed = fclose(fp);
  92   fp = (FILE *)0;
  93   if (! closed)
  94      return false;
  95   return true;
  96 }
  97
  98 /**
  99  * \ingroup gdcmHeader
 100  * \brief   Canonical destructor.
 101  */
 102 gdcmHeader::~gdcmHeader (void) {
 103    dicom_vr =   (gdcmVR*)0;
 104    Dicts    =   (gdcmDictSet*)0;
 105    RefPubDict = (gdcmDict*)0;
 106    RefShaDict = (gdcmDict*)0;
 107    return;
 108 }
 109
 110 // Fourth semantics:
 111 // CMD      Command
 112 // META     Meta Information
 113 // DIR      Directory
 114 // ID
 115 // PAT      Patient
 116 // ACQ      Acquisition
 117 // REL      Related
 118 // IMG      Image
 119 // SDY      Study
 120 // VIS      Visit
 121 // WAV      Waveform
 122 // PRC
 123 // DEV      Device
 124 // NMI      Nuclear Medicine
 125 // MED
 126 // BFS      Basic Film Session
 127 // BFB      Basic Film Box
 128 // BIB      Basic Image Box
 129 // BAB
 130 // IOB
 131 // PJ
 132 // PRINTER
 133 // RT       Radio Therapy
 134 // DVH
 135 // SSET
 136 // RES      Results
 137 // CRV      Curve
 138 // OLY      Overlays
 139 // PXL      Pixels
 140 //
 141
 142 /**
 143  * \ingroup gdcmHeader
 144  * \brief   Discover what the swap code is (among little endian, big endian,
 145  *          bad little endian, bad big endian).
 146  *
 147  */
 148 void gdcmHeader::CheckSwap()
 149 {
 150    // The only guaranted way of finding the swap code is to find a
 151    // group tag since we know it's length has to be of four bytes i.e.
 152    // 0x00000004. Finding the swap code in then straigthforward. Trouble
 153    // occurs when we can't find such group...
 154    guint32  s;
 155    guint32  x=4;  // x : pour ntohs
 156    bool net2host; // true when HostByteOrder is the same as NetworkByteOrder
 157
 158    int lgrLue;
 159    char * entCur;
 160    char deb[HEADER_LENGTH_TO_READ];
 161
 162    // First, compare HostByteOrder and NetworkByteOrder in order to
 163    // determine if we shall need to swap bytes (i.e. the Endian type).
 164    if (x==ntohs(x))
 165       net2host = true;
 166    else
 167       net2host = false;
 168
 169    // The easiest case is the one of a DICOM header, since it possesses a
 170    // file preamble where it suffice to look for the string "DICM".
 171    lgrLue = fread(deb, 1, HEADER_LENGTH_TO_READ, fp);
 172
 173    entCur = deb + 128;
 174    if(memcmp(entCur, "DICM", (size_t)4) == 0) {
 175       dbg.Verbose(1, "gdcmHeader::CheckSwap:", "looks like DICOM Version3");
 176       // Next, determine the value representation (VR). Let's skip to the
 177       // first element (0002, 0000) and check there if we find "UL"
 178       // - or "OB" if the 1st one is (0002,0001) -,
 179       // in which case we (almost) know it is explicit VR.
 180       // WARNING: if it happens to be implicit VR then what we will read
 181       // is the length of the group. If this ascii representation of this
 182       // length happens to be "UL" then we shall believe it is explicit VR.
 183       // FIXME: in order to fix the above warning, we could read the next
 184       // element value (or a couple of elements values) in order to make
 185       // sure we are not commiting a big mistake.
 186       // We need to skip :
 187       // * the 128 bytes of File Preamble (often padded with zeroes),
 188       // * the 4 bytes of "DICM" string,
 189       // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
 190       // i.e. a total of  136 bytes.
 191       entCur = deb + 136;
 192       // FIXME
 193       // Use gdcmHeader::dicom_vr to test all the possibilities
 194       // instead of just checking for UL, OB and UI !?
 195       if(  (memcmp(entCur, "UL", (size_t)2) == 0) ||
 196           (memcmp(entCur, "OB", (size_t)2) == 0) ||
 197           (memcmp(entCur, "UI", (size_t)2) == 0) )
 198         {
 199          filetype = ExplicitVR;
 200          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
 201                      "explicit Value Representation");
 202       } else {
 203          filetype = ImplicitVR;
 204          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
 205                      "not an explicit Value Representation");
 206       }
 207
 208       if (net2host) {
 209          sw = 4321;
 210          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
 211                         "HostByteOrder != NetworkByteOrder");
 212       } else {
 213          sw = 0;
 214          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
 215                         "HostByteOrder = NetworkByteOrder");
 216       }
 217
 218       // Position the file position indicator at first tag (i.e.
 219       // after the file preamble and the "DICM" string).
 220       rewind(fp);
 221       fseek (fp, 132L, SEEK_SET);
 222       return;
 223    } // End of DicomV3
 224
 225    // Alas, this is not a DicomV3 file and whatever happens there is no file
 226    // preamble. We can reset the file position indicator to where the data
 227    // is (i.e. the beginning of the file).
 228     dbg.Verbose(1, "gdcmHeader::CheckSwap:", "not a DICOM Version3 file");
 229    rewind(fp);
 230
 231    // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
 232    // By clean we mean that the length of the first tag is written down.
 233    // If this is the case and since the length of the first group HAS to be
 234    // four (bytes), then determining the proper swap code is straightforward.
 235
 236    entCur = deb + 4;
 237    // We assume the array of char we are considering contains the binary
 238    // representation of a 32 bits integer. Hence the following dirty
 239    // trick :
 240    s = *((guint32 *)(entCur));
 241
 242    switch (s) {
 243    case 0x00040000 :
 244       sw = 3412;
 245       filetype = ACR;
 246       return;
 247    case 0x04000000 :
 248       sw = 4321;
 249       filetype = ACR;
 250       return;
 251    case 0x00000400 :
 252       sw = 2143;
 253       filetype = ACR;
 254       return;
 255    case 0x00000004 :
 256       sw = 0;
 257       filetype = ACR;
 258       return;
 259    default :
 260       dbg.Verbose(0, "gdcmHeader::CheckSwap:",
 261                      "ACR/NEMA unfound swap info (time to raise bets)");
 262    }
 263
 264    // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
 265    // It is time for despaired wild guesses. So, let's assume this file
 266    // happens to be 'dirty' ACR/NEMA, i.e. the length of the group is
 267    // not present. Then the only info we have is the net2host one.
 268    filetype = Unknown;
 269    if (! net2host )
 270       sw = 0;
 271    else
 272       sw = 4321;
 273    return;
 274 }
 275
 276 /**
 277  * \ingroup gdcmHeader
 278  * \brief
 279  */
 280 void gdcmHeader::SwitchSwapToBigEndian(void) {
 281    dbg.Verbose(1, "gdcmHeader::SwitchSwapToBigEndian",
 282                   "Switching to BigEndian mode.");
 283    if ( sw == 0    ) {
 284       sw = 4321;
 285       return;
 286    }
 287    if ( sw == 4321 ) {
 288       sw = 0;
 289       return;
 290    }
 291    if ( sw == 3412 ) {
 292       sw = 2143;
 293       return;
 294    }
 295    if ( sw == 2143 )
 296       sw = 3412;
 297 }
 298
 299 /**
 300  * \ingroup   gdcmHeader
 301  * \brief     Find the value representation of the current tag.
 302  */
 303 void gdcmHeader::FindVR( gdcmElValue *ElVal) {
 304    if (filetype != ExplicitVR)
 305       return;
 306
 307    char VR[3];
 308    string vr;
 309    int lgrLue;
 310    char msg[100]; // for sprintf. Sorry
 311
 312    long PositionOnEntry = ftell(fp);
 313    // Warning: we believe this is explicit VR (Value Representation) because
 314    // we used a heuristic that found "UL" in the first tag. Alas this
 315    // doesn't guarantee that all the tags will be in explicit VR. In some
 316    // cases (see e-film filtered files) one finds implicit VR tags mixed
 317    // within an explicit VR file. Hence we make sure the present tag
 318    // is in explicit VR and try to fix things if it happens not to be
 319    // the case.
 320    bool RealExplicit = true;
 321
 322    lgrLue=fread (&VR, (size_t)2,(size_t)1, fp);
 323    VR[2]=0;
 324    vr = string(VR);
 325
 326    // Assume we are reading a falsely explicit VR file i.e. we reached
 327    // a tag where we expect reading a VR but are in fact we read the
 328    // first to bytes of the length. Then we will interogate (through find)
 329    // the dicom_vr dictionary with oddities like "\004\0" which crashes
 330    // both GCC and VC++ implementations of the STL map. Hence when the
 331    // expected VR read happens to be non-ascii characters we consider
 332    // we hit falsely explicit VR tag.
 333
 334    if ( (!isalpha(VR[0])) && (!isalpha(VR[1])) )
 335       RealExplicit = false;
 336
 337    // CLEANME searching the dicom_vr at each occurence is expensive.
 338    // PostPone this test in an optional integrity check at the end
 339    // of parsing or only in debug mode.
 340    if ( RealExplicit && !dicom_vr->Count(vr) )
 341       RealExplicit= false;
 342
 343    if ( RealExplicit ) {
 344       if ( ElVal->IsVrUnknown() ) {
 345          // When not a dictionary entry, we can safely overwrite the vr.
 346          ElVal->SetVR(vr);
 347          return;
 348       }
 349       if ( ElVal->GetVR() == vr ) {
 350          // The vr we just read and the dictionary agree. Nothing to do.
 351          return;
 352       }
 353       // The vr present in the file and the dictionary disagree. We assume
 354       // the file writer knew best and use the vr of the file. Since it would
 355       // be unwise to overwrite the vr of a dictionary (since it would
 356       // compromise it's next user), we need to clone the actual DictEntry
 357       // and change the vr for the read one.
 358       gdcmDictEntry* NewTag = new gdcmDictEntry(ElVal->GetGroup(),
 359                                  ElVal->GetElement(),
 360                                  vr,
 361                                  "FIXME",
 362                                  ElVal->GetName());
 363       ElVal->SetDictEntry(NewTag);
 364       return;
 365    }
 366
 367    // We thought this was explicit VR, but we end up with an
 368    // implicit VR tag. Let's backtrack.
 369
 370       sprintf(msg,"Falsely explicit vr file (%04x,%04x)\n", ElVal->GetGroup(),ElVal->GetElement());
 371       dbg.Verbose(1, "gdcmHeader::FindVR: ",msg);
 372
 373    fseek(fp, PositionOnEntry, SEEK_SET);
 374    // When this element is known in the dictionary we shall use, e.g. for
 375    // the semantics (see  the usage of IsAnInteger), the vr proposed by the
 376    // dictionary entry. Still we have to flag the element as implicit since
 377    // we know now our assumption on expliciteness is not furfilled.
 378    // avoid  .
 379    if ( ElVal->IsVrUnknown() )
 380       ElVal->SetVR("Implicit");
 381    ElVal->SetImplicitVr();
 382 }
 383
 384 /**
 385  * \ingroup gdcmHeader
 386  * \brief   Determines if the Transfer Syntax was allready encountered
 387  *          and if it corresponds to a ImplicitVRLittleEndian one.
 388  *
 389  * @return  True when ImplicitVRLittleEndian found. False in all other cases.
 390  */
 391 bool gdcmHeader::IsImplicitVRLittleEndianTransferSyntax(void) {
 392    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 393    if ( !Element )
 394       return false;
 395    LoadElementValueSafe(Element);
 396    string Transfer = Element->GetValue();
 397    if ( Transfer == "1.2.840.10008.1.2" )
 398       return true;
 399    return false;
 400 }
 401
 402 /**
 403  * \ingroup gdcmHeader
 404  * \brief   Determines if the Transfer Syntax was allready encountered
 405  *          and if it corresponds to a ExplicitVRLittleEndian one.
 406  *
 407  * @return  True when ExplicitVRLittleEndian found. False in all other cases.
 408  */
 409 bool gdcmHeader::IsExplicitVRLittleEndianTransferSyntax(void) {
 410    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 411    if ( !Element )
 412       return false;
 413    LoadElementValueSafe(Element);
 414    string Transfer = Element->GetValue();
 415    if ( Transfer == "1.2.840.10008.1.2.1" )
 416       return true;
 417    return false;
 418 }
 419
 420 /**
 421  * \ingroup gdcmHeader
 422  * \brief   Determines if the Transfer Syntax was allready encountered
 423  *          and if it corresponds to a DeflatedExplicitVRLittleEndian one.
 424  *
 425  * @return  True when DeflatedExplicitVRLittleEndian found. False in all other cases.
 426  */
 427 bool gdcmHeader::IsDeflatedExplicitVRLittleEndianTransferSyntax(void) {
 428    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 429    if ( !Element )
 430       return false;
 431    LoadElementValueSafe(Element);
 432    string Transfer = Element->GetValue();
 433    if ( Transfer == "1.2.840.10008.1.2.1.99" )
 434       return true;
 435    return false;
 436 }
 437
 438 /**
 439  * \ingroup gdcmHeader
 440  * \brief   Determines if the Transfer Syntax was allready encountered
 441  *          and if it corresponds to a Explicit VR Big Endian one.
 442  *
 443  * @return  True when big endian found. False in all other cases.
 444  */
 445 bool gdcmHeader::IsExplicitVRBigEndianTransferSyntax(void) {
 446    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 447    if ( !Element )
 448       return false;
 449    LoadElementValueSafe(Element);
 450    string Transfer = Element->GetValue();
 451    if ( Transfer == "1.2.840.10008.1.2.2" )  //1.2.2 ??? A verifier !
 452       return true;
 453    return false;
 454 }
 455
 456 /**
 457  * \ingroup gdcmHeader
 458  * \brief   Determines if the Transfer Syntax was allready encountered
 459  *          and if it corresponds to a JPEGBaseLineProcess1 one.
 460  *
 461  * @return  True when JPEGBaseLineProcess1found. False in all other cases.
 462  */
 463 bool gdcmHeader::IsJPEGBaseLineProcess1TransferSyntax(void) {
 464    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 465    if ( !Element )
 466       return false;
 467    LoadElementValueSafe(Element);
 468    string Transfer = Element->GetValue();
 469    if ( Transfer == "1.2.840.10008.1.2.4.50" )
 470       return true;
 471    return false;
 472 }
 473
 474 /**
 475  * \ingroup gdcmHeader
 476  * \brief
 477  *
 478  * @return
 479  */
 480 bool gdcmHeader::IsJPEGLossless(void) {
 481    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 482     // faire qq chose d'intelligent a la place de ça
 483    if ( !Element )
 484       return false;
 485    LoadElementValueSafe(Element);
 486    const char * Transfert = Element->GetValue().c_str();
 487    if ( memcmp(Transfert+strlen(Transfert)-2 ,"70",2)==0) return true;
 488    if ( memcmp(Transfert+strlen(Transfert)-2 ,"55",2)==0) return true;
 489    return false;
 490 }
 491
 492
 493 /**
 494  * \ingroup gdcmHeader
 495  * \brief   Determines if the Transfer Syntax was allready encountered
 496  *          and if it corresponds to a JPEGExtendedProcess2-4 one.
 497  *
 498  * @return  True when JPEGExtendedProcess2-4 found. False in all other cases.
 499  */
 500 bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) {
 501    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 502    if ( !Element )
 503       return false;
 504    LoadElementValueSafe(Element);
 505    string Transfer = Element->GetValue();
 506    if ( Transfer == "1.2.840.10008.1.2.4.51" )
 507       return true;
 508    return false;
 509 }
 510
 511 /**
 512  * \ingroup gdcmHeader
 513  * \brief   Determines if the Transfer Syntax was allready encountered
 514  *          and if it corresponds to a JPEGExtendeProcess3-5 one.
 515  *
 516  * @return  True when JPEGExtendedProcess3-5 found. False in all other cases.
 517  */
 518 bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax(void) {
 519    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 520    if ( !Element )
 521       return false;
 522    LoadElementValueSafe(Element);
 523    string Transfer = Element->GetValue();
 524    if ( Transfer == "1.2.840.10008.1.2.4.52" )
 525       return true;
 526    return false;
 527 }
 528
 529 /**
 530  * \ingroup gdcmHeader
 531  * \brief   Determines if the Transfer Syntax was allready encountered
 532  *          and if it corresponds to a JPEGSpectralSelectionProcess6-8 one.
 533  *
 534  * @return  True when JPEGSpectralSelectionProcess6-8 found. False in all
 535  *          other cases.
 536  */
 537 bool gdcmHeader::IsJPEGSpectralSelectionProcess6_8TransferSyntax(void) {
 538    gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010);
 539    if ( !Element )
 540       return false;
 541    LoadElementValueSafe(Element);
 542    string Transfer = Element->GetValue();
 543    if ( Transfer == "1.2.840.10008.1.2.4.53" )
 544       return true;
 545    return false;
 546 }
 547
 548 /**
 549  * \ingroup gdcmHeader
 550  * \brief   Predicate for dicom version 3 file.
 551  * @return  True when the file is a dicom version 3.
 552  */
 553 bool gdcmHeader::IsDicomV3(void) {
 554    if (   (filetype == ExplicitVR)
 555        || (filetype == ImplicitVR) )
 556       return true;
 557    return false;
 558 }
 559
 560 /**
 561  * \ingroup gdcmHeader
 562  * \brief   When the length of an element value is obviously wrong (because
 563  *          the parser went Jabberwocky) one can hope improving things by
 564  *          applying this heuristic.
 565  */
 566 void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) {
 567    if ( FoundLength == 0xffffffff)
 568       FoundLength = 0;
 569    ElVal->SetLength(FoundLength);
 570 }
 571
 572 /**
 573  * \ingroup gdcmHeader
 574  * \brief
 575  *
 576  * @return
 577  */
 578  guint32 gdcmHeader::FindLengthOB(void) {
 579    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
 580    guint16 g;
 581    guint16 n;
 582    long PositionOnEntry = ftell(fp);
 583    bool FoundSequenceDelimiter = false;
 584    guint32 TotalLength = 0;
 585    guint32 ItemLength;
 586
 587    while ( ! FoundSequenceDelimiter) {
 588       g = ReadInt16();
 589       n = ReadInt16();
 590
 591  if (DEBUG) printf ("dans FindLengthOB (%04x,%04x)\n",g,n);
 592  long l = ftell(fp);
 593  if (DEBUG) printf("en  %d o(%o) x(%x)\n",l,l,l);
 594
 595       if (errno == 1)
 596          return 0;
 597       TotalLength += 4;  // We even have to decount the group and element
 598
 599       if ( g != 0xfffe           && g!=0xb00c ) /*for bogus headerJPR */ {
 600          char msg[100]; // for sprintf. Sorry
 601          sprintf(msg,"wrong group (%04x) for an item sequence (%04x,%04x)\n",g, g,n);
 602          dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg);
 603          long l = ftell(fp);
 604          if (DEBUG) printf("en  %d o(%o) x(%x)\n",l,l,l);
 605          errno = 1;
 606          return 0;
 607       }
 608
 609       if ( n == 0xe0dd       || ( g==0xb00c && n==0x0eb6 ) ) /* for bogus header JPR */
 610          FoundSequenceDelimiter = true;
 611       else if ( n != 0xe000 ){
 612          char msg[100];  // for sprintf. Sorry
 613          sprintf(msg,"wrong element (%04x) for an item sequence (%04x,%04x)\n",n, g,n);
 614          dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg);
 615          if (DEBUG) printf("wrong element (%04x) for an item sequence (%04x,%04x)\n",n, g,n);
 616          errno = 1;
 617          return 0;
 618       }
 619       ItemLength = ReadInt32();
 620       TotalLength += ItemLength + 4;  // We add 4 bytes since we just read
 621                                       // the ItemLength with ReadInt32
 622
 623       if (DEBUG) printf("TotalLength %d\n",TotalLength);
 624       SkipBytes(ItemLength);
 625    }
 626    fseek(fp, PositionOnEntry, SEEK_SET);
 627    return TotalLength;
 628 }
 629
 630 /**
 631  * \ingroup gdcmHeader
 632  * \brief
 633  *
 634  * @return
 635  */
 636  void gdcmHeader::FindLength (gdcmElValue * ElVal) {
 637    guint16 element = ElVal->GetElement();
 638    guint16 group = ElVal->GetGroup(); // JPR a virer
 639    string  vr      = ElVal->GetVR();
 640    guint16 length16;
 641    if( (element == 0x0010) && (group == 0x7fe0) ) {// JPR
 642
 643       dbg.SetDebug(10);
 644       dbg.Verbose(2, "gdcmHeader::FindLength: ", // JPR
 645                      "on est sur 7fe0 0010");
 646    }
 647
 648    if ( (filetype == ExplicitVR) && ! ElVal->IsImplicitVr() ) {
 649       if ( (vr=="OB") || (vr=="OW") || (vr=="SQ") || (vr=="UN") ) {
 650
 651          // The following reserved two bytes (see PS 3.5-2001, section
 652          // 7.1.2 Data element structure with explicit vr p27) must be
 653          // skipped before proceeding on reading the length on 4 bytes.
 654          fseek(fp, 2L, SEEK_CUR);
 655
 656          guint32 length32 = ReadInt32();
 657          if ( (vr == "OB") && (length32 == 0xffffffff) ) {
 658             ElVal->SetLength(FindLengthOB());
 659             return;
 660          }
 661          FixFoundLength(ElVal, length32);
 662          return;
 663       }
 664
 665       // Length is encoded on 2 bytes.
 666       length16 = ReadInt16();
 667
 668       // We can tell the current file is encoded in big endian (like
 669       // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag
 670       // and it's value is the one of the encoding of a big endian file.
 671       // In order to deal with such big endian encoded files, we have
 672       // (at least) two strategies:
 673       // * when we load the "Transfer Syntax" tag with value of big endian
 674       //   encoding, we raise the proper flags. Then we wait for the end
 675       //   of the META group (0x0002) among which is "Transfer Syntax",
 676       //   before switching the swap code to big endian. We have to postpone
 677       //   the switching of the swap code since the META group is fully encoded
 678       //   in little endian, and big endian coding only starts at the next
 679       //   group. The corresponding code can be hard to analyse and adds
 680       //   many additional unnecessary tests for regular tags.
 681       // * the second strategy consists in waiting for trouble, that shall
 682       //   appear when we find the first group with big endian encoding. This
 683       //   is easy to detect since the length of a "Group Length" tag (the
 684       //   ones with zero as element number) has to be of 4 (0x0004). When we
 685       //   encouter 1024 (0x0400) chances are the encoding changed and we
 686       //   found a group with big endian encoding.
 687       // We shall use this second strategy. In order to make sure that we
 688       // can interpret the presence of an apparently big endian encoded
 689       // length of a "Group Length" without committing a big mistake, we
 690       // add an additional check: we look in the allready parsed elements
 691       // for the presence of a "Transfer Syntax" whose value has to be "big
 692       // endian encoding". When this is the case, chances are we have got our
 693       // hands on a big endian encoded file: we switch the swap code to
 694       // big endian and proceed...
 695       if ( (element  == 0x0000) && (length16 == 0x0400) ) {
 696          if ( ! IsExplicitVRBigEndianTransferSyntax() ) {
 697             dbg.Verbose(0, "gdcmHeader::FindLength", "not explicit VR");
 698             errno = 1;
 699             return;
 700          }
 701          length16 = 4;
 702          SwitchSwapToBigEndian();
 703          // Restore the unproperly loaded values i.e. the group, the element
 704          // and the dictionary entry depending on them.
 705          guint16 CorrectGroup   = SwapShort(ElVal->GetGroup());
 706          guint16 CorrectElem    = SwapShort(ElVal->GetElement());
 707          gdcmDictEntry * NewTag = GetDictEntryByNumber(CorrectGroup,
 708                                                        CorrectElem);
 709          if (!NewTag) {
 710             // This correct tag is not in the dictionary. Create a new one.
 711             NewTag = new gdcmDictEntry(CorrectGroup, CorrectElem);
 712          }
 713          // FIXME this can create a memory leaks on the old entry that be
 714          // left unreferenced.
 715          ElVal->SetDictEntry(NewTag);
 716       }
 717
 718       // Heuristic: well some files are really ill-formed.
 719       if ( length16 == 0xffff) {
 720          length16 = 0;
 721          dbg.Verbose(0, "gdcmHeader::FindLength",
 722                      "Erroneous element length fixed.");
 723       }
 724       FixFoundLength(ElVal, (guint32)length16);
 725       return;
 726    }
 727
 728    // Either implicit VR or a non DICOM conformal (see not below) explicit
 729    // VR that ommited the VR of (at least) this element. Farts happen.
 730    // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
 731    // on Data elements "Implicit and Explicit VR Data Elements shall
 732    // not coexist in a Data Set and Data Sets nested within it".]
 733    // Length is on 4 bytes.
 734    FixFoundLength(ElVal, ReadInt32());
 735 }
 736
 737 /**
 738  * \ingroup gdcmHeader
 739  * \brief   Swaps back the bytes of 4-byte long integer accordingly to
 740  *          processor order.
 741  *
 742  * @return  The suggested integer.
 743  */
 744 guint32 gdcmHeader::SwapLong(guint32 a) {
 745    switch (sw) {
 746    case    0 :
 747       break;
 748    case 4321 :
 749       a=(   ((a<<24) & 0xff000000) | ((a<<8)  & 0x00ff0000)    |
 750             ((a>>8)  & 0x0000ff00) | ((a>>24) & 0x000000ff) );
 751       break;
 752
 753    case 3412 :
 754       a=(   ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
 755       break;
 756
 757    case 2143 :
 758       a=(    ((a<<8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff)  );
 759       break;
 760    default :
 761       dbg.Error(" gdcmHeader::SwapLong : unset swap code");
 762       a=0;
 763    }
 764    return(a);
 765 }
 766
 767 /**
 768  * \ingroup gdcmHeader
 769  * \brief   Swaps the bytes so they agree with the processor order
 770  * @return  The properly swaped 16 bits integer.
 771  */
 772 guint16 gdcmHeader::SwapShort(guint16 a) {
 773    if ( (sw==4321)  || (sw==2143) )
 774       a =(((a<<8) & 0x0ff00) | ((a>>8)&0x00ff));
 775    return (a);
 776 }
 777
 778 /**
 779  * \ingroup gdcmHeader
 780  * \brief
 781  *
 782  * @return
 783  */
 784  void gdcmHeader::SkipBytes(guint32 NBytes) {
 785    //FIXME don't dump the returned value
 786    (void)fseek(fp, (long)NBytes, SEEK_CUR);
 787 }
 788
 789 /**
 790  * \ingroup gdcmHeader
 791  * \brief
 792  *
 793  * @return
 794  */
 795  void gdcmHeader::SkipElementValue(gdcmElValue * ElVal) {
 796    SkipBytes(ElVal->GetLength());
 797 }
 798
 799 /**
 800  * \ingroup gdcmHeader
 801  * \brief
 802  *
 803  * @return
 804  */
 805  void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) {
 806    if (NewSize < 0)
 807       return;
 808    if ((guint32)NewSize >= (guint32)0xffffffff) {
 809       MaxSizeLoadElementValue = 0xffffffff;
 810       return;
 811    }
 812    MaxSizeLoadElementValue = NewSize;
 813 }
 814
 815 /**
 816  * \ingroup       gdcmHeader
 817  * \brief         Loads the element content if it's length is not bigger
 818  *                than the value specified with
 819  *                gdcmHeader::SetMaxSizeLoadElementValue()
 820  */
 821 void gdcmHeader::LoadElementValue(gdcmElValue * ElVal) {
 822    size_t item_read;
 823    guint16 group  = ElVal->GetGroup();
 824    string  vr     = ElVal->GetVR();
 825    guint32 length = ElVal->GetLength();
 826    bool SkipLoad  = false;
 827
 828    fseek(fp, (long)ElVal->GetOffset(), SEEK_SET);
 829
 830    // FIXME Sequences not treated yet !
 831    //
 832    // Ne faudrait-il pas au contraire trouver immediatement
 833    // une maniere 'propre' de traiter les sequences (vr = SQ)
 834    // car commencer par les ignorer risque de conduire a qq chose
 835    // qui pourrait ne pas etre generalisable
 836    // Well, I'm expecting your code !!!
 837
 838    if( vr == "SQ" )
 839       SkipLoad = true;
 840
 841    // Heuristic : a sequence "contains" a set of tags (called items). It looks
 842    // like the last tag of a sequence (the one that terminates the sequence)
 843    // has a group of 0xfffe (with a dummy length).
 844    if( group == 0xfffe )
 845       SkipLoad = true;
 846
 847    if ( SkipLoad ) {
 848       ElVal->SetLength(0);
 849       ElVal->SetValue("gdcm::Skipped");
 850       return;
 851    }
 852
 853    // When the length is zero things are easy:
 854    if ( length == 0 ) {
 855       ElVal->SetValue("");
 856       return;
 857    }
 858
 859    // The elements whose length is bigger than the specified upper bound
 860    // are not loaded. Instead we leave a short notice of the offset of
 861    // the element content and it's length.
 862    if (length > MaxSizeLoadElementValue) {
 863       ostringstream s;
 864       s << "gdcm::NotLoaded.";
 865       s << " Address:" << (long)ElVal->GetOffset();
 866       s << " Length:"  << ElVal->GetLength();
 867       ElVal->SetValue(s.str());
 868       return;
 869    }
 870
 871    // When an integer is expected, read and convert the following two or
 872    // four bytes properly i.e. as an integer as opposed to a string.
 873
 874         // pour les elements de Value Multiplicity > 1
 875         // on aura en fait une serie d'entiers
 876
 877         // on devrait pouvoir faire + compact (?)
 878
 879    if ( IsAnInteger(ElVal) ) {
 880       guint32 NewInt;
 881       ostringstream s;
 882       int nbInt;
 883       if (vr == "US" || vr == "SS") {
 884          nbInt = length / 2;
 885          NewInt = ReadInt16();
 886          s << NewInt;
 887          if (nbInt > 1) {
 888             for (int i=1; i < nbInt; i++) {
 889                s << '\\';
 890                NewInt = ReadInt16();
 891                s << NewInt;
 892             }
 893          }
 894
 895       } else if (vr == "UL" || vr == "SL") {
 896          nbInt = length / 4;
 897          NewInt = ReadInt32();
 898          s << NewInt;
 899          if (nbInt > 1) {
 900             for (int i=1; i < nbInt; i++) {
 901                s << '\\';
 902                NewInt = ReadInt32();
 903                s << NewInt;
 904             }
 905          }
 906       }
 907       ElVal->SetValue(s.str());
 908       return;
 909    }
 910
 911    // We need an additional byte for storing \0 that is not on disk
 912    char* NewValue = (char*)malloc(length+1);
 913    if( !NewValue) {
 914       dbg.Verbose(1, "LoadElementValue: Failed to allocate NewValue");
 915       return;
 916    }
 917    NewValue[length]= 0;
 918
 919    item_read = fread(NewValue, (size_t)length, (size_t)1, fp);
 920    if ( item_read != 1 ) {
 921       free(NewValue);
 922       dbg.Verbose(1, "gdcmHeader::LoadElementValue","unread element value");
 923       ElVal->SetValue("gdcm::UnRead");
 924       return;
 925    }
 926    ElVal->SetValue(NewValue);
 927    free(NewValue);
 928 }
 929
 930 /**
 931  * \ingroup       gdcmHeader
 932  * \brief         Loads the element while preserving the current
 933  *                underlying file position indicator as opposed to
 934  *                to LoadElementValue that modifies it.
 935  * @param ElVal   Element whose value shall be loaded.
 936  * @return
 937  */
 938 void gdcmHeader::LoadElementValueSafe(gdcmElValue * ElVal) {
 939    long PositionOnEntry = ftell(fp);
 940    LoadElementValue(ElVal);
 941    fseek(fp, PositionOnEntry, SEEK_SET);
 942 }
 943
 944 /**
 945  * \ingroup gdcmHeader
 946  * \brief
 947  *
 948  * @return
 949  */
 950 guint16 gdcmHeader::ReadInt16(void) {
 951    guint16 g;
 952    size_t item_read;
 953    item_read = fread (&g, (size_t)2,(size_t)1, fp);
 954    if ( item_read != 1 ) {
 955       dbg.Verbose(1, "gdcmHeader::ReadInt16", " Failed to read :");
 956       if(feof(fp))
 957          dbg.Verbose(1, "gdcmHeader::ReadInt16", " End of File encountered");
 958      if(ferror(fp))
 959          dbg.Verbose(1, "gdcmHeader::ReadInt16", " File Error");
 960       errno = 1;
 961       return 0;
 962    }
 963    errno = 0;
 964    g = SwapShort(g);
 965    return g;
 966 }
 967
 968 /**
 969  * \ingroup gdcmHeader
 970  * \brief
 971  *
 972  * @return
 973  */
 974 guint32 gdcmHeader::ReadInt32(void) {
 975    guint32 g;
 976    size_t item_read;
 977    item_read = fread (&g, (size_t)4,(size_t)1, fp);
 978    if ( item_read != 1 ) {
 979
 980       dbg.Verbose(1, "gdcmHeader::ReadInt32", " Failed to read :");
 981       if(feof(fp))
 982          dbg.Verbose(1, "gdcmHeader::ReadInt32", " End of File encountered");
 983      if(ferror(fp))
 984          dbg.Verbose(1, "gdcmHeader::ReadInt32", " File Error");
 985       errno = 1;
 986       return 0;
 987    }
 988    errno = 0;
 989    g = SwapLong(g);
 990    return g;
 991 }
 992
 993 /**
 994  * \ingroup gdcmHeader
 995  * \brief
 996  *
 997  * @return
 998  */
 999  gdcmElValue* gdcmHeader::GetElValueByNumber(guint16 Group, guint16 Elem) {
1000
1001    gdcmElValue* elValue = PubElValSet.GetElementByNumber(Group, Elem);
1002    if (!elValue) {
1003       dbg.Verbose(1, "gdcmHeader::GetElValueByNumber",
1004                   "failed to Locate gdcmElValue");
1005       return (gdcmElValue*)0;
1006    }
1007    return elValue;
1008 }
1009
1010 /**
1011  * \ingroup gdcmHeader
1012  * \brief   Build a new Element Value from all the low level arguments.
1013  *          Check for existence of dictionary entry, and build
1014  *          a default one when absent.
1015  * @param   Group group   of the underlying DictEntry
1016  * @param   Elem  element of the underlying DictEntry
1017  */
1018 gdcmElValue* gdcmHeader::NewElValueByNumber(guint16 Group, guint16 Elem) {
1019    // Find out if the tag we encountered is in the dictionaries:
1020    gdcmDictEntry * NewTag = GetDictEntryByNumber(Group, Elem);
1021    if (!NewTag)
1022       NewTag = new gdcmDictEntry(Group, Elem);
1023
1024    gdcmElValue* NewElVal = new gdcmElValue(NewTag);
1025    if (!NewElVal) {
1026       dbg.Verbose(1, "gdcmHeader::NewElValueByNumber",
1027                   "failed to allocate gdcmElValue");
1028       return (gdcmElValue*)0;
1029    }
1030    return NewElVal;
1031 }
1032
1033 /**
1034  * \ingroup gdcmHeader
1035  * \brief   TODO
1036  * @param
1037  */
1038 int gdcmHeader::ReplaceOrCreateByNumber(string Value, guint16 Group, guint16 Elem ) {
1039
1040         // TODO : FIXME JPRx
1041         // curieux, non ?
1042         // on (je) cree une Elvalue ne contenant pas de valeur
1043         // on l'ajoute au ElValSet
1044         // on affecte une valeur a cette ElValue a l'interieur du ElValSet
1045         // --> devrait pouvoir etre fait + simplement ???
1046
1047    gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
1048    PubElValSet.Add(nvElValue);
1049    PubElValSet.SetElValueByNumber(Value, Group, Elem);
1050    return(1);
1051 }
1052
1053
1054 /**
1055  * \ingroup gdcmHeader
1056  * \brief   TODO
1057  * @param
1058  */
1059 int gdcmHeader::ReplaceOrCreateByNumber(char* Value, guint16 Group, guint16 Elem ) {
1060
1061    gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
1062    PubElValSet.Add(nvElValue);
1063    string v = Value;
1064    PubElValSet.SetElValueByNumber(v, Group, Elem);
1065    return(1);
1066 }
1067
1068 /**
1069  * \ingroup gdcmHeader
1070  * \brief   TODO
1071  * @param
1072  */
1073
1074 int gdcmHeader::CheckIfExistByNumber(guint16 Group, guint16 Elem ) {
1075    return (PubElValSet.CheckIfExistByNumber(Group, Elem));
1076  }
1077
1078
1079 /**
1080  * \ingroup gdcmHeader
1081  * \brief   Build a new Element Value from all the low level arguments.
1082  *          Check for existence of dictionary entry, and build
1083  *          a default one when absent.
1084  * @param   Name    Name of the underlying DictEntry
1085  */
1086 gdcmElValue* gdcmHeader::NewElValueByName(string Name) {
1087
1088    gdcmDictEntry * NewTag = GetDictEntryByName(Name);
1089    if (!NewTag)
1090       NewTag = new gdcmDictEntry(0xffff, 0xffff, "LO", "Unknown", Name);
1091
1092    gdcmElValue* NewElVal = new gdcmElValue(NewTag);
1093    if (!NewElVal) {
1094       dbg.Verbose(1, "gdcmHeader::ObtainElValueByName",
1095                   "failed to allocate gdcmElValue");
1096       return (gdcmElValue*)0;
1097    }
1098    return NewElVal;
1099 }
1100
1101 /**
1102  * \ingroup gdcmHeader
1103  * \brief   Read the next tag but WITHOUT loading it's value
1104  * @return  On succes the newly created ElValue, NULL on failure.
1105  */
1106 gdcmElValue * gdcmHeader::ReadNextElement(void) {
1107
1108    guint16 g,n;
1109    gdcmElValue * NewElVal;
1110
1111    g = ReadInt16();
1112    n = ReadInt16();
1113
1114    if ( (g==0x7fe0) && (n==0x0010) )
1115         if (DEBUG)
1116            printf("in gdcmHeader::ReadNextElement try to read 7fe0 0010 \n");
1117
1118    if (errno == 1)
1119       // We reached the EOF (or an error occured) and header parsing
1120       // has to be considered as finished.
1121       return (gdcmElValue *)0;
1122
1123    NewElVal = NewElValueByNumber(g, n);
1124    FindVR(NewElVal);
1125    FindLength(NewElVal);
1126    if (errno == 1) {
1127       // Call it quits
1128       if (DEBUG) printf("in gdcmHeader::ReadNextElement : g %04x n %04x errno %d\n",g, n, errno);
1129       return (gdcmElValue *)0;
1130    }
1131    NewElVal->SetOffset(ftell(fp));
1132    if ( (g==0x7fe0) && (n==0x0010) )
1133       if (DEBUG)
1134          printf("sortie de gdcmHeader::ReadNextElement 7fe0 0010 \n");
1135    return NewElVal;
1136 }
1137
1138 /**
1139  * \ingroup gdcmHeader
1140  * \brief   Apply some heuristics to predict wether the considered
1141  *          element value contains/represents an integer or not.
1142  * @param   ElVal The element value on which to apply the predicate.
1143  * @return  The result of the heuristical predicate.
1144  */
1145 bool gdcmHeader::IsAnInteger(gdcmElValue * ElVal) {
1146    guint16 group   = ElVal->GetGroup();
1147    guint16 element = ElVal->GetElement();
1148    string  vr      = ElVal->GetVR();
1149    guint32 length  = ElVal->GetLength();
1150
1151    // When we have some semantics on the element we just read, and if we
1152    // a priori know we are dealing with an integer, then we shall be
1153    // able to swap it's element value properly.
1154    if ( element == 0 )  {  // This is the group length of the group
1155       if (length == 4)
1156          return true;
1157       else {
1158          if (DEBUG) printf("Erroneous Group Length element length (%04x , %04x) : %d\n",
1159             group, element,length);
1160
1161          dbg.Error("gdcmHeader::IsAnInteger",
1162             "Erroneous Group Length element length.");
1163       }
1164    }
1165    if ( (vr == "UL") || (vr == "US") || (vr == "SL") || (vr == "SS") )
1166       return true;
1167
1168    return false;
1169 }
1170
1171 /**
1172  * \ingroup gdcmHeader
1173  * \brief   Recover the offset (from the beginning of the file) of the pixels.
1174  */
1175 size_t gdcmHeader::GetPixelOffset(void) {
1176    // If this file complies with the norm we should encounter the
1177    // "Image Location" tag (0x0028,  0x0200). This tag contains the
1178    // the group that contains the pixel data (hence the "Pixel Data"
1179    // is found by indirection through the "Image Location").
1180    // Inside the group pointed by "Image Location" the searched element
1181    // is conventionally the element 0x0010 (when the norm is respected).
1182    // When the "Image Location" is absent we default to group 0x7fe0.
1183    guint16 grPixel;
1184    guint16 numPixel;
1185    string ImageLocation = GetPubElValByName("Image Location");
1186    if ( ImageLocation == "gdcm::Unfound" ) {
1187       grPixel = 0x7fe0;
1188    } else {
1189       grPixel = (guint16) atoi( ImageLocation.c_str() );
1190    }
1191    if (grPixel != 0x7fe0)
1192       // This is a kludge for old dirty Philips imager.
1193       numPixel = 0x1010;
1194    else
1195       numPixel = 0x0010;
1196
1197    gdcmElValue* PixelElement = PubElValSet.GetElementByNumber(grPixel,
1198                                                               numPixel);
1199    if (PixelElement)
1200       return PixelElement->GetOffset();
1201    else
1202       return 0;
1203 }
1204
1205 /**
1206  * \ingroup gdcmHeader
1207  * \brief   Searches both the public and the shadow dictionary (when they
1208  *          exist) for the presence of the DictEntry with given
1209  *          group and element. The public dictionary has precedence on the
1210  *          shadow one.
1211  * @param   group   group of the searched DictEntry
1212  * @param   element element of the searched DictEntry
1213  * @return  Corresponding DictEntry when it exists, NULL otherwise.
1214  */
1215 gdcmDictEntry * gdcmHeader::GetDictEntryByNumber(guint16 group,
1216                                                  guint16 element) {
1217    gdcmDictEntry * found = (gdcmDictEntry*)0;
1218    if (!RefPubDict && !RefShaDict) {
1219       dbg.Verbose(0, "gdcmHeader::GetDictEntry",
1220                      "we SHOULD have a default dictionary");
1221    }
1222    if (RefPubDict) {
1223       found = RefPubDict->GetTagByNumber(group, element);
1224       if (found)
1225          return found;
1226    }
1227    if (RefShaDict) {
1228       found = RefShaDict->GetTagByNumber(group, element);
1229       if (found)
1230          return found;
1231    }
1232    return found;
1233 }
1234
1235 /**
1236  * \ingroup gdcmHeader
1237  * \brief   Searches both the public and the shadow dictionary (when they
1238  *          exist) for the presence of the DictEntry with given name.
1239  *          The public dictionary has precedence on the shadow one.
1240  * @param   Name name of the searched DictEntry
1241  * @return  Corresponding DictEntry when it exists, NULL otherwise.
1242  */
1243 gdcmDictEntry * gdcmHeader::GetDictEntryByName(string Name) {
1244    gdcmDictEntry * found = (gdcmDictEntry*)0;
1245    if (!RefPubDict && !RefShaDict) {
1246       dbg.Verbose(0, "gdcmHeader::GetDictEntry",
1247                      "we SHOULD have a default dictionary");
1248    }
1249    if (RefPubDict) {
1250       found = RefPubDict->GetTagByName(Name);
1251       if (found)
1252          return found;
1253    }
1254    if (RefShaDict) {
1255       found = RefShaDict->GetTagByName(Name);
1256       if (found)
1257          return found;
1258    }
1259    return found;
1260 }
1261
1262 /**
1263  * \ingroup gdcmHeader
1264  * \brief   Searches within the public dictionary for element value of
1265  *          a given tag.
1266  * @param   group Group of the researched tag.
1267  * @param   element Element of the researched tag.
1268  * @return  Corresponding element value when it exists, and the string
1269  *          "gdcm::Unfound" otherwise.
1270  */
1271 string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) {
1272    return PubElValSet.GetElValueByNumber(group, element);
1273 }
1274
1275 /**
1276  * \ingroup gdcmHeader
1277  * \brief   Searches within the public dictionary for element value
1278  *          representation of a given tag.
1279  *
1280  *          Obtaining the VR (Value Representation) might be needed by caller
1281  *          to convert the string typed content to caller's native type
1282  *          (think of C++ vs Python). The VR is actually of a higher level
1283  *          of semantics than just the native C++ type.
1284  * @param   group Group of the researched tag.
1285  * @param   element Element of the researched tag.
1286  * @return  Corresponding element value representation when it exists,
1287  *          and the string "gdcm::Unfound" otherwise.
1288  */
1289 string gdcmHeader::GetPubElValRepByNumber(guint16 group, guint16 element) {
1290    gdcmElValue* elem =  PubElValSet.GetElementByNumber(group, element);
1291    if ( !elem )
1292       return "gdcm::Unfound";
1293    return elem->GetVR();
1294 }
1295
1296 /**
1297  * \ingroup gdcmHeader
1298  * \brief   Searches within the public dictionary for element value of
1299  *          a given tag.
1300  * @param   TagName name of the researched element.
1301  * @return  Corresponding element value when it exists, and the string
1302  *          "gdcm::Unfound" otherwise.
1303  */
1304 string gdcmHeader::GetPubElValByName(string TagName) {
1305    return PubElValSet.GetElValueByName(TagName);
1306 }
1307
1308 /**
1309  * \ingroup gdcmHeader
1310  * \brief   Searches within the elements parsed with the public dictionary for
1311  *          the element value representation of a given tag.
1312  *
1313  *          Obtaining the VR (Value Representation) might be needed by caller
1314  *          to convert the string typed content to caller's native type
1315  *          (think of C++ vs Python). The VR is actually of a higher level
1316  *          of semantics than just the native C++ type.
1317  * @param   TagName name of the researched element.
1318  * @return  Corresponding element value representation when it exists,
1319  *          and the string "gdcm::Unfound" otherwise.
1320  */
1321 string gdcmHeader::GetPubElValRepByName(string TagName) {
1322    gdcmElValue* elem =  PubElValSet.GetElementByName(TagName);
1323    if ( !elem )
1324       return "gdcm::Unfound";
1325    return elem->GetVR();
1326 }
1327
1328 /**
1329  * \ingroup gdcmHeader
1330  * \brief   Searches within elements parsed with the SHADOW dictionary
1331  *          for the element value of a given tag.
1332  * @param   group Group of the researched tag.
1333  * @param   element Element of the researched tag.
1334  * @return  Corresponding element value representation when it exists,
1335  *          and the string "gdcm::Unfound" otherwise.
1336  */
1337 string gdcmHeader::GetShaElValByNumber(guint16 group, guint16 element) {
1338    return ShaElValSet.GetElValueByNumber(group, element);
1339 }
1340
1341 /**
1342  * \ingroup gdcmHeader
1343  * \brief   Searches within the elements parsed with the SHADOW dictionary
1344  *          for the element value representation of a given tag.
1345  *
1346  *          Obtaining the VR (Value Representation) might be needed by caller
1347  *          to convert the string typed content to caller's native type
1348  *          (think of C++ vs Python). The VR is actually of a higher level
1349  *          of semantics than just the native C++ type.
1350  * @param   group Group of the researched tag.
1351  * @param   element Element of the researched tag.
1352  * @return  Corresponding element value representation when it exists,
1353  *          and the string "gdcm::Unfound" otherwise.
1354  */
1355 string gdcmHeader::GetShaElValRepByNumber(guint16 group, guint16 element) {
1356    gdcmElValue* elem =  ShaElValSet.GetElementByNumber(group, element);
1357    if ( !elem )
1358       return "gdcm::Unfound";
1359    return elem->GetVR();
1360 }
1361
1362 /**
1363  * \ingroup gdcmHeader
1364  * \brief   Searches within the elements parsed with the shadow dictionary
1365  *          for an element value of given tag.
1366  * @param   TagName name of the researched element.
1367  * @return  Corresponding element value when it exists, and the string
1368  *          "gdcm::Unfound" otherwise.
1369  */
1370 string gdcmHeader::GetShaElValByName(string TagName) {
1371    return ShaElValSet.GetElValueByName(TagName);
1372 }
1373
1374 /**
1375  * \ingroup gdcmHeader
1376  * \brief   Searches within the elements parsed with the shadow dictionary for
1377  *          the element value representation of a given tag.
1378  *
1379  *          Obtaining the VR (Value Representation) might be needed by caller
1380  *          to convert the string typed content to caller's native type
1381  *          (think of C++ vs Python). The VR is actually of a higher level
1382  *          of semantics than just the native C++ type.
1383  * @param   TagName name of the researched element.
1384  * @return  Corresponding element value representation when it exists,
1385  *          and the string "gdcm::Unfound" otherwise.
1386  */
1387 string gdcmHeader::GetShaElValRepByName(string TagName) {
1388    gdcmElValue* elem =  ShaElValSet.GetElementByName(TagName);
1389    if ( !elem )
1390       return "gdcm::Unfound";
1391    return elem->GetVR();
1392 }
1393
1394 /**
1395  * \ingroup gdcmHeader
1396  * \brief   Searches within elements parsed with the public dictionary
1397  *          and then within the elements parsed with the shadow dictionary
1398  *          for the element value of a given tag.
1399  * @param   group Group of the researched tag.
1400  * @param   element Element of the researched tag.
1401  * @return  Corresponding element value representation when it exists,
1402  *          and the string "gdcm::Unfound" otherwise.
1403  */
1404 string gdcmHeader::GetElValByNumber(guint16 group, guint16 element) {
1405    string pub = GetPubElValByNumber(group, element);
1406    if (pub.length())
1407       return pub;
1408    return GetShaElValByNumber(group, element);
1409 }
1410
1411 /**
1412  * \ingroup gdcmHeader
1413  * \brief   Searches within elements parsed with the public dictionary
1414  *          and then within the elements parsed with the shadow dictionary
1415  *          for the element value representation of a given tag.
1416  *
1417  *          Obtaining the VR (Value Representation) might be needed by caller
1418  *          to convert the string typed content to caller's native type
1419  *          (think of C++ vs Python). The VR is actually of a higher level
1420  *          of semantics than just the native C++ type.
1421  * @param   group Group of the researched tag.
1422  * @param   element Element of the researched tag.
1423  * @return  Corresponding element value representation when it exists,
1424  *          and the string "gdcm::Unfound" otherwise.
1425  */
1426 string gdcmHeader::GetElValRepByNumber(guint16 group, guint16 element) {
1427    string pub = GetPubElValRepByNumber(group, element);
1428    if (pub.length())
1429       return pub;
1430    return GetShaElValRepByNumber(group, element);
1431 }
1432
1433 /**
1434  * \ingroup gdcmHeader
1435  * \brief   Searches within elements parsed with the public dictionary
1436  *          and then within the elements parsed with the shadow dictionary
1437  *          for the element value of a given tag.
1438  * @param   TagName name of the researched element.
1439  * @return  Corresponding element value when it exists,
1440  *          and the string "gdcm::Unfound" otherwise.
1441  */
1442 string gdcmHeader::GetElValByName(string TagName) {
1443    string pub = GetPubElValByName(TagName);
1444    if (pub.length())
1445       return pub;
1446    return GetShaElValByName(TagName);
1447 }
1448
1449 /**
1450  * \ingroup gdcmHeader
1451  * \brief   Searches within elements parsed with the public dictionary
1452  *          and then within the elements parsed with the shadow dictionary
1453  *          for the element value representation of a given tag.
1454  *
1455  *          Obtaining the VR (Value Representation) might be needed by caller
1456  *          to convert the string typed content to caller's native type
1457  *          (think of C++ vs Python). The VR is actually of a higher level
1458  *          of semantics than just the native C++ type.
1459  * @param   TagName name of the researched element.
1460  * @return  Corresponding element value representation when it exists,
1461  *          and the string "gdcm::Unfound" otherwise.
1462  */
1463 string gdcmHeader::GetElValRepByName(string TagName) {
1464    string pub = GetPubElValRepByName(TagName);
1465    if (pub.length())
1466       return pub;
1467    return GetShaElValRepByName(TagName);
1468 }
1469
1470 /**
1471  * \ingroup gdcmHeader
1472  * \brief   Accesses an existing gdcmElValue in the PubElValSet of this instance
1473  *          through it's (group, element) and modifies it's content with
1474  *          the given value.
1475  * @param   content new value to substitute with
1476  * @param   group   group of the ElVal to modify
1477  * @param   element element of the ElVal to modify
1478  */
1479 int gdcmHeader::SetPubElValByNumber(string content, guint16 group,
1480                                     guint16 element)
1481
1482 //TODO  : homogeneiser les noms : SetPubElValByNumber   qui appelle PubElValSet.SetElValueByNumber
1483 //        pourquoi pas            SetPubElValueByNumber ??
1484 {
1485
1486    return (  PubElValSet.SetElValueByNumber (content, group, element) );
1487 }
1488
1489 /**
1490  * \ingroup gdcmHeader
1491  * \brief   Accesses an existing gdcmElValue in the PubElValSet of this instance
1492  *          through tag name and modifies it's content with the given value.
1493  * @param   content new value to substitute with
1494  * @param   TagName name of the tag to be modified
1495  */
1496 int gdcmHeader::SetPubElValByName(string content, string TagName) {
1497    return (  PubElValSet.SetElValueByName (content, TagName) );
1498 }
1499
1500 /**
1501  * \ingroup gdcmHeader
1502  * \brief   Accesses an existing gdcmElValue in the PubElValSet of this instance
1503  *          through it's (group, element) and modifies it's length with
1504  *          the given value.
1505  * \warning Use with extreme caution.
1506  * @param   length new length to substitute with
1507  * @param   group   group of the ElVal to modify
1508  * @param   element element of the ElVal to modify
1509  * @return  1 on success, 0 otherwise.
1510  */
1511
1512 int gdcmHeader::SetPubElValLengthByNumber(guint32 length, guint16 group,
1513                                     guint16 element) {
1514         return (  PubElValSet.SetElValueLengthByNumber (length, group, element) );
1515 }
1516
1517 /**
1518  * \ingroup gdcmHeader
1519  * \brief   Accesses an existing gdcmElValue in the ShaElValSet of this instance
1520  *          through it's (group, element) and modifies it's content with
1521  *          the given value.
1522  * @param   content new value to substitute with
1523  * @param   group   group of the ElVal to modify
1524  * @param   element element of the ElVal to modify
1525  * @return  1 on success, 0 otherwise.
1526  */
1527 int gdcmHeader::SetShaElValByNumber(string content,
1528                                     guint16 group, guint16 element) {
1529    return (  ShaElValSet.SetElValueByNumber (content, group, element) );
1530 }
1531
1532 /**
1533  * \ingroup gdcmHeader
1534  * \brief   Accesses an existing gdcmElValue in the ShaElValSet of this instance
1535  *          through tag name and modifies it's content with the given value.
1536  * @param   content new value to substitute with
1537  * @param   ShadowTagName name of the tag to be modified
1538  */
1539 int gdcmHeader::SetShaElValByName(string content, string ShadowTagName) {
1540    return (  ShaElValSet.SetElValueByName (content, ShadowTagName) );
1541 }
1542
1543 /**
1544  * \ingroup gdcmHeader
1545  * \brief   Parses the header of the file but WITHOUT loading element values.
1546  */
1547 void gdcmHeader::ParseHeader(bool exception_on_error) throw(gdcmFormatError) {
1548    gdcmElValue * newElValue = (gdcmElValue *)0;
1549
1550    rewind(fp);
1551    CheckSwap();
1552    while ( (newElValue = ReadNextElement()) ) {
1553       SkipElementValue(newElValue);
1554       PubElValSet.Add(newElValue);
1555    }
1556 }
1557
1558
1559 //
1560 // TODO : JPR
1561 // des que les element values sont chargees, stocker,
1562 // en une seule fois, dans des entiers
1563 // NX, NY, NZ, Bits allocated, Bits Stored, High Bit, Samples Per Pixel
1564 // (TODO : preciser les autres)
1565 // et refaire ceux des accesseurs qui renvoient les entiers correspondants
1566 //
1567 // --> peut etre dangereux ?
1568 // si l'utilisateur modifie 'manuellement' l'un des paramètres
1569 // l'entier de sera pas modifié ...
1570 // (pb de la mise à jour en cas de redondance :-(
1571
1572 /**
1573  * \ingroup gdcmHeader
1574  * \brief   Retrieve the number of columns of image.
1575  * @return  The encountered size when found, 0 by default.
1576  */
1577 int gdcmHeader::GetXSize(void) {
1578    // We cannot check for "Columns" because the "Columns" tag is present
1579    // both in IMG (0028,0011) and OLY (6000,0011) sections of the dictionary.
1580    string StrSize = GetPubElValByNumber(0x0028,0x0011);
1581    if (StrSize == "gdcm::Unfound")
1582       return 0;
1583    return atoi(StrSize.c_str());
1584 }
1585
1586 /**
1587  * \ingroup gdcmHeader
1588  * \brief   Retrieve the number of lines of image.
1589  * \warning The defaulted value is 1 as opposed to gdcmHeader::GetXSize()
1590  * @return  The encountered size when found, 1 by default.
1591  */
1592 int gdcmHeader::GetYSize(void) {
1593    // We cannot check for "Rows" because the "Rows" tag is present
1594    // both in IMG (0028,0010) and OLY (6000,0010) sections of the dictionary.
1595    string StrSize = GetPubElValByNumber(0x0028,0x0010);
1596    if (StrSize != "gdcm::Unfound")
1597       return atoi(StrSize.c_str());
1598    if ( IsDicomV3() )
1599       return 0;
1600    else
1601       // The Rows (0028,0010) entry is optional for ACR/NEMA. It might
1602       // hence be a signal (1d image). So we default to 1:
1603       return 1;
1604 }
1605
1606 /**
1607  * \ingroup gdcmHeader
1608  * \brief   Retrieve the number of planes of volume or the number
1609  *          of frames of a multiframe.
1610  * \warning When present we consider the "Number of Frames" as the third
1611  *          dimension. When absent we consider the third dimension as
1612  *          being the "Planes" tag content.
1613  * @return  The encountered size when found, 1 by default.
1614  */
1615 int gdcmHeader::GetZSize(void) {
1616    // Both in DicomV3 and ACR/Nema the consider the "Number of Frames"
1617    // as the third dimension.
1618    string StrSize = GetPubElValByNumber(0x0028,0x0008);
1619    if (StrSize != "gdcm::Unfound")
1620       return atoi(StrSize.c_str());
1621
1622    // We then consider the "Planes" entry as the third dimension [we
1623    // cannot retrieve by name since "Planes tag is present both in
1624    // IMG (0028,0012) and OLY (6000,0012) sections of the dictionary].
1625    StrSize = GetPubElValByNumber(0x0028,0x0012);
1626    if (StrSize != "gdcm::Unfound")
1627       return atoi(StrSize.c_str());
1628    return 1;
1629 }
1630
1631 /**
1632  * \ingroup gdcmHeader
1633  * \brief   Retrieve the number of Bits Stored
1634  *          (as opposite to number of Bits Allocated)
1635  *
1636  * @return  The encountered number of Bits Stored, 0 by default.
1637  */
1638 int gdcmHeader::GetBitsStored(void) {
1639    string StrSize = GetPubElValByNumber(0x0028,0x0101);
1640    if (StrSize == "gdcm::Unfound")
1641       return 1;
1642    return atoi(StrSize.c_str());
1643 }
1644
1645 /**
1646  * \ingroup gdcmHeader
1647  * \brief   Retrieve the number of Samples Per Pixel
1648  *          (1 : gray level, 3 : RGB)
1649  *
1650  * @return  The encountered number of Samples Per Pixel, 1 by default.
1651  */
1652 int gdcmHeader::GetSamplesPerPixel(void) {
1653    string StrSize = GetPubElValByNumber(0x0028,0x0002);
1654    if (StrSize == "gdcm::Unfound")
1655       return 1; // Well, it's supposed to be mandatory ...
1656    return atoi(StrSize.c_str());
1657 }
1658
1659 /**
1660  * \ingroup gdcmHeader
1661  * \brief   Return the size (in bytes) of a single pixel of data.
1662  * @return  The size in bytes of a single pixel of data.
1663  *
1664  */
1665 int gdcmHeader::GetPixelSize(void) {
1666    string PixelType = GetPixelType();
1667    if (PixelType == "8U"  || PixelType == "8S")
1668       return 1;
1669    if (PixelType == "16U" || PixelType == "16S")
1670       return 2;
1671    if (PixelType == "32U" || PixelType == "32S")
1672       return 4;
1673    dbg.Verbose(0, "gdcmHeader::GetPixelSize: Unknown pixel type");
1674    return 0;
1675 }
1676
1677 /**
1678  * \ingroup gdcmHeader
1679  * \brief   Build the Pixel Type of the image.
1680  *          Possible values are:
1681  *          - 8U  unsigned  8 bit,
1682  *          - 8S    signed  8 bit,
1683  *          - 16U unsigned 16 bit,
1684  *          - 16S   signed 16 bit,
1685  *          - 32U unsigned 32 bit,
1686  *          - 32S   signed 32 bit,
1687  * \warning 12 bit images appear as 16 bit.
1688  * @return
1689  */
1690 string gdcmHeader::GetPixelType(void) {
1691    string BitsAlloc;
1692    BitsAlloc = GetElValByName("Bits Allocated");
1693    if (BitsAlloc == "gdcm::Unfound") {
1694       dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Bits Allocated");
1695       BitsAlloc = string("16");
1696    }
1697    if (BitsAlloc == "12")
1698       BitsAlloc = string("16");
1699
1700    string Signed;
1701    Signed = GetElValByName("Pixel Representation");
1702    if (Signed == "gdcm::Unfound") {
1703       dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Pixel Representation");
1704       BitsAlloc = string("0");
1705    }
1706    if (Signed == "0")
1707       Signed = string("U");
1708    else
1709       Signed = string("S");
1710
1711    return( BitsAlloc + Signed);
1712 }
1713
1714
1715 /**
1716  * \ingroup gdcmHeader
1717  * \brief  This predicate, based on hopefully reasonnable heuristics,
1718  *         decides whether or not the current gdcmHeader was properly parsed
1719  *         and contains the mandatory information for being considered as
1720  *         a well formed and usable image.
1721  * @return true when gdcmHeader is the one of a reasonable Dicom file,
1722  *         false otherwise.
1723  */
1724 bool gdcmHeader::IsReadable(void) {
1725    if (   GetElValByName("Image Dimensions") != "gdcm::Unfound"
1726       && atoi(GetElValByName("Image Dimensions").c_str()) > 4 ) {
1727       return false;
1728    }
1729    if ( GetElValByName("Bits Allocated") == "gdcm::Unfound" )
1730       return false;
1731    if ( GetElValByName("Bits Stored") == "gdcm::Unfound" )
1732       return false;
1733    if ( GetElValByName("High Bit") == "gdcm::Unfound" )
1734       return false;
1735    if ( GetElValByName("Pixel Representation") == "gdcm::Unfound" )
1736       return false;
1737    return true;
1738 }
1739
1740 /**
1741  * \ingroup gdcmHeader
1742  * \brief   Small utility function that creates a new manually crafted
1743  *          (as opposed as read from the file) gdcmElValue with user
1744  *          specified name and adds it to the public tag hash table.
1745  * \note    A fake TagKey is generated so the PubDict can keep it's coherence.
1746  * @param   NewTagName The name to be given to this new tag.
1747  * @param   VR The Value Representation to be given to this new tag.
1748  * @ return The newly hand crafted Element Value.
1749  */
1750 gdcmElValue* gdcmHeader::NewManualElValToPubDict(string NewTagName, string VR) {
1751    gdcmElValue* NewElVal = (gdcmElValue*)0;
1752    guint32 StuffGroup = 0xffff;   // Group to be stuffed with additional info
1753    guint32 FreeElem = 0;
1754    gdcmDictEntry* NewEntry = (gdcmDictEntry*)0;
1755
1756    FreeElem = PubElValSet.GenerateFreeTagKeyInGroup(StuffGroup);
1757    if (FreeElem == UINT32_MAX) {
1758       dbg.Verbose(1, "gdcmHeader::NewManualElValToPubDict",
1759                      "Group 0xffff in Public Dict is full");
1760       return (gdcmElValue*)0;
1761    }
1762    NewEntry = new gdcmDictEntry(StuffGroup, FreeElem,
1763                                 VR, "GDCM", NewTagName);
1764    NewElVal = new gdcmElValue(NewEntry);
1765    PubElValSet.Add(NewElVal);
1766    return NewElVal;
1767 }
1768
1769 /**
1770  * \ingroup gdcmHeader
1771  * \brief   Loads the element values of all the elements present in the
1772  *          public tag based hash table.
1773  */
1774 void gdcmHeader::LoadElements(void) {
1775    rewind(fp);
1776    TagElValueHT ht = PubElValSet.GetTagHt();
1777    for (TagElValueHT::iterator tag = ht.begin(); tag != ht.end(); ++tag) {
1778       LoadElementValue(tag->second);
1779    }
1780 }
1781
1782 /**
1783   * \ingroup gdcmHeader
1784   * \brief
1785   * @return
1786   */
1787 void gdcmHeader::PrintPubElVal(std::ostream & os) {
1788    PubElValSet.Print(os);
1789 }
1790
1791 /**
1792   * \ingroup gdcmHeader
1793   * \brief
1794   * @return
1795   */
1796 void gdcmHeader::PrintPubDict(std::ostream & os) {
1797    RefPubDict->Print(os);
1798 }
1799
1800 /**
1801   * \ingroup gdcmHeader
1802   * \brief
1803   * @return
1804   */
1805
1806 int gdcmHeader::Write(FILE * fp, FileType type) {
1807    return PubElValSet.Write(fp, type);
1808 }
1809
1810 /**
1811   * \ingroup gdcmHeader
1812   * \brief
1813   * @return
1814   */
1815 float gdcmHeader::GetXSpacing(void) {
1816     float xspacing, yspacing;
1817     string StrSpacing = GetPubElValByNumber(0x0028,0x0030);
1818
1819     if (StrSpacing == "gdcm::Unfound") {
1820        dbg.Verbose(0, "gdcmHeader::GetXSpacing: unfound Pixel Spacing");
1821        return 1.;
1822      }
1823    if( sscanf( StrSpacing.c_str(), "%f\\%f", &xspacing, &yspacing) != 2)
1824      return 0.;
1825    //else
1826    return xspacing;
1827 }
1828
1829 /**
1830   * \ingroup gdcmHeader
1831   * \brief
1832   * @return
1833   */
1834 float gdcmHeader::GetYSpacing(void) {
1835    float xspacing, yspacing;
1836    string StrSpacing = GetPubElValByNumber(0x0028,0x0030);
1837
1838    if (StrSpacing == "gdcm::Unfound") {
1839       dbg.Verbose(0, "gdcmHeader::GetYSpacing: unfound Pixel Spacing");
1840       return 1.;
1841     }
1842
1843   if( sscanf( StrSpacing.c_str(), "%f\\%f", &xspacing, &yspacing) != 2)
1844     return 0.;
1845
1846   if (yspacing == 0.)
1847   {
1848     dbg.Verbose(0, "gdcmHeader::GetYSpacing: gdcmData/CT-MONO2-8-abdo.dcm problem");
1849     // seems to be a bug in the header ...
1850     sscanf( StrSpacing.c_str(), "%f\\0\\%f", &xspacing, &yspacing);
1851   }
1852   return yspacing;
1853 }
1854
1855
1856 /**
1857   * \ingroup gdcmHeader
1858   * \brief
1859   * @return
1860   */
1861 float gdcmHeader::GetZSpacing(void) {
1862    // TODO : translate into English
1863    // Spacing Between Slices : distance entre le milieu de chaque coupe
1864    // Les coupes peuvent etre :
1865    //   jointives     (Spacing between Slices = Slice Thickness)
1866    //   chevauchantes (Spacing between Slices < Slice Thickness)
1867    //   disjointes    (Spacing between Slices > Slice Thickness)
1868    // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
1869    //   ca interesse le physicien de l'IRM, pas le visualisateur de volumes ...
1870    //   Si le Spacing Between Slices est absent,
1871    //   on suppose que les coupes sont jointives
1872
1873    string StrSpacingBSlices = GetPubElValByNumber(0x0018,0x0088);
1874
1875    if (StrSpacingBSlices == "gdcm::Unfound") {
1876       dbg.Verbose(0, "gdcmHeader::GetZSpacing: unfound StrSpacingBSlices");
1877       string StrSliceThickness = GetPubElValByNumber(0x0018,0x0050);
1878       if (StrSliceThickness == "gdcm::Unfound")
1879          return 1.;
1880       else
1881          // if no 'Spacing Between Slices' is found,
1882          // we assume slices join together
1883          // (no overlapping, no interslice gap)
1884          // if they don't, we're fucked up
1885          return atof(StrSliceThickness.c_str());
1886    } else {
1887       return atof(StrSpacingBSlices.c_str());
1888    }
1889 }
1890
1891 //
1892 // Image Position Patient (0020,0032):
1893 // If not found (ACR_NEMA) we try Image Position (0020,0030)
1894 // If not found (ACR-NEMA), we consider Slice Location (20,1041)
1895 //                                   or Location       (0020,0050)
1896 // as the Z coordinate,
1897 // 0. for all the coordinates if nothing is found
1898 // TODO : find a way to inform the caller nothing was found
1899 // TODO : How to tell the caller a wrong number of values was found?
1900 /**
1901   * \ingroup gdcmHeader
1902   * \brief
1903   * @return
1904   */
1905 float gdcmHeader::GetXImagePosition(void) {
1906     float xImPos, yImPos, zImPos;
1907     // 0020,0032 : Image Position Patient
1908     // 0020,0030 : Image Position (RET)
1909     // 0020,1041 : Slice Location
1910
1911     string StrImPos = GetPubElValByNumber(0x0020,0x0032);
1912
1913     if (StrImPos == "gdcm::Unfound") {
1914        dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Image Position Patient (0020,0032)");
1915        StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
1916        if (StrImPos == "gdcm::Unfound") {
1917           dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Image Position (RET) (0020,0030)");
1918           string StrSliceLoc = GetPubElValByNumber(0x0020,0x1041); // for *very* old ACR-NEMA images
1919           if (StrSliceLoc == "gdcm::Unfound") {
1920             dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Slice Location (0020,1041)");
1921              // How to tell the caller nothing was found?
1922           }
1923        }
1924        return 0.;
1925      }
1926    if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
1927      // How to tell the caller a wrong number of values was found?
1928      return 0.;
1929    //else
1930    return xImPos;
1931 }
1932
1933 /**
1934   * \ingroup gdcmHeader
1935   * \brief
1936   * @return
1937   */
1938 float gdcmHeader::GetYImagePosition(void) {
1939     float xImPos, yImPos, zImPos;
1940     // 0020,0032 : Image Position Patient
1941     // 0020,1041 : Slice Location
1942     // 0020,0050 : Location
1943     string StrImPos = GetPubElValByNumber(0x0020,0x0032);
1944
1945     if (StrImPos == "gdcm::Unfound") {
1946        dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position Patient (0020,0032)");
1947        StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
1948        if (StrImPos == "gdcm::Unfound") {
1949           dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position (RET) (0020,0030)");
1950           string StrSliceLoc = GetPubElValByNumber(0x0020,0x1041); // for *very* old ACR-NEMA images
1951           if (StrSliceLoc == "gdcm::Unfound") {
1952             dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location (0020,1041)");
1953             // How to tell the caller nothing was found?
1954           }
1955        }
1956        return 0.;
1957      }
1958    if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
1959      // How to tell the caller a wrong number of values was found?
1960      return 0.;
1961    return yImPos;
1962 }
1963
1964 /**
1965   * \ingroup gdcmHeader
1966   * \brief
1967   * @return
1968   */
1969 float gdcmHeader::GetZImagePosition(void) {
1970    float xImPos, yImPos, zImPos;
1971     // 0020,0032 : Image Position Patient
1972     // 0020,1041 : Slice Location
1973     // 0020,0050 : Location
1974
1975    // TODO : How to tell the caller nothing was found?
1976    // TODO : How to tell the caller a wrong number of values was found?
1977
1978    string StrImPos = GetPubElValByNumber(0x0020,0x0032);
1979    if (StrImPos != "gdcm::Unfound") {
1980       if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3) {
1981          dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Image Position Patient (0020,0032)");
1982          return 0.;  // bug in the element 0x0020,0x0032
1983       } else {
1984          return zImPos;
1985       }
1986    }
1987
1988    StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
1989    if (StrImPos != "gdcm::Unfound") {
1990       if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3) {
1991          dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Image Position (RET) (0020,0030)");
1992          return 0.;  // bug in the element 0x0020,0x0032
1993       } else {
1994          return zImPos;
1995       }
1996    }
1997
1998    string StrSliceLocation = GetPubElValByNumber(0x0020,0x1041);// for *very* old ACR-NEMA images
1999    if (StrSliceLocation != "gdcm::Unfound") {
2000       if( sscanf( StrSliceLocation.c_str(), "%f", &zImPos) !=1) {
2001          dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Slice Location (0020,1041)");
2002          return 0.;  // bug in the element 0x0020,0x1041
2003       } else {
2004          return zImPos;
2005       }
2006    }
2007    dbg.Verbose(0, "gdcmHeader::GetZImagePosition: unfound Slice Location (0020,1041)");
2008
2009    string StrLocation = GetPubElValByNumber(0x0020,0x0050);
2010    if (StrLocation != "gdcm::Unfound") {
2011       if( sscanf( StrLocation.c_str(), "%f", &zImPos) !=1) {
2012          dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Location (0020,0050)");
2013          return 0.;  // bug in the element 0x0020,0x0050
2014       } else {
2015          return zImPos;
2016       }
2017    }
2018    dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location");
2019
2020    return 0.; // Hopeless
2021 }
2022
2023
2024