src/gdcmFile.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2007/10/08 15:20:17 $
   7   Version:   $Revision: 1.340 $
   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 #include "gdcmSQItem.h"
 100
 101 #include <vector>
 102 #include <stdio.h>  //sscanf
 103 #include <stdlib.h> // for atoi
 104
 105 namespace GDCM_NAME_SPACE
 106 {
 107
 108 //-----------------------------------------------------------------------------
 109 // Constructor / Destructor
 110
 111 /**
 112  * \brief Constructor used when we want to generate dicom files from scratch
 113  */
 114 File::File():
 115    Document()
 116 {
 117    RLEInfo  = new RLEFramesInfo;
 118    JPEGInfo = new JPEGFragmentsInfo;
 119    GrPixel  = 0x7fe0;  // to avoid further troubles
 120    NumPixel = 0x0010;
 121    BasicOffsetTableItemValue = 0;
 122    FourthDimensionLocation = TagKey(0,0);
 123 }
 124
 125
 126 /**
 127  * \brief   Canonical destructor.
 128  */
 129 File::~File()
 130 {
 131    if ( RLEInfo )
 132       delete RLEInfo;
 133    if ( JPEGInfo )
 134       delete JPEGInfo;
 135    delete[] BasicOffsetTableItemValue;
 136 }
 137
 138 //-----------------------------------------------------------------------------
 139 // Public
 140 /**
 141  * \brief   Loader
 142  * @return false if file cannot be open or no swap info was found,
 143  *         or no tag was found.
 144  */
 145 bool File::Load( )
 146 {
 147    if ( ! this->Document::Load( ) )
 148       return false;
 149
 150     return DoTheLoadingJob( );
 151 }
 152
 153 /**
 154  * \brief   Does the Loading Job (internal use only)
 155  * @return false if file cannot be open or no swap info was found,
 156  *         or no tag was found.
 157  */
 158 bool File::DoTheLoadingJob( )
 159 {
 160    // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
 161    // We may encounter the 'RETired' (0x0028, 0x0200) tag
 162    // (Image Location") . This entry contains the number of
 163    // the group that contains the pixel data (hence the "Pixel Data"
 164    // is found by indirection through the "Image Location").
 165    // Inside the group pointed by "Image Location" the searched element
 166    // is conventionally the element 0x0010 (when the norm is respected).
 167    // When the "Image Location" is missing we default to group 0x7fe0.
 168    // Note: this IS the right place for the code
 169
 170    // Image Location
 171    const std::string &imgLocation = GetEntryString(0x0028, 0x0200);
 172    if ( imgLocation == GDCM_UNFOUND )
 173    {
 174       // default value
 175       GrPixel = 0x7fe0;
 176    }
 177    else
 178    {
 179       GrPixel = (uint16_t) atoi( imgLocation.c_str() );
 180    }
 181
 182    // sometimes Image Location value doesn't follow
 183    // the supposed processor endianness.
 184    // see gdcmData/cr172241.dcm
 185    if ( GrPixel == 0xe07f )
 186    {
 187       GrPixel = 0x7fe0;
 188    }
 189
 190    if ( GrPixel != 0x7fe0 )
 191    {
 192       // This is a kludge for old dirty Philips imager.
 193       NumPixel = 0x1010;
 194    }
 195    else
 196    {
 197       NumPixel = 0x0010;
 198    }
 199
 200    // Now, we know GrPixel and NumPixel.
 201    // Let's create a VirtualDictEntry to allow a further VR modification
 202    // and force VR to match with BitsAllocated.
 203    DocEntry *entry = GetDocEntry(GrPixel, NumPixel);
 204    if ( entry != 0 )
 205    {
 206       // Compute the RLE or JPEG info
 207       OpenFile();
 208       const std::string &ts = GetTransferSyntax();
 209       Fp->seekg( entry->GetOffset(), std::ios::beg );
 210       if ( Global::GetTS()->IsRLELossless(ts) )
 211          ComputeRLEInfo();
 212       else if ( Global::GetTS()->IsJPEG(ts) )
 213          ComputeJPEGFragmentInfo();
 214       CloseFile();
 215
 216       // Create a new DataEntry to change the DictEntry
 217       // The changed DictEntry will have
 218       // - a correct PixelVR OB or OW)
 219       // - the name to "Pixel Data"
 220
 221        //==>Take it easy!
 222        //==> Just change the VR !
 223
 224 /*
 225       DataEntry *oldEntry = dynamic_cast<DataEntry *>(entry);
 226       if (oldEntry)
 227       {
 228          VRKey PixelVR;
 229          // 8 bits allocated is a 'O Bytes' , as well as 24 (old ACR-NEMA RGB)
 230          // more than 8 (i.e 12, 16) is a 'O Words'
 231          if ( GetBitsAllocated() == 8 || GetBitsAllocated() == 24 )
 232             PixelVR = "OB";
 233          else
 234             PixelVR = "OW";
 235
 236          // Change only made if usefull
 237          if ( PixelVR != oldEntry->GetVR() )
 238          {
 239             //DictEntry* newDict = DictEntry::New(GrPixel,NumPixel,
 240             //                                    PixelVR,"1","Pixel Data");
 241             //DataEntry *newEntry = DataEntry::New(newDict);
 242             //newDict->Delete();
 243             //newEntry->Copy(entry);
 244             //newEntry->SetBinArea(oldEntry->GetBinArea(),oldEntry->IsSelfArea());
 245             //oldEntry->SetSelfArea(false);
 246
 247             //RemoveEntry(oldEntry);
 248             //AddEntry(newEntry);
 249             //newEntry->Delete();
 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 // Special case:
 474 //  ts["1.2.840.10008.5.1.4.1.1.4.1"] = "Enhanced MR Image Storage";
 475 bool File::GetSpacing(float &xspacing, float &yspacing, float &zspacing)
 476 {
 477       xspacing = yspacing = zspacing = 1.0;
 478       TS *ts = Global::GetTS();
 479       std::string sopclassuid_used;
 480       // D 0002|0002 [UI] [Media Storage SOP Class UID]
 481
 482       //const std::string &mediastoragesopclassuid_str = GetEntryValue(0x0002,0x0002);
 483       const std::string &mediastoragesopclassuid_str = GetEntryString(0x0002,0x0002);
 484       const std::string &mediastoragesopclassuid = ts->GetValue(mediastoragesopclassuid_str);
 485       //D 0008|0016 [UI] [SOP Class UID]
 486       const std::string &sopclassuid_str = GetEntryString(0x0008,0x0016);
 487       const std::string &sopclassuid = ts->GetValue(sopclassuid_str);
 488       if ( mediastoragesopclassuid == GDCM_UNFOUND && sopclassuid == GDCM_UNFOUND )
 489         {
 490         return false;
 491         }
 492       else
 493         {
 494         if( mediastoragesopclassuid == sopclassuid )
 495           {
 496           sopclassuid_used = mediastoragesopclassuid;
 497           }
 498         else
 499           {
 500           gdcmWarningMacro( "Inconsistant SOP Class UID: "
 501             << mediastoragesopclassuid << " and " << sopclassuid );
 502           return false;
 503           }
 504         }
 505       // ok we have now the correc SOP Class UID
 506       if( sopclassuid_used == "Enhanced MR Image Storage" )
 507         {
 508         SeqEntry *PerframeFunctionalGroupsSequence = GetSeqEntry(0x5200,0x9230);
 509         unsigned int n = PerframeFunctionalGroupsSequence->GetNumberOfSQItems();
 510         if( !n ) return false;
 511         SQItem *item1 = PerframeFunctionalGroupsSequence->GetFirstSQItem();
 512         DocEntry *p = item1->GetDocEntry(0x0028,0x9110);
 513         if( !p ) return false;
 514         SeqEntry *seq = dynamic_cast<SeqEntry*>(p);
 515         unsigned int n1 = seq->GetNumberOfSQItems();
 516         if( !n1 ) return false;
 517         SQItem *item2 = seq->GetFirstSQItem();
 518         // D 0028|0030 [DS] [Pixel Spacing] [0.83333331346511\0.83333331346511 ]
 519         DocEntry *p2 = item2->GetDocEntry(0x0028,0x0030);
 520         if( !p2 ) return false;
 521         DataEntry *entry = dynamic_cast<DataEntry *>(p2);
 522         std::string spacing = entry->GetString();
 523         if ( sscanf( spacing.c_str(), "%f\\%f", &yspacing, &xspacing) != 2 )
 524           {
 525           xspacing = yspacing = 1.;
 526           return false;
 527           }
 528         // D 0018|0050 [DS] [Slice Thickness] [1 ]
 529         DocEntry *p3 = item2->GetDocEntry(0x0018,0x0050);
 530         if( !p3 ) return false;
 531         DataEntry *entry2 = dynamic_cast<DataEntry *>(p3);
 532         std::string thickness = entry2->GetString();
 533         if ( sscanf( thickness.c_str(), "%f", &zspacing) != 1 )
 534           {
 535           zspacing = 1.;
 536           return false;
 537           }
 538         return true;
 539         }
 540      return false;
 541    }
 542
 543 /**
 544  * \brief   Retrieve the -unnormalized- number of 'times' of '4D image'.
 545  *          User has to tell gdcm the location of this '4th Dimension component'
 546  *          using SetFourthDimensionLocation() method before.
 547  * \warning The defaulted value is 1.
 548  * @return  The encountered size when found, 1 by default
 549  *          (The file doesn't contain a '4D image'.).
 550  */
 551 int File::GetTSize()
 552 {
 553    if (FourthDimensionLocation == TagKey(0,0) )// 4D location is not set : not a 4D object
 554       return 1;
 555
 556    DataEntry *entry = GetDataEntry(FourthDimensionLocation.GetGroup(),
 557                                    FourthDimensionLocation.GetElement() );
 558    if( !entry )
 559    {
 560       gdcmWarningMacro( " FourthDimensionLocation not found at : " <<
 561                     std::hex << FourthDimensionLocation.GetGroup()
 562                   << "|" << FourthDimensionLocation.GetElement());
 563       return 1;
 564    }
 565    else
 566    {
 567       return (int)entry->GetValue(0);
 568    }
 569 }
 570
 571 /**
 572   * \brief gets the info from 0018,1164 : ImagerPixelSpacing
 573   *                      then 0028,0030 : Pixel Spacing
 574   *             else 1.0
 575   * @return X dimension of a pixel
 576   */
 577 float File::GetXSpacing()
 578 {
 579    float xspacing = 1.0;
 580    float yspacing = 1.0;
 581    float zspacing = 1.0;
 582
 583    uint32_t nbValue;
 584    DataEntry *entry;
 585    bool ok = false;
 586   if ( GetSpacing(xspacing,yspacing,zspacing) )
 587   {
 588     return xspacing;
 589   }
 590  // else fallback
 591
 592 /*
 593 From:David Clunie - view profile
 594 Date:Wed, May 24 2006 1:12 pm
 595 Email:David Clunie <dclu...@dclunie.com>
 596 Groups:comp.protocols.dicom
 597
 598 The short answer is that:
 599
 600 - (0018,1164) describes a spacing equivalent to that which
 601   would be measured off a film in projection radiography
 602
 603 - (0018,7022) does not describe the image pixels themselves,
 604   since detector elements may have been binned to produce
 605   pixels
 606
 607 - (0018,7020) may be different from (0018,7022) since there
 608   may be non-sensitive material separating individual
 609   detectors (i.e. the size is smaller than the spacing
 610   between centers)
 611
 612 Only (0018,1164) is relevant when measuring things; the
 613 detector-specific attributes are there to describe the
 614 acquisition.
 615
 616 David
 617
 618 PS. For ultrasound you need to use Region Calibration.
 619 */
 620
 621 /*
 622 It *SHOULD* first find the IOD and then deduce which tags to read
 623 Eg: Cross section this is in Pixel Spacing (0028,0030)
 624 CR is in Imager Pixel Spacing (0018,1164)
 625 US is in Pixel Aspect Ratio (0028,0034)
 626 RT is in :
 627 (3002,0011) Image Plane Pixel Spacing
 628 (3002,0012) RT Image Position
 629 and
 630 (3004,000c) for deducing Z spacing
 631 */
 632
 633    std::string SOPClassUID = GetEntryString(0x0008,0x0016);
 634
 635    /// \todo check the various SOP Class
 636    ///       to get the Pixel Spacing at the proper location
 637
 638    ///\todo find images to check if it *actually* works
 639
 640    if (Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6")
 641    // Ultrasound Image Storage (Retired)
 642     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6.1")
 643    // Ultrasound Image Storage
 644     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3")
 645    // Ultrasound Multi-Frame Storage (Retired)
 646     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3.1") )
 647    // Ultrasound Multi-FrameImage Storage
 648    {
 649       // - check if  SOPClassUID contains 2 parts (e.g. "4\3")
 650       // - guess how to deduce the spacing (FOV ?, ??)
 651
 652       entry = GetDataEntry(0x0028,0x0034);
 653       if ( entry )
 654       {
 655          nbValue = entry->GetValueCount();
 656          if( nbValue !=2 ) {
 657             gdcmWarningMacro("PixelAspectRatio (0x0028,0x0034) "
 658             << "has a wrong number of values :" << nbValue);
 659          }
 660          xspacing = 1.0; // We get Pixel Aspect Ratio, not Spacing ...
 661          ok = true;
 662       }
 663
 664       if (ok)
 665          return xspacing;
 666    }
 667 /*
 668    if (Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.1") )
 669    // Computed Radiography Image Storage
 670
 671    // CR is in Imager Pixel Spacing (0018,1164)//
 672
 673 */
 674    // go on with old method ...
 675    // ---------------------
 676    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 677
 678    entry = GetDataEntry(0x0018,0x1164);
 679    if( entry )
 680    {
 681       nbValue = entry->GetValueCount();
 682       // Can't use IsValueCountValid because of the complex heuristic.
 683       if( nbValue !=2 )
 684          gdcmWarningMacro("ImagerPixelSpacing (0x0018,0x1164) "
 685          << "has a wrong number of values :" << nbValue);
 686
 687       if( nbValue >= 3 )
 688          xspacing = (float)entry->GetValue(2);
 689       else if( nbValue >= 2 )
 690          xspacing = (float)entry->GetValue(1);
 691       else
 692          xspacing = (float)entry->GetValue(0);
 693
 694       if ( xspacing == 0.0 )
 695          xspacing = 1.0;
 696       return xspacing;
 697    }
 698    else
 699    {
 700       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 701    }
 702
 703    entry = GetDataEntry(0x0028,0x0030);
 704    if( entry )
 705    {
 706       nbValue = entry->GetValueCount();
 707       if( nbValue !=2 )
 708          gdcmWarningMacro("PixelSpacing (0x0018,0x0030) "
 709           << "has a wrong number of values :" << nbValue);
 710
 711       if( nbValue >= 3 )
 712          xspacing = (float)entry->GetValue(2);
 713       else if( nbValue >= 2 )
 714          xspacing = (float)entry->GetValue(1);
 715       else
 716          xspacing = (float)entry->GetValue(0);
 717
 718       if ( xspacing == 0.0 )
 719          xspacing = 1.0;
 720       return xspacing;
 721    }
 722    else
 723    {
 724       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 725    }
 726    return xspacing;
 727 }
 728
 729 /**
 730   * \brief gets the info from 0018,1164 : ImagerPixelSpacing
 731   *               then from   0028,0030 : Pixel Spacing
 732   *             else 1.0
 733   * @return Y dimension of a pixel
 734   */
 735 float File::GetYSpacing()
 736 {
 737    float xspacing = 1., yspacing = 1.0, zspacing = 1.;
 738    uint32_t nbValue;
 739    DataEntry *entry;
 740    bool ok = false;
 741   if ( GetSpacing(xspacing,yspacing,zspacing) )
 742   {
 743     return yspacing;
 744   }
 745  // else fallback
 746
 747    std::string SOPClassUID = GetEntryString(0x0008,0x0016);
 748
 749    /// \todo check the various SOP Class
 750    ///       to get the Pixel Spacing at the proper location
 751
 752    ///\todo find images to check if it *actually* works
 753
 754    if (Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6")
 755    // Ultrasound Image Storage (Retired)
 756     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.6.1")
 757    // Ultrasound Image Storage
 758     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3")
 759    // Ultrasound Multi-Frame Storage (Retired)
 760     || Util::DicomStringEqual( SOPClassUID,"1.2.840.10008.5.1.4.1.1.3.1") )
 761    // Ultrasound Multi-FrameImage Storage
 762    {
 763       // - check if  SOPClassUID contains 2 parts (e.g. "4\3")
 764       // - no way to deduce the spacing/
 765
 766       entry = GetDataEntry(0x0028,0x0034);
 767       if ( entry )
 768       {
 769          nbValue = entry->GetValueCount();
 770          if( nbValue ==2 ) {
 771             yspacing = (float)entry->GetValue(0)/(float)entry->GetValue(1);
 772             //std::cout << "ys " << yspacing << std::endl;
 773             ok = true;
 774       }
 775       else
 776       {
 777          gdcmWarningMacro("PixelAspectRatio (0x0028,0x0034) "
 778                << "has a wrong number of values :" << nbValue);
 779          if (nbValue == 0 ) {
 780             ok = false;
 781          }
 782          else if (nbValue == 1 ) {
 783             yspacing = 1.0; // We get Pixel Aspect Ratio, not Spacing ...
 784             ok = true;
 785          }
 786       }
 787    }
 788
 789       if (ok)
 790          return yspacing;
 791    }
 792
 793    // go on with old method ...
 794    // ---------------------
 795    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 796    yspacing = 1.0;
 797    // To follow David Clunie's advice, we first check ImagerPixelSpacing
 798
 799    entry = GetDataEntry(0x0018,0x1164);
 800    if( entry )
 801    {
 802       yspacing = (float)entry->GetValue(0);
 803
 804       if ( yspacing == 0.0 )
 805          yspacing = 1.0;
 806       return yspacing;
 807    }
 808    else
 809    {
 810       gdcmWarningMacro( "Unfound Imager Pixel Spacing (0018,1164)" );
 811    }
 812
 813    entry = GetDataEntry(0x0028,0x0030);
 814    if( entry )
 815    {
 816       yspacing = (float)entry->GetValue(0);
 817
 818       if ( yspacing == 0.0 )
 819          yspacing = 1.0;
 820       return yspacing;
 821    }
 822    else
 823    {
 824       gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
 825    }
 826
 827    return yspacing;
 828 }
 829
 830 /**
 831  * \brief gets the info from 0018,0088 : Space Between Slices
 832  *                 else from 0018,0050 : Slice Thickness
 833  *                 else 1.0
 834  *
 835  * When an element is missing, we suppose slices join together
 836  * (no overlapping, no interslice gap) but we have no way to check it !
 837  * For *Dicom* images, ZSpacing *should be* calculated using
 838  * XOrigin, YOrigin, ZOrigin (of the top left image corner)
 839  * of 2 consecutive images, and the Orientation
 840  * Computing ZSpacing on a single image is not really meaningfull !
 841  * @return Z dimension of a voxel-to be
 842  */
 843 float File::GetZSpacing()
 844 {
 845
 846    float xspacing = 1.0;
 847    float yspacing = 1.0;
 848    float zspacing = 1.0;
 849    if ( GetSpacing(xspacing,yspacing,zspacing) )
 850    {
 851       return zspacing;
 852    }
 853
 854    // Spacing Between Slices : distance between the middle of 2 slices
 855    // Slices may be :
 856    //   jointives     (Spacing between Slices = Slice Thickness)
 857    //   overlapping   (Spacing between Slices < Slice Thickness)
 858    //   disjointes    (Spacing between Slices > Slice Thickness)
 859    // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
 860    //   It only concerns the MRI guys, not people wanting to visualize volumes
 861    //   If Spacing Between Slices is missing,
 862    //   we suppose slices joint together
 863    DataEntry *entry = GetDataEntry(0x0018,0x0088);
 864    if( entry )
 865    {      zspacing = (float)entry->GetValue(0);
 866
 867       if ( zspacing == 0.0 )
 868          zspacing = 1.0;
 869       return zspacing;
 870    }
 871    else
 872       gdcmWarningMacro("Unfound Spacing Between Slices (0018,0088)");
 873
 874    // if no 'Spacing Between Slices' is found,
 875    // we assume slices join together
 876    // (no overlapping, no interslice gap)
 877    entry = GetDataEntry(0x0018,0x0050);
 878    if( entry )
 879    {
 880       zspacing = (float)entry->GetValue(0);
 881
 882       if ( zspacing == 0.0 )
 883          zspacing = 1.0;
 884       return zspacing;
 885    }
 886    else
 887       gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
 888
 889    // if no 'Spacing Between Slices' is found,
 890    // we assume slices join together
 891    // (no overlapping, no interslice gap)
 892    entry = GetDataEntry(0x3004,0x000c);
 893    if( entry )
 894    {
 895       float z1 = (float)entry->GetValue(0);
 896       float z2 = (float)entry->GetValue(1);
 897       zspacing = z2 - z1; // can be negative...
 898
 899       if ( zspacing == 0.0 )
 900          zspacing = 1.0;
 901       return zspacing;
 902    }
 903
 904    return zspacing;
 905 }
 906
 907 /**
 908  * \brief gets the info from 0020,0032 : Image Position Patient
 909  *                 else from 0020,0030 : Image Position (RET)
 910  *                 else 0.
 911  * @return up-left image corner X position
 912  */
 913 float File::GetXOrigin()
 914 {
 915    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 916    if( !entry )
 917    {
 918       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 919       entry = GetDataEntry(0x0020,0x0030);
 920       if( !entry )
 921       {
 922          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 923          return 0.0f;
 924       }
 925    }
 926
 927    if( entry->GetValueCount() == 3 )
 928    {
 929       if (!entry->IsValueCountValid() )
 930       {
 931          gdcmErrorMacro( "Invalid Value Count" );
 932       }
 933       return (float)entry->GetValue(0);
 934    }
 935    return 0.0f;
 936 }
 937
 938 /**
 939  * \brief gets the info from 0020,0032 : Image Position Patient
 940  *                 else from 0020,0030 : Image Position (RET)
 941  *                 else 0.
 942  * @return up-left image corner Y position
 943  */
 944 float File::GetYOrigin()
 945 {
 946    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 947    if( !entry )
 948    {
 949       gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
 950       entry = GetDataEntry(0x0020,0x0030);
 951       if( !entry )
 952       {
 953          gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
 954          return 0.0f;
 955       }
 956    }
 957
 958    if( entry->GetValueCount() == 3 )
 959    {
 960       if (!entry->IsValueCountValid() )
 961       {
 962          gdcmErrorMacro( "Invalid Value Count" );
 963       }
 964       return (float)entry->GetValue(1);
 965    }
 966    return 0.0f;
 967 }
 968
 969 /**
 970  * \brief gets the info from 0020,0032 : Image Position Patient
 971  *                 else from 0020,0030 : Image Position (RET)
 972  *                 else from 0020,1041 : Slice Location
 973  *                 else from 0020,0050 : Location
 974  *                 else 0.
 975  * @return up-left image corner Z position
 976  */
 977 float File::GetZOrigin()
 978 {
 979    DataEntry *entry = GetDataEntry(0x0020,0x0032);
 980    if( entry )
 981    {
 982       if( entry->GetValueCount() == 3 )
 983       {
 984          if (!entry->IsValueCountValid() )
 985          {
 986             gdcmErrorMacro( "Invalid Value Count" );
 987          }
 988          return (float)entry->GetValue(2);
 989       }
 990       gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
 991       return 0.0f;
 992    }
 993
 994    entry = GetDataEntry(0x0020,0x0030);
 995    if( entry )
 996    {
 997       if( entry->GetValueCount() == 3 )
 998       {
 999          if (!entry->IsValueCountValid() )
1000          {
1001             gdcmErrorMacro( "Invalid Value Count" );
1002          }
1003          return (float)entry->GetValue(2);
1004       }
1005       gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
1006       return 0.0f;
1007    }
1008
1009    // for *very* old ACR-NEMA images
1010    entry = GetDataEntry(0x0020,0x1041);
1011    if( entry )
1012    {
1013       if( entry->GetValueCount() == 1 )
1014       {
1015          if (!entry->IsValueCountValid() )
1016          {
1017             gdcmErrorMacro( "Invalid Value Count" );
1018          }
1019          return (float)entry->GetValue(0); // VM=1 !
1020       }
1021       gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
1022       return 0.0f;
1023    }
1024
1025    entry = GetDataEntry(0x0020,0x0050);
1026    if( entry )
1027    {
1028       if( entry->GetValueCount() == 1 )
1029       {
1030          if (!entry->IsValueCountValid() )
1031          {
1032             gdcmErrorMacro( "Invalid Value Count" );
1033          }
1034          return (float)entry->GetValue(0);
1035       }
1036       gdcmWarningMacro( "Wrong Location (0020,0050)");
1037       return 0.0f;
1038    }
1039    return 0.; // Hopeless
1040 }
1041
1042 /**
1043   * \brief gets the info from 0020,0037 : Image Orientation Patient
1044   *                   or from 0020 0035 : Image Orientation (RET)
1045   *
1046   * (needed to organize DICOM files based on their x,y,z position)
1047   *
1048   * @param iop adress of the (6)float array to receive values.
1049   *        (defaulted as 1.,0.,0.,0.,1.,0. if nothing -or inconsistent stuff-
1050   *        is found.
1051   * @return true when one of the tag -with consistent values- is found
1052   *         false when nothing or inconsistent stuff - is found
1053   */
1054 bool File::GetImageOrientationPatient( float iop[6] )
1055 {
1056    std::string strImOriPat;
1057    //iop is supposed to be float[6]
1058    iop[0] = iop[4] = 1.;
1059    iop[1] = iop[2] = iop[3] = iop[5] = 0.;
1060
1061    // 0020 0037 DS REL Image Orientation (Patient)
1062    if ( (strImOriPat = GetEntryString(0x0020,0x0037)) != GDCM_UNFOUND )
1063    {
1064       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
1065           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
1066       {
1067          gdcmWarningMacro( "Wrong Image Orientation Patient (0020,0037)."
1068                         << " Less than 6 values were found." );
1069          return false;
1070       }
1071       return true;
1072    }
1073    //For ACR-NEMA
1074    // 0020 0035 DS REL Image Orientation (RET)
1075    else if ( (strImOriPat = GetEntryString(0x0020,0x0035)) != GDCM_UNFOUND )
1076    {
1077       if ( sscanf( strImOriPat.c_str(), "%f \\ %f \\%f \\%f \\%f \\%f ",
1078           &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
1079       {
1080          gdcmWarningMacro( "wrong Image Orientation Patient (0020,0035). "
1081                         << "Less than 6 values were found." );
1082          return false;
1083       }
1084       return true;
1085    }
1086    return false;
1087 }
1088
1089 /**
1090   * \brief gets the cosine of image X axis, against patient X axis
1091   *        (Sorry, but Python needs it :-( )
1092   * @return cosine of image X axis, against patient X axis
1093   */
1094 float File::GetXCosineOnX()
1095 {
1096    float iop[6];
1097    GetImageOrientationPatient( iop );
1098    return(iop[0]);
1099 }
1100
1101 /**
1102   * \brief gets the cosine of image X axis, against patient Y axis
1103   *        (Sorry, but Python needs it :-( )
1104   * @return cosine of image X axis, against patient Y axis
1105   */
1106 float File::GetXCosineOnY()
1107 {
1108    float iop[6];
1109    GetImageOrientationPatient( iop );
1110    return(iop[1]);
1111 }
1112
1113 /**
1114   * \brief gets the cosine of image X axis, against patient Z axis
1115   *        (Sorry, but Python needs it :-( )
1116   * @return cosine of image X axis, against patient Z axis
1117   */
1118 float File::GetXCosineOnZ()
1119 {
1120    float iop[6];
1121    GetImageOrientationPatient( iop );
1122    return(iop[2]);
1123 }
1124
1125 /**
1126   * \brief gets the cosine of image Y axis, against patient X axis
1127   *        (Sorry, but Python needs it :-( )
1128   * @return cosine of image Y axis, against patient X axis
1129   */
1130 float File::GetYCosineOnX()
1131 {
1132    float iop[6];
1133    GetImageOrientationPatient( iop );
1134    return(iop[3]);
1135 }
1136
1137 /**
1138   * \brief gets the cosine of image Y axis, against patient Y axis
1139   *        (Sorry, but Python needs it :-( )
1140   * @return cosine of image Y axis, against patient Y axis
1141   */
1142 float File::GetYCosineOnY()
1143 {
1144    float iop[6];
1145    GetImageOrientationPatient( iop );
1146    return(iop[4]);
1147 }
1148
1149 /**
1150   * \brief gets the cosine of image Y axis, against patient Z axis
1151   *        (Sorry, but Python needs it :-( )
1152   * @return cosine of image Y axis, against patient Z axis
1153   */
1154 float File::GetYCosineOnZ()
1155 {
1156    float iop[6];
1157    GetImageOrientationPatient( iop );
1158    return(iop[5]);
1159 }
1160 /**
1161   * \brief gets the info from 0020,0032 : Image Position Patient
1162   *                   or from 0020 0030 : Image Position (RET)
1163   *
1164   * @param ipp adress of the (3)float array to receive values.
1165   *        (defaulted as 0.,0.,0. if nothing -or inconsistent stuff-
1166   *        is found.
1167   * @return true when one of the tag -with consistent values- is found
1168   *         false when nothing or inconsistent stuff - is found
1169   */
1170 bool File::GetImagePositionPatient( float ipp[3] )
1171 {
1172    std::string strImPosiPat;
1173    //ipp is supposed to be float[3]
1174    ipp[0] = ipp[1] = ipp[2] = 0.;
1175
1176    // 0020 0032 DS REL Image Position (Patient)
1177    strImPosiPat = GetEntryString(0x0020,0x0032);
1178    if ( strImPosiPat != GDCM_UNFOUND )
1179    {
1180       if ( sscanf( strImPosiPat.c_str(), "%f \\ %f \\%f ",
1181           &ipp[0], &ipp[1], &ipp[2]) != 3 )
1182       {
1183          gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)."
1184                         << " Less than 3 values were found." );
1185          return false;
1186       }
1187       return true;
1188    }
1189    //For ACR-NEMA
1190    // 0020 0030 DS REL Image Position (RET)
1191    else if ( (strImPosiPat = GetEntryString(0x0020,0x0030)) != GDCM_UNFOUND )
1192    {
1193       if ( sscanf( strImPosiPat.c_str(), "%f \\ %f \\%f ",
1194           &ipp[0], &ipp[1], &ipp[2]) != 3 )
1195       {
1196          gdcmWarningMacro( "wrong Image Position Patient (0020,0030). "
1197                         << "Less than 3 values were found." );
1198          return false;
1199       }
1200       return true;
1201    }
1202    return false;
1203 }
1204
1205 /**
1206  * \brief   Retrieve the number of Bits Stored (actually used)
1207  *          (as opposed to number of Bits Allocated)
1208  * @return  The encountered number of Bits Stored, 0 by default.
1209  *          0 means the file is NOT USABLE. The caller has to check it !
1210  */
1211 int File::GetBitsStored()
1212 {
1213    DataEntry *entry = GetDataEntry(0x0028,0x0101);
1214    if( !entry )
1215    {
1216       gdcmWarningMacro("BitsStored (0028,0101) is supposed to be mandatory");
1217       return 0;
1218    }
1219    return (int)entry->GetValue(0);
1220 }
1221
1222 /**
1223  * \brief   Retrieve the number of Bits Allocated
1224  *          (8, 12 -compacted ACR-NEMA files-, 16, 24 -old RGB ACR-NEMA files-,)
1225  * @return  The encountered Number of Bits Allocated, 0 by default.
1226  *          0 means the file is NOT USABLE. The caller has to check it !
1227  */
1228 int File::GetBitsAllocated()
1229 {
1230    DataEntry *entry = GetDataEntry(0x0028,0x0100);
1231    if( !entry )
1232    {
1233       gdcmWarningMacro("BitsAllocated (0028,0100) is supposed to be mandatory");
1234       return 0;
1235    }
1236    return (int)entry->GetValue(0);
1237 }
1238
1239 /**
1240  * \brief   Retrieve the high bit position.
1241  * \warning The method defaults to 0 when information is missing.
1242  *          The responsability of checking this value is left to the caller.
1243  * @return  The high bit position when present. 0 when missing.
1244  */
1245 int File::GetHighBitPosition()
1246 {
1247    DataEntry *entry = GetDataEntry(0x0028,0x0102);
1248    if( !entry )
1249    {
1250       gdcmWarningMacro("HighBitPosition (0028,0102) is supposed to be mandatory");
1251       return 0;
1252    }
1253    return (int)entry->GetValue(0);
1254 }
1255
1256 /**
1257  * \brief   Retrieve the number of Samples Per Pixel
1258  *          (1 : gray level, 3 : RGB/YBR -1 or 3 Planes-)
1259  * @return  The encountered number of Samples Per Pixel, 1 by default.
1260  *          (we assume Gray level Pixels)
1261  */
1262 int File::GetSamplesPerPixel()
1263 {
1264    DataEntry *entry = GetDataEntry(0x0028,0x0002);
1265    if( !entry )
1266    {
1267       gdcmWarningMacro("SamplesPerPixel (0028,0002) is supposed to be mandatory");
1268       return 1; // Well, it's supposed to be mandatory ...
1269                 // but sometimes it's missing : *we* assume Gray pixels
1270    }
1271    return (int)entry->GetValue(0);
1272 }
1273
1274 /**
1275  * \brief   Retrieve the Planar Configuration for RGB images
1276  *          (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
1277  * @return  The encountered Planar Configuration, 0 by default.
1278  */
1279 int File::GetPlanarConfiguration()
1280 {
1281    DataEntry *entry = GetDataEntry(0x0028,0x0006);
1282    if( !entry )
1283    {
1284       return 0;
1285    }
1286    return (int)entry->GetValue(0);
1287 }
1288
1289 /**
1290  * \brief   Return the size (in bytes) of a single pixel of data.
1291  * @return  The size in bytes of a single pixel of data; 0 by default
1292  *          0 means the file is NOT USABLE; the caller will have to check
1293  */
1294 int File::GetPixelSize()
1295 {
1296    // 0028 0100 US IMG Bits Allocated
1297    // (in order no to be messed up by old ACR-NEMA RGB images)
1298    assert( !(GetEntryString(0x0028,0x0100) == "24") );
1299
1300    std::string pixelType = GetPixelType();
1301    if ( pixelType ==  "8U" || pixelType == "8S" )
1302    {
1303       return 1;
1304    }
1305    if ( pixelType == "16U" || pixelType == "16S")
1306    {
1307       return 2;
1308    }
1309    if ( pixelType == "32U" || pixelType == "32S")
1310    {
1311       return 4;
1312    }
1313    if ( pixelType == "FD" )
1314    {
1315       return 8;
1316    }
1317    gdcmWarningMacro( "Unknown pixel type: " << pixelType);
1318    return 0;
1319 }
1320
1321 /**
1322  * \brief   Build the Pixel Type of the image.
1323  *          Possible values are:
1324  *          - 8U  unsigned  8 bit,
1325  *          - 8S    signed  8 bit,
1326  *          - 16U unsigned 16 bit,
1327  *          - 16S   signed 16 bit,
1328  *          - 32U unsigned 32 bit,
1329  *          - 32S   signed 32 bit,
1330  *          - FD floating double 64 bits (Not kosher DICOM, but so usefull!)
1331  * \warning 12 bit images appear as 16 bit.
1332  *          24 bit images appear as 8 bit + photochromatic interp ="RGB "
1333  *                                        + Planar Configuration = 0
1334  * @return  0S if nothing found. NOT USABLE file. The caller has to check
1335  */
1336 std::string File::GetPixelType()
1337 {
1338    std::string bitsAlloc = GetEntryString(0x0028, 0x0100); // Bits Allocated
1339    if ( bitsAlloc == GDCM_UNFOUND )
1340    {
1341       gdcmWarningMacro( "Bits Allocated (0028,0100) supposed to be mandatory");
1342       bitsAlloc = "16"; // default and arbitrary value, not to polute the output
1343    }
1344
1345    else if ( bitsAlloc == "64" )
1346    {
1347       return "FD";
1348    }
1349      // useless since we have to bypass a bug ( >8 && < 16)
1350    else if ( bitsAlloc == "12" )
1351    {
1352       // It will be unpacked
1353       bitsAlloc = "16";
1354    }
1355
1356    else if ( bitsAlloc == "24" )
1357    {
1358       // (in order no to be messed up by old RGB images)
1359       bitsAlloc = "8";
1360    }
1361
1362    int i= atoi(bitsAlloc.c_str());  // fix a bug in some headers
1363    if ( i > 8 &&  i < 16 )
1364    {
1365       bitsAlloc = "16";
1366    }
1367
1368    std::string sign;
1369    if( IsSignedPixelData() )
1370    {
1371       sign = "S";
1372    }
1373    else
1374    {
1375       sign = "U";
1376    }
1377    return bitsAlloc + sign;
1378 }
1379
1380 /**
1381  * \brief   Check whether the pixels are signed (1) or UNsigned (0) data.
1382  * \warning The method defaults to false (UNsigned) when tag 0028|0103
1383  *          is missing.
1384  *          The responsability of checking this value is left to the caller
1385  *          (NO transformation is performed on the pixels to make then >0)
1386  * @return  True when signed, false when UNsigned
1387  */
1388 bool File::IsSignedPixelData()
1389 {
1390    DataEntry *entry = GetDataEntry(0x0028, 0x0103);//"Pixel Representation"
1391    if( !entry )
1392    {
1393       gdcmWarningMacro( "Pixel Representation (0028,0103) supposed to be "
1394                       << "mandatory");
1395       return false;
1396    }
1397    return entry->GetValue(0) != 0;
1398 }
1399
1400 /**
1401  * \brief   Check whether this a monochrome picture (gray levels) or not,
1402  *          using "Photometric Interpretation" tag (0x0028,0x0004).
1403  * @return  true when "MONOCHROME1" or "MONOCHROME2". False otherwise.
1404  */
1405 bool File::IsMonochrome()
1406 {
1407    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1408    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1")
1409       || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") )
1410    {
1411       return true;
1412    }
1413    if ( PhotometricInterp == GDCM_UNFOUND )
1414    {
1415       gdcmWarningMacro( "Photometric Interpretation (0028,0004) supposed to be "
1416                          << "mandatory");
1417       // to deal with old ACR-NEMA images
1418       if (GetNumberOfScalarComponents() == 1)
1419          return true;
1420    }
1421    return false;
1422 }
1423
1424 /**
1425  * \brief   Check whether this a MONOCHROME1 picture (high values = dark)
1426  *            or not using "Photometric Interpretation" tag (0x0028,0x0004).
1427  * @return  true when "MONOCHROME1" . False otherwise.
1428  */
1429 bool File::IsMonochrome1()
1430 {
1431    const std::string &PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1432    if (  Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1") )
1433    {
1434       return true;
1435    }
1436    if ( PhotometricInterp == GDCM_UNFOUND )
1437    {
1438       gdcmWarningMacro( "Photometric Interpretation (0028,0004) : supposed to"
1439       << " be mandatory! ");
1440    }
1441    return false;
1442 }
1443
1444 /**
1445  * \brief   Check whether this a "PALETTE COLOR" picture or not by accessing
1446  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1447  * @return  true when "PALETTE COLOR". False otherwise.
1448  */
1449 bool File::IsPaletteColor()
1450 {
1451    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1452    if (   PhotometricInterp == "PALETTE COLOR " )
1453    {
1454       return true;
1455    }
1456    if ( PhotometricInterp == GDCM_UNFOUND )
1457    {
1458       gdcmDebugMacro( "Not found : Palette color (0028,0004)");
1459    }
1460    return false;
1461 }
1462
1463 /**
1464  * \brief   Check whether this a "YBR_FULL" color picture or not by accessing
1465  *          the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
1466  * @return  true when "YBR_FULL". False otherwise.
1467  */
1468 bool File::IsYBRFull()
1469 {
1470    std::string PhotometricInterp = GetEntryString( 0x0028, 0x0004 );
1471    if (   PhotometricInterp == "YBR_FULL" )
1472    {
1473       return true;
1474    }
1475    if ( PhotometricInterp == GDCM_UNFOUND )
1476    {
1477       gdcmDebugMacro( "Not found : YBR Full (0028,0004)");
1478    }
1479    return false;
1480 }
1481
1482 /**
1483   * \brief tells us if LUT are used
1484   * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data'
1485   *          are NOT considered as LUT, since nobody knows
1486   *          how to deal with them
1487   *          Please warn me if you know sbdy that *does* know ... jprx
1488   * @return true if LUT Descriptors and LUT Tables were found
1489   */
1490 bool File::HasLUT()
1491 {
1492    // Check the presence of the LUT Descriptors, and LUT Tables
1493    // LutDescriptorRed
1494    if ( !GetDocEntry(0x0028,0x1101) )
1495    {
1496       return false;
1497    }
1498    // LutDescriptorGreen
1499    if ( !GetDocEntry(0x0028,0x1102) )
1500    {
1501       return false;
1502    }
1503    // LutDescriptorBlue
1504    if ( !GetDocEntry(0x0028,0x1103) )
1505    {
1506       return false;
1507    }
1508    // Red Palette Color Lookup Table Data
1509    bool segmented;
1510    segmented = GetDocEntry(0x0028,0x1221) &&
1511      GetDocEntry(0x0028,0x1222) &&
1512      GetDocEntry(0x0028,0x1223);
1513    if( segmented ) return true;
1514
1515    if( !GetDocEntry(0x0028,0x1201) )
1516    {
1517       return false;
1518    }
1519    // Green Palette Color Lookup Table Data
1520    if ( !GetDocEntry(0x0028,0x1202) )
1521    {
1522       return false;
1523    }
1524    // Blue Palette Color Lookup Table Data
1525    if ( !GetDocEntry(0x0028,0x1203) )
1526    {
1527       return false;
1528    }
1529
1530    // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent)
1531    //         NOT taken into account, but we don't know how to use it ...
1532    return true;
1533 }
1534
1535 /**
1536   * \brief gets the info from 0028,1101 : Lookup Table Desc-Red
1537   *             else 0
1538   * @return Lookup Table number of Bits , 0 by default
1539   *          when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
1540   * @ return bit number of each LUT item
1541   */
1542 int File::GetLUTNbits()
1543 {
1544    std::vector<std::string> tokens;
1545    int lutNbits;
1546
1547    //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red
1548    //                                = Lookup Table Desc-Blue
1549    // Consistency already checked in GetLUTLength
1550    std::string lutDescription = GetEntryString(0x0028,0x1101);
1551    if ( lutDescription == GDCM_UNFOUND )
1552    {
1553       return 0;
1554    }
1555
1556    tokens.clear(); // clean any previous value
1557    Util::Tokenize ( lutDescription, tokens, "\\" );
1558    //LutLength=atoi(tokens[0].c_str());
1559    //LutDepth=atoi(tokens[1].c_str());
1560
1561    lutNbits = atoi( tokens[2].c_str() );
1562    tokens.clear();
1563
1564    return lutNbits;
1565 }
1566
1567 // Special case:
1568 //  ts["1.2.840.10008.5.1.4.1.1.4.1"] = "Enhanced MR Image Storage";
1569    bool File::GetRescaleSlopeIntercept(double &slope, double &intercept)
1570    {
1571       slope = 1.0;
1572       intercept = 0.0;
1573       TS *ts = Global::GetTS();
1574       std::string sopclassuid_used;
1575       // D 0002|0002 [UI] [Media Storage SOP Class UID]
1576       const std::string &mediastoragesopclassuid_str = GetEntryString(0x0002,0x0002);
1577       const std::string &mediastoragesopclassuid = ts->GetValue(mediastoragesopclassuid_str);
1578       //D 0008|0016 [UI] [SOP Class UID]
1579       const std::string &sopclassuid_str = GetEntryString(0x0008,0x0016);
1580       const std::string &sopclassuid = ts->GetValue(sopclassuid_str);
1581       if ( mediastoragesopclassuid == GDCM_UNFOUND && sopclassuid == GDCM_UNFOUND )
1582         {
1583         return false;
1584         }
1585       else
1586         {
1587         if( mediastoragesopclassuid == sopclassuid )
1588           {
1589           sopclassuid_used = mediastoragesopclassuid;
1590           }
1591         else
1592           {
1593           gdcmWarningMacro( "Inconsistant SOP Class UID: "
1594             << mediastoragesopclassuid << " and " << sopclassuid );
1595           return false;
1596           }
1597         }
1598       // ok we have now the correc SOP Class UID
1599       if( sopclassuid_used == "Enhanced MR Image Storage" )
1600         {
1601         SeqEntry *PerframeFunctionalGroupsSequence = GetSeqEntry(0x5200,0x9230);
1602         unsigned int n = PerframeFunctionalGroupsSequence->GetNumberOfSQItems();
1603         if( !n ) return false;
1604         SQItem *item1 = PerframeFunctionalGroupsSequence->GetFirstSQItem();
1605         DocEntry *p = item1->GetDocEntry(0x0028,0x9145);
1606         if( !p ) return false;
1607         SeqEntry *seq = dynamic_cast<SeqEntry*>(p);
1608         unsigned int n1 = seq->GetNumberOfSQItems();
1609         if( !n1 ) return false;
1610         SQItem *item2 = seq->GetFirstSQItem();
1611         // D 0028|1052 [DS] [Rescale Intercept] [0 ]
1612         DocEntry *p2 = item2->GetDocEntry(0x0028,0x1052);
1613         if( !p2 ) return false;
1614         DataEntry *entry = dynamic_cast<DataEntry *>(p2);
1615         std::string intercept_str = entry->GetString();
1616         if ( sscanf( intercept_str.c_str(), "%lf", &intercept) != 1 )
1617           {
1618           intercept = 0.;
1619           return false;
1620           }
1621         // D 0028|1053 [DS] [Rescale Slope] [5.65470085470085]
1622         DocEntry *p3 = item2->GetDocEntry(0x0028,0x1053);
1623         if( !p3 ) return false;
1624         DataEntry *entry2 = dynamic_cast<DataEntry *>(p3);
1625         std::string slope_str = entry2->GetString();
1626         if ( sscanf( slope_str.c_str(), "%lf", &slope) != 1 )
1627           {
1628           slope = 1.;
1629           return false;
1630           }
1631         return true;
1632         }
1633      return false;
1634    }
1635
1636 /**
1637  *\brief gets the info from 0028,1052 : Rescale Intercept
1638  * @return Rescale Intercept. defaulted to 0.0 if not found or empty
1639  */
1640 double File::GetRescaleIntercept()
1641 {
1642    // 0028 1052 DS IMG Rescale Intercept
1643    DataEntry *entry = GetDataEntry(0x0028, 0x1052);
1644    if( !entry )
1645    {
1646       gdcmWarningMacro( "Missing Rescale Intercept (0028,1052)");
1647       return 0.0f;
1648    }
1649    return (float)entry->GetValue(0);
1650
1651 }
1652
1653 /**
1654  *\brief   gets the info from 0028,1053 : Rescale Slope
1655  * @return Rescale Slope. defaulted to 1.0 if not found or empty
1656  */
1657 double File::GetRescaleSlope()
1658 {
1659    double resInter = 0.;
1660    double resSlope = 1.;
1661    if ( GetRescaleSlopeIntercept(resSlope, resInter) )
1662      {
1663      return resSlope;
1664      }
1665    //0028 1053 DS IMG Rescale Slope
1666    std::string strRescSlope = GetEntryString(0x0028,0x1053);
1667    if ( strRescSlope != GDCM_UNFOUND )
1668    {
1669       if ( sscanf( strRescSlope.c_str(), "%lf ", &resSlope) != 1 )
1670       {
1671          // bug in the element 0x0028,0x1053
1672          gdcmWarningMacro( "Rescale Slope (0028,1053) is empty.");
1673       }
1674    }
1675
1676    return resSlope;
1677 }
1678
1679 /**
1680  * \brief This function is intended to user who doesn't want
1681  *   to have to manage a LUT and expects to get an RBG Pixel image
1682  *   (or a monochrome one, if no LUT found ...)
1683  * \warning to be used with GetImagePixels()
1684  * @return 1 if Gray level, 3 if Color (RGB, YBR, *or PALETTE COLOR*)
1685  */
1686 int File::GetNumberOfScalarComponents()
1687 {
1688    if ( GetSamplesPerPixel() == 3 )
1689    {
1690       return 3;
1691    }
1692
1693    // 0028 0100 US IMG Bits Allocated
1694    // (in order no to be messed up by old RGB images)
1695    if ( GetEntryString(0x0028,0x0100) == "24" )
1696    {
1697       return 3;
1698    }
1699
1700    std::string strPhotometricInterpretation = GetEntryString(0x0028,0x0004);
1701
1702    if ( ( strPhotometricInterpretation == "PALETTE COLOR ") )
1703    {
1704       if ( HasLUT() )// PALETTE COLOR is NOT enough
1705       {
1706          return 3;
1707       }
1708       else
1709       {
1710          return 1;
1711       }
1712    }
1713
1714    // beware of trailing space at end of string
1715    // DICOM tags are never of odd length
1716    if ( strPhotometricInterpretation == GDCM_UNFOUND   ||
1717         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") ||
1718         Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") )
1719    {
1720       return 1;
1721    }
1722    else
1723    {
1724       // we assume that *all* kinds of YBR are dealt with
1725       return 3;
1726    }
1727 }
1728
1729 /**
1730  * \brief This function is intended to user that DOESN'T want
1731  *  to get RGB pixels image when it's stored as a PALETTE COLOR image
1732  *   - the (vtk) user is supposed to know how deal with LUTs -
1733  * \warning to be used with GetImagePixelsRaw()
1734  * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -)
1735  */
1736 int File::GetNumberOfScalarComponentsRaw()
1737 {
1738    // 0028 0100 US IMG Bits Allocated
1739    // (in order no to be messed up by old RGB images)
1740    if ( File::GetEntryString(0x0028,0x0100) == "24" )
1741    {
1742       return 3;
1743    }
1744
1745    // we assume that *all* kinds of YBR are dealt with
1746    return GetSamplesPerPixel();
1747 }
1748
1749 /**
1750  * \brief   Recover the offset (from the beginning of the file)
1751  *          of *image* pixels (not *icone image* pixels, if any !)
1752  * @return Pixel Offset
1753  */
1754 size_t File::GetPixelOffset()
1755 {
1756    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1757    if ( pxlElement )
1758    {
1759       return pxlElement->GetOffset();
1760    }
1761    else
1762    {
1763       gdcmWarningMacro( "Big trouble : Pixel Element ("
1764                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1765       return 0;
1766    }
1767 }
1768
1769 /**
1770  * \brief   Recover the pixel area length (in Bytes)
1771  * @return Pixel Element Length, as stored in the header
1772  *         (NOT the memory space necessary to hold the Pixels
1773  *          -in case of embeded compressed image-)
1774  *         0 : NOT USABLE file. The caller has to check.
1775  */
1776 size_t File::GetPixelAreaLength()
1777 {
1778    DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1779    if ( pxlElement )
1780    {
1781       return pxlElement->GetLength();
1782    }
1783    else
1784    {
1785       gdcmWarningMacro( "Big trouble : Pixel Element ("
1786                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1787       return 0;
1788    }
1789 }
1790
1791 /**
1792  * \brief Adds the characteristics of a new element we want to anonymize
1793  * @param   group  Group number of the target tag.
1794  * @param   elem Element number of the target tag.
1795  * @param   value new value (string) to substitute with
1796  */
1797 void File::AddAnonymizeElement (uint16_t group, uint16_t elem,
1798                                 std::string const &value)
1799 {
1800    DicomElement el;
1801    el.Group = group;
1802    el.Elem  = elem;
1803    el.Value = value;
1804    UserAnonymizeList.push_back(el);
1805 }
1806
1807 /**
1808  * \brief Overwrites in the file the values of the DicomElements
1809  *       held in the list
1810  */
1811 void File::AnonymizeNoLoad()
1812 {
1813    std::fstream *fp = new std::fstream(Filename.c_str(),
1814                               std::ios::in | std::ios::out | std::ios::binary);
1815    GDCM_NAME_SPACE::DocEntry *d;
1816    uint32_t offset;
1817    uint32_t lgth;
1818    uint32_t valLgth = 0;
1819    std::string *spaces;
1820    for (ListElements::iterator it = UserAnonymizeList.begin();
1821                                it != UserAnonymizeList.end();
1822                              ++it)
1823    {
1824
1825       //std::cout << "File::AnonymizeNoLoad -------" << std::hex <<(*it).Group <<"|"<<
1826       //         (*it).Elem
1827       //         << "[" << (*it).Value << "] "<< std::dec << std::endl;
1828       d = GetDocEntry( (*it).Group, (*it).Elem);
1829
1830       if ( d == NULL)
1831          continue;
1832
1833       if ( dynamic_cast<SeqEntry *>(d) )
1834       {
1835          gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1836          continue;
1837       }
1838
1839       valLgth = (*it).Value.size();
1840       if (valLgth == 0)
1841          continue;
1842
1843       offset = d->GetOffset();
1844       lgth =   d->GetLength();
1845
1846       //std::cout << "lgth " << lgth << " valLgth " << valLgth << std::endl;
1847       if (valLgth < lgth)
1848       {
1849          spaces = new std::string( lgth-valLgth, ' ');
1850          (*it).Value = (*it).Value + *spaces;
1851          //std::cout << "[" << (*it).Value << "] " << lgth << std::endl;
1852          delete spaces;
1853       }
1854       fp->seekp( offset, std::ios::beg );
1855       fp->write( (*it).Value.c_str(), lgth );
1856
1857    }
1858    fp->close();
1859    delete fp;
1860 }
1861
1862 /**
1863  * \brief anonymize a File (remove Patient's personal info passed with
1864  *        AddAnonymizeElement()
1865  * \note You cannot Anonymize a DataEntry (to be fixed)
1866  */
1867 bool File::AnonymizeFile()
1868 {
1869    // If Anonymisation list is empty, let's perform some basic anonymization
1870    if ( UserAnonymizeList.begin() == UserAnonymizeList.end() )
1871    {
1872       // If exist, replace by spaces
1873       SetEntryString("  ",0x0010, 0x2154); // Telephone
1874       SetEntryString("  ",0x0010, 0x1040); // Adress
1875       SetEntryString("  ",0x0010, 0x0020); // Patient ID
1876
1877       DocEntry *patientNameHE = GetDocEntry (0x0010, 0x0010);
1878
1879       if ( patientNameHE ) // we replace it by Study Instance UID (why not ?)
1880       {
1881          std::string studyInstanceUID =  GetEntryString (0x0020, 0x000d);
1882          if ( studyInstanceUID != GDCM_UNFOUND )
1883          {
1884             SetEntryString(studyInstanceUID, 0x0010, 0x0010);
1885          }
1886          else
1887          {
1888             SetEntryString("anonymized", 0x0010, 0x0010);
1889          }
1890       }
1891    }
1892    else
1893    {
1894       GDCM_NAME_SPACE::DocEntry *d;
1895       for (ListElements::iterator it = UserAnonymizeList.begin();
1896                                   it != UserAnonymizeList.end();
1897                                 ++it)
1898       {
1899          d = GetDocEntry( (*it).Group, (*it).Elem);
1900
1901          if ( d == NULL)
1902             continue;
1903
1904          if ( dynamic_cast<SeqEntry *>(d) )
1905          {
1906             gdcmWarningMacro( "You cannot 'Anonymize' a SeqEntry ");
1907             continue;
1908          }
1909
1910          if ( dynamic_cast<DataEntry *>(d) )
1911          {
1912             gdcmWarningMacro( "To 'Anonymize' a DataEntry, better use AnonymizeNoLoad (FIXME) ");
1913             continue;
1914          }
1915          else
1916             SetEntryString ((*it).Value, (*it).Group, (*it).Elem);
1917       }
1918 }
1919
1920   // In order to make definitively impossible any further identification
1921   // remove or replace all the stuff that contains a Date
1922
1923 //0008 0012 DA ID Instance Creation Date
1924 //0008 0020 DA ID Study Date
1925 //0008 0021 DA ID Series Date
1926 //0008 0022 DA ID Acquisition Date
1927 //0008 0023 DA ID Content Date
1928 //0008 0024 DA ID Overlay Date
1929 //0008 0025 DA ID Curve Date
1930 //0008 002a DT ID Acquisition Datetime
1931 //0018 9074 DT ACQ Frame Acquisition Datetime
1932 //0018 9151 DT ACQ Frame Reference Datetime
1933 //0018 a002 DT ACQ Contribution Date Time
1934 //0020 3403 SH REL Modified Image Date (RET)
1935 //0032 0032 DA SDY Study Verified Date
1936 //0032 0034 DA SDY Study Read Date
1937 //0032 1000 DA SDY Scheduled Study Start Date
1938 //0032 1010 DA SDY Scheduled Study Stop Date
1939 //0032 1040 DA SDY Study Arrival Date
1940 //0032 1050 DA SDY Study Completion Date
1941 //0038 001a DA VIS Scheduled Admission Date
1942 //0038 001c DA VIS Scheduled Discharge Date
1943 //0038 0020 DA VIS Admitting Date
1944 //0038 0030 DA VIS Discharge Date
1945 //0040 0002 DA PRC Scheduled Procedure Step Start Date
1946 //0040 0004 DA PRC Scheduled Procedure Step End Date
1947 //0040 0244 DA PRC Performed Procedure Step Start Date
1948 //0040 0250 DA PRC Performed Procedure Step End Date
1949 //0040 2004 DA PRC Issue Date of Imaging Service Request
1950 //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
1951 //0040 4011 DT PRC Expected Completion Date and Time
1952 //0040 a030 DT PRC Verification Date Time
1953 //0040 a032 DT PRC Observation Date Time
1954 //0040 a120 DT PRC DateTime
1955 //0040 a121 DA PRC Date
1956 //0040 a13a DT PRC Referenced Datetime
1957 //0070 0082 DA ??? Presentation Creation Date
1958 //0100 0420 DT ??? SOP Autorization Date and Time
1959 //0400 0105 DT ??? Digital Signature DateTime
1960 //2100 0040 DA PJ Creation Date
1961 //3006 0008 DA SSET Structure Set Date
1962 //3008 0024 DA ??? Treatment Control Point Date
1963 //3008 0054 DA ??? First Treatment Date
1964 //3008 0056 DA ??? Most Recent Treatment Date
1965 //3008 0162 DA ??? Safe Position Exit Date
1966 //3008 0166 DA ??? Safe Position Return Date
1967 //3008 0250 DA ??? Treatment Date
1968 //300a 0006 DA RT RT Plan Date
1969 //300a 022c DA RT Air Kerma Rate Reference Date
1970 //300e 0004 DA RT Review Date
1971
1972    return true;
1973 }
1974
1975 /**
1976  * \brief Performs some consistency checking on various 'File related'
1977  *       (as opposed to 'DicomDir related') entries
1978  *       then writes in a file all the (Dicom Elements) included the Pixels
1979  * @param fileName file name to write to
1980  * @param writetype type of the file to be written
1981  *          (ACR, ExplicitVR, ImplicitVR)
1982  */
1983 bool File::Write(std::string fileName, FileType writetype)
1984 {
1985       gdcmDebugMacro(" File::Write ");
1986    std::ofstream *fp = new std::ofstream(fileName.c_str(),
1987                                          std::ios::out | std::ios::binary);
1988    if (*fp == NULL)
1989    {
1990       gdcmWarningMacro("Failed to open (write) File: " << fileName.c_str());
1991       return false;
1992    }
1993
1994    // Entry : 0002|0000 = group length -> recalculated
1995    DataEntry *e0000 = GetDataEntry(0x0002,0x0000);
1996    if ( e0000 )
1997    {
1998       std::ostringstream sLen;
1999       sLen << ComputeGroup0002Length( );
2000       e0000->SetString(sLen.str());
2001    }
2002
2003    /// \todo FIXME : Derma?.dcm does not have it...let's remove it ?!? JPRx
2004    if( writetype != JPEG && writetype != JPEG2000)
2005    {
2006       int i_lgPix = GetEntryLength(GrPixel, NumPixel);
2007       if (i_lgPix != -2)  /// \todo wtf "-2" ?!?
2008       {
2009          // no (GrPixel, NumPixel) element
2010          std::string s_lgPix = Util::Format("%d", i_lgPix+12);
2011          s_lgPix = Util::DicomString( s_lgPix.c_str() );
2012          InsertEntryString(s_lgPix,GrPixel, 0x0000, "UL");
2013       }
2014    }
2015    Document::WriteContent(fp, writetype,false,false);
2016
2017    fp->close();
2018    delete fp;
2019
2020    return true;
2021 }
2022
2023 //-----------------------------------------------------------------------------
2024 // Protected
2025
2026
2027 //-----------------------------------------------------------------------------
2028 // Private
2029 /**
2030  * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
2031  *        Compute the RLE extra information and store it in RLEInfo
2032  *        for later pixel retrieval usage.
2033  */
2034 void File::ComputeRLEInfo()
2035 {
2036    std::string ts = GetTransferSyntax();
2037    if ( !Global::GetTS()->IsRLELossless(ts) )
2038    {
2039       return;
2040    }
2041
2042    // Encoded pixel data: for the time being we are only concerned with
2043    // Jpeg or RLE Pixel data encodings.
2044    // As stated in PS 3.5-2003, section 8.2 p44:
2045    // "If sent in Encapsulated Format (i.e. other than the Native Format) the
2046    //  value representation OB is used".
2047    // Hence we expect an OB value representation. Concerning OB VR,
2048    // the section PS 3.5-2003, section A.4.c p 58-59, states:
2049    // "For the Value Representations OB and OW, the encoding shall meet the
2050    //   following specifications depending on the Data element tag:"
2051    //   [...snip...]
2052    //    - the first item in the sequence of items before the encoded pixel
2053    //      data stream shall be basic offset table item. The basic offset table
2054    //      item value, however, is not required to be present"
2055    ReadEncapsulatedBasicOffsetTable();
2056
2057    // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
2058    // Loop on the individual frame[s] and store the information
2059    // on the RLE fragments in a RLEFramesInfo.
2060    // Note: - when only a single frame is present, this is a
2061    //         classical image.
2062    //       - when more than one frame are present, then we are in
2063    //         the case of a multi-frame image.
2064    long frameLength;
2065    int i=0;
2066    uint32_t sum = 0;
2067    while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
2068    {
2069       // Since we have read the basic offset table, let's check the value were correct
2070       // or else produce a warning:
2071       if ( BasicOffsetTableItemValue )
2072         {
2073         // If a BasicOffsetTableItemValue was read
2074         uint32_t individualLength = BasicOffsetTableItemValue[i];
2075         assert( individualLength == sum ); // REMOVE that if this is a problem
2076         if( individualLength != sum )
2077           {
2078           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght" );
2079           }
2080         sum += frameLength + 8;
2081         i++;
2082         }
2083       // Parse the RLE Header and store the corresponding RLE Segment
2084       // Offset Table information on fragments of this current Frame.
2085       // Note that the fragment pixels themselves are not loaded
2086       // (but just skipped).
2087       long frameOffset = Fp->tellg(); // once per fragment
2088
2089       uint32_t nbRleSegments = ReadInt32();
2090       if ( nbRleSegments > 16 )
2091       {
2092          // There should be at most 15 segments (refer to RLEFrame class)
2093          gdcmWarningMacro( "Too many segments.");
2094       }
2095
2096       uint32_t rleSegmentOffsetTable[16];
2097       for( int k = 1; k <= 15; k++ )
2098       {
2099          rleSegmentOffsetTable[k] = ReadInt32();
2100       }
2101
2102       // Deduce from both RLE Header and frameLength
2103       // the fragment length, and again store this info
2104       // in a RLEFramesInfo.
2105       long rleSegmentLength[15];
2106       // skipping (not reading) RLE Segments
2107       if ( nbRleSegments > 1)
2108       {
2109          for(unsigned int k = 1; k <= nbRleSegments-1; k++)
2110          {
2111              rleSegmentLength[k] =  rleSegmentOffsetTable[k+1]
2112                                   - rleSegmentOffsetTable[k];
2113              SkipBytes(rleSegmentLength[k]);
2114           }
2115        }
2116
2117        rleSegmentLength[nbRleSegments] = frameLength
2118                                       - rleSegmentOffsetTable[nbRleSegments];
2119        SkipBytes(rleSegmentLength[nbRleSegments]);
2120
2121        // Store the collected info
2122        RLEFrame *newFrame = new RLEFrame;
2123        newFrame->SetNumberOfFragments(nbRleSegments);
2124        for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
2125        {
2126           newFrame->SetOffset(uk,frameOffset + rleSegmentOffsetTable[uk]);
2127           newFrame->SetLength(uk,rleSegmentLength[uk]);
2128        }
2129        RLEInfo->AddFrame(newFrame);
2130    }
2131
2132    // Make sure that  we encounter a 'Sequence Delimiter Item'
2133    // at the end of the item :
2134    if ( !ReadTag(0xfffe, 0xe0dd) ) // once per RLE File
2135    {
2136       gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
2137    }
2138 }
2139
2140 /**
2141  * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
2142  *        Compute the jpeg extra information (fragment[s] offset[s] and
2143  *        length) and store it[them] in JPEGInfo for later pixel
2144  *        retrieval usage.
2145  */
2146 void File::ComputeJPEGFragmentInfo()
2147 {
2148    // If you need to, look for comments of ComputeRLEInfo().
2149    std::string ts = GetTransferSyntax();
2150    if ( ! Global::GetTS()->IsJPEG(ts) )
2151    {
2152       return;
2153    }
2154
2155    ReadEncapsulatedBasicOffsetTable();
2156
2157    // Loop on the fragments[s] and store the parsed information in a
2158    // JPEGInfo.
2159    long fragmentLength;
2160    int i=0;
2161    uint32_t sum = 0;
2162    while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) != 0 )
2163    {
2164       // Since we have read the basic offset table, let's check the value were correct
2165       // or else produce a warning:
2166       // A.4 Transfer syntaxes for encapsulation of encoded pixel data:
2167       // When the Item Value is present, the Basic Offset Table Item Value shall contain
2168       // concatenated 32-bit unsigned integer values that are byte offsets to the first
2169       // byte of the Item Tag of the first fragment for each frame in the Sequence of
2170       // Items. These offsets are measured from the first byte of the first Item Tag
2171       // following the Basic Offset Table item (See Table A.4-2).
2172
2173       if ( BasicOffsetTableItemValue )
2174         {
2175         // If a BasicOffsetTableItemValue was read
2176         uint32_t individualLength = BasicOffsetTableItemValue[i];
2177         //assert( individualLength == sum ); // Seems like 00191113.dcm is off by one ??
2178         if( individualLength != sum )
2179           {
2180           gdcmWarningMacro( "BasicOffsetTableItemValue differs from the fragment lenght:" <<
2181               individualLength << " != " << sum );
2182           }
2183         sum += fragmentLength + 8;
2184         i++;
2185         }
2186
2187       long fragmentOffset = Fp->tellg(); // Once per fragment
2188       // Store the collected info
2189       JPEGFragment *newFragment = new JPEGFragment;
2190       newFragment->SetOffset(fragmentOffset);
2191       newFragment->SetLength(fragmentLength);
2192       JPEGInfo->AddFragment(newFragment);
2193
2194       SkipBytes(fragmentLength);
2195    }
2196
2197    // Make sure that  we encounter a 'Sequence Delimiter Item'
2198    // at the end of the item :
2199    if ( !ReadTag(0xfffe, 0xe0dd) )
2200    {
2201       gdcmWarningMacro( "No sequence delimiter item at end of JPEG item sequence");
2202    }
2203 }
2204
2205 /**
2206  * \brief   Assuming the internal file pointer Document::Fp
2207  *          is placed at the beginning of a tag, check whether this
2208  *          tag is (TestGroup, TestElem).
2209  * \warning On success the internal file pointer Document::Fp
2210  *          is modified to point after the tag.
2211  *          On failure (i.e. when the tag wasn't the expected tag
2212  *          (TestGroup, TestElem) the internal file pointer
2213  *          Document::Fp is restored to its original position.
2214  * @param   testGroup The expected group   of the tag.
2215  * @param   testElem  The expected Element of the tag.
2216  * @return  True on success, false otherwise.
2217  */
2218 bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
2219 {
2220    long positionOnEntry = Fp->tellg(); // Only when reading fragments
2221    //long currentPosition = positionOnEntry;      // On debugging purposes
2222
2223    // Read the Item Tag group and element, and make
2224    // sure they are what we expected:
2225    uint16_t itemTagGroup;
2226    uint16_t itemTagElem;
2227    try
2228    {
2229       itemTagGroup = ReadInt16();
2230       itemTagElem  = ReadInt16();
2231    }
2232    catch ( FormatError )
2233    {
2234       gdcmErrorMacro( "Can not read tag for "
2235        << "   We should have found tag ("
2236        << DictEntry::TranslateToKey(testGroup,testElem) << ")"
2237        ) ;
2238
2239       return false;
2240    }
2241    if ( itemTagGroup != testGroup || itemTagElem != testElem )
2242    {
2243        // in order not to pollute output we don't warn on 'delimitors'
2244       if (itemTagGroup != 0xfffe ||  testGroup != 0xfffe )
2245          gdcmWarningMacro( "Wrong Item Tag found:"
2246           << "   We should have found tag ("
2247           << DictEntry::TranslateToKey(testGroup,testElem) << ")" << std::endl
2248           << "   but instead we encountered tag ("
2249           << DictEntry::TranslateToKey(itemTagGroup,itemTagElem) << ")"
2250           << "  at address: " << "  0x(" << std::hex
2251           << (unsigned int)positionOnEntry  << std::dec << ")"
2252           ) ;
2253       Fp->seekg(positionOnEntry, std::ios::beg);
2254
2255       return false;
2256    }
2257    return true;
2258 }
2259
2260 /**
2261  * \brief   Assuming the internal file pointer Document::Fp
2262  *          is placed at the beginning of a tag (TestGroup, TestElement),
2263  *          read the length associated to the Tag.
2264  * \warning On success the internal file pointer Document::Fp
2265  *          is modified to point after the tag and its length.
2266  *          On failure (i.e. when the tag wasn't the expected tag
2267  *          (TestGroup, TestElement) the internal file pointer
2268  *          Document::Fp is restored to its original position.
2269  * @param   testGroup The expected Group   of the tag.
2270  * @param   testElem  The expected Element of the tag.
2271  * @return  On success returns the length associated to the tag. On failure
2272  *          returns 0.
2273  */
2274 uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElem)
2275 {
2276
2277    if ( !ReadTag(testGroup, testElem) )
2278    {
2279       // Avoid polutting output
2280       if ( testGroup != 0xfffe )
2281          gdcmErrorMacro( "ReadTag did not succeed for ("
2282                     << DictEntry::TranslateToKey(testGroup,testElem)
2283                     << ")..." );
2284       return 0;
2285    }
2286
2287    //// Then read the associated Item Length
2288
2289    // long currentPosition = Fp->tellg(); // save time // JPRx
2290    uint32_t itemLength  = ReadInt32();
2291    gdcmDebugMacro( "Basic Item Length is: " << itemLength
2292 //        << "  at address: " << std::hex << (unsigned int)currentPosition
2293    );
2294    return itemLength;
2295 }
2296
2297 /**
2298  * \brief When parsing the Pixel Data of an encapsulated file, read
2299  *        the basic offset table (when present, and BTW dump it).
2300  */
2301 void File::ReadEncapsulatedBasicOffsetTable()
2302 {
2303    //// Read the Basic Offset Table Item Tag length...
2304    uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
2305
2306    // When present, read the basic offset table itself.
2307    // Notes: - since the presence of this basic offset table is optional
2308    //          we can't rely on it for the implementation, and we will simply
2309    //          trash its content (when present).
2310    //        - still, when present, we could add some further checks on the
2311    //          lengths, but we won't bother with such fuses for the time being.
2312    if ( itemLength != 0 )
2313    {
2314       char *charBasicOffsetTableItemValue = new char[itemLength];
2315       Fp->read(charBasicOffsetTableItemValue, itemLength);
2316       unsigned int nbEntries = itemLength/4;
2317       assert( nbEntries*4 == itemLength); // Make sure this is a multiple
2318       BasicOffsetTableItemValue = new uint32_t[nbEntries];
2319
2320       for (unsigned int i=0; i < nbEntries; i++ )
2321       {
2322          BasicOffsetTableItemValue[i] = *((uint32_t*)(&charBasicOffsetTableItemValue[4*i]));
2323 #if defined(GDCM_WORDS_BIGENDIAN) || defined(GDCM_FORCE_BIGENDIAN_EMULATION)
2324          uint32_t val = BasicOffsetTableItemValue[i];
2325          BasicOffsetTableItemValue[i]
2326            = (  (val<<24)               | ((val<<8)  & 0x00ff0000) |
2327               ( (val>>8)  & 0x0000ff00) |  (val>>24)               );
2328 #endif
2329          gdcmDebugMacro( "Read one length for: " <<
2330                           std::hex << BasicOffsetTableItemValue[i] );
2331       }
2332
2333       delete[] charBasicOffsetTableItemValue;
2334    }
2335 }
2336
2337 // These are the deprecated method that one day should be removed (after the next release)
2338
2339 //#ifndef GDCM_LEGACY_REMOVE
2340 /*
2341  * \ brief   Loader. (DEPRECATED :  temporaryly kept not to break the API)
2342  * @ param   fileName file to be open for parsing
2343  * @ return false if file cannot be open or no swap info was found,
2344  *         or no tag was found.
2345  * @deprecated Use the Load() [ + SetLoadMode() ] + SetFileName() functions instead
2346  */
2347  /*
2348 bool File::Load( std::string const &fileName )
2349 {
2350    GDCM_LEGACY_REPLACED_BODY(File::Load(std::string), "1.2",
2351                              File::Load());
2352    SetFileName( fileName );
2353    if ( ! this->Document::Load( ) )
2354       return false;
2355
2356    return DoTheLoadingJob( );
2357 }
2358 #endif
2359 */
2360 //-----------------------------------------------------------------------------
2361 // Print
2362
2363 //-----------------------------------------------------------------------------
2364 } // end namespace gdcm