src/gdcmFileHelper.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.cxx,v $
   5   Language:  C++
   6
   7   Date:      $Date: 2005/03/09 09:45:33 $
   8   Version:   $Revision: 1.29 $
   9
  10   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  11   l'Image). All rights reserved. See Doc/License.txt or
  12   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  13
  14      This software is distributed WITHOUT ANY WARRANTY; without even
  15      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  16      PURPOSE.  See the above copyright notices for more information.
  17
  18 =========================================================================*/
  19
  20 #include "gdcmFileHelper.h"
  21 #include "gdcmGlobal.h"
  22 #include "gdcmTS.h"
  23 #include "gdcmDocument.h"
  24 #include "gdcmDebug.h"
  25 #include "gdcmUtil.h"
  26 #include "gdcmBinEntry.h"
  27 #include "gdcmValEntry.h"
  28 #include "gdcmSeqEntry.h"
  29 #include "gdcmSQItem.h"
  30 #include "gdcmContentEntry.h"
  31 #include "gdcmFile.h"
  32 #include "gdcmPixelReadConvert.h"
  33 #include "gdcmPixelWriteConvert.h"
  34 #include "gdcmDocEntryArchive.h"
  35 #include "gdcmDictSet.h"
  36
  37 #include <fstream>
  38
  39 /*
  40 // ----------------------------- WARNING -------------------------
  41
  42 These lines will be moved to the document-to-be 'User's Guide'
  43
  44 // To read an image, user needs a gdcm::File
  45 gdcm::File *f1 = new gdcm::File(fileName);
  46 // user can now check some values
  47 std::string v = f1->GetEntryValue(groupNb,ElementNb);
  48 // to get the pixels, user needs a gdcm::FileHelper
  49 gdcm::FileHelper *fh1 = new gdcm::FileHelper(f1);
  50 // user may ask not to convert Palette to RGB
  51 uint8_t *pixels = fh1->GetImageDataRaw();
  52 int imageLength = fh1->GetImageDataRawSize();
  53 // He can now use the pixels, create a new image, ...
  54 uint8_t *userPixels = ...
  55
  56 To re-write the image, user re-uses the gdcm::FileHelper
  57
  58 fh1->SetImageData( userPixels, userPixelsLength);
  59 fh1->SetTypeToRaw(); // Even if it was possible to convert Palette to RGB
  60                      // (WriteMode is set)
  61
  62 fh1->SetWriteTypeToDcmExpl(); // he wants Explicit Value Representation
  63                               // Little Endian is the default
  64                               // no other value is allowed
  65                                 (-->SetWriteType(ExplicitVR);)
  66                                    -->WriteType = ExplicitVR;
  67 fh1->Write(newFileName);      // overwrites the file, if any
  68
  69 // or :
  70 fh1->WriteDcmExplVR(newFileName);
  71
  72
  73 // ----------------------------- WARNING -------------------------
  74
  75 These lines will be moved to the document-to-be 'Developer's Guide'
  76
  77 WriteMode : WMODE_RAW / WMODE_RGB
  78 WriteType : ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO
  79
  80 fh1->Write(newFileName);
  81    SetWriteFileTypeToImplicitVR() / SetWriteFileTypeToExplicitVR();
  82    (modifies TransferSyntax)
  83    SetWriteToRaw(); / SetWriteToRGB();
  84       (modifies, when necessary : photochromatic interpretation,
  85          samples per pixel, Planar configuration,
  86          bits allocated, bits stored, high bit -ACR 24 bits-
  87          Pixels element VR, pushes out the LUT )
  88    CheckWriteIntegrity();
  89       (checks user given pixels length)
  90    FileInternal->Write(fileName,WriteType)
  91    fp = opens file(fileName);
  92    ComputeGroup0002Length(writetype);
  93    BitsAllocated 12->16
  94       RemoveEntryNoDestroy(palettes, etc)
  95       Document::WriteContent(fp, writetype);
  96    RestoreWrite();
  97       (moves back to the File all the archived elements)
  98    RestoreWriteFileType();
  99       (pushes back group 0002, with TransferSyntax)
 100 */
 101
 102
 103
 104
 105 namespace gdcm
 106 {
 107 //-------------------------------------------------------------------------
 108 // Constructor / Destructor
 109 /**
 110  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
 111  *        file (gdcm::File only deals with the ... header)
 112  *        Opens (in read only and when possible) an existing file and checks
 113  *        for DICOM compliance. Returns NULL on failure.
 114  *        It will be up to the user to load the pixels into memory
 115  * \note  the in-memory representation of all available tags found in
 116  *        the DICOM header is post-poned to first header information access.
 117  *        This avoid a double parsing of public part of the header when
 118  *        one sets an a posteriori shadow dictionary (efficiency can be
 119  *        seen as a side effect).
 120  */
 121 FileHelper::FileHelper( )
 122 {
 123    FileInternal = new File( );
 124    SelfHeader = true;
 125    Initialize();
 126 }
 127
 128 /**
 129  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
 130  *        file (File only deals with the ... header)
 131  *        Opens (in read only and when possible) an existing file and checks
 132  *        for DICOM compliance. Returns NULL on failure.
 133  *        It will be up to the user to load the pixels into memory
 134  * \note  the in-memory representation of all available tags found in
 135  *        the DICOM header is post-poned to first header information access.
 136  *        This avoid a double parsing of public part of the header when
 137  *        user sets an a posteriori shadow dictionary (efficiency can be
 138  *        seen as a side effect).
 139  * @param header already built Header
 140  */
 141 FileHelper::FileHelper(File *header)
 142 {
 143    FileInternal = header;
 144    SelfHeader = false;
 145    Initialize();
 146 }
 147
 148 /**
 149  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
 150  *        file (gdcm::File only deals with the ... header)
 151  *        Opens (in read only and when possible) an existing file and checks
 152  *        for DICOM compliance. Returns NULL on failure.
 153  *        It will be up to the user to load the pixels into memory
 154  * \note  the in-memory representation of all available tags found in
 155  *        the DICOM header is post-poned to first header information access.
 156  *        This avoid a double parsing of public part of the header when
 157  *        one sets an a posteriori shadow dictionary (efficiency can be
 158  *        seen as a side effect).
 159  * @param filename file to be opened for parsing
 160  */
 161 FileHelper::FileHelper(std::string const &filename )
 162 {
 163    FileInternal = new File( filename );
 164    SelfHeader = true;
 165    Initialize();
 166 }
 167
 168 /**
 169  * \brief canonical destructor
 170  * \note  If the header (gdcm::File) was created by the FileHelper constructor,
 171  *        it is destroyed by the FileHelper
 172  */
 173 FileHelper::~FileHelper()
 174 {
 175    if( PixelReadConverter )
 176    {
 177       delete PixelReadConverter;
 178    }
 179    if( PixelWriteConverter )
 180    {
 181       delete PixelWriteConverter;
 182    }
 183    if( Archive )
 184    {
 185       delete Archive;
 186    }
 187
 188    if( SelfHeader )
 189    {
 190       delete FileInternal;
 191    }
 192    FileInternal = 0;
 193 }
 194
 195 //-----------------------------------------------------------------------------
 196 // Public
 197 /**
 198  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
 199  *          through it's (group, element) and modifies it's content with
 200  *          the given value.
 201  * @param   content new value (string) to substitute with
 202  * @param   group  group number of the Dicom Element to modify
 203  * @param   elem element number of the Dicom Element to modify
 204  * \return  false if DocEntry not found
 205  */
 206 bool FileHelper::SetValEntry(std::string const &content,
 207                              uint16_t group, uint16_t elem)
 208 {
 209    return FileInternal->SetValEntry(content, group, elem);
 210 }
 211
 212
 213 /**
 214  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
 215  *          through it's (group, element) and modifies it's content with
 216  *          the given value.
 217  * @param   content new value (void*  -> uint8_t*) to substitute with
 218  * @param   lgth new value length
 219  * @param   group  group number of the Dicom Element to modify
 220  * @param   elem element number of the Dicom Element to modify
 221  * \return  false if DocEntry not found
 222  */
 223 bool FileHelper::SetBinEntry(uint8_t *content, int lgth,
 224                              uint16_t group, uint16_t elem)
 225 {
 226    return FileInternal->SetBinEntry(content, lgth, group, elem);
 227 }
 228
 229 /**
 230  * \brief   Modifies the value of a given DocEntry (Dicom entry)
 231  *          when it exists. Creates it with the given value when unexistant.
 232  * @param   content (string)value to be set
 233  * @param   group   Group number of the Entry
 234  * @param   elem  Element number of the Entry
 235  * \return  pointer to the modified/created Dicom entry (NULL when creation
 236  *          failed).
 237  */
 238 ValEntry *FileHelper::InsertValEntry(std::string const &content,
 239                                      uint16_t group, uint16_t elem)
 240 {
 241    return FileInternal->InsertValEntry(content,group,elem);
 242 }
 243
 244 /**
 245  * \brief   Modifies the value of a given DocEntry (Dicom entry)
 246  *          when it exists. Creates it with the given value when unexistant.
 247  *          A copy of the binArea is made to be kept in the Document.
 248  * @param   binArea (binary)value to be set
 249  * @param   lgth new value length
 250  * @param   group   Group number of the Entry
 251  * @param   elem  Element number of the Entry
 252  * \return  pointer to the modified/created Dicom entry (NULL when creation
 253  *          failed).
 254  */
 255 BinEntry *FileHelper::InsertBinEntry(uint8_t *binArea, int lgth,
 256                                      uint16_t group, uint16_t elem)
 257 {
 258    return FileInternal->InsertBinEntry(binArea, lgth, group, elem);
 259 }
 260
 261 /**
 262  * \brief   Modifies the value of a given DocEntry (Dicom entry)
 263  *          when it exists. Creates it, empty (?!) when unexistant.
 264  * @param   group   Group number of the Entry
 265  * @param   elem  Element number of the Entry
 266  * \return  pointer to the modified/created Dicom entry (NULL when creation
 267  *          failed).
 268  */
 269 SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
 270 {
 271    return FileInternal->InsertSeqEntry(group, elem);
 272 }
 273
 274 /**
 275  * \brief   Get the size of the image data
 276  *          If the image can be RGB (with a lut or by default), the size
 277  *          corresponds to the RGB image
 278  *         (use GetImageDataRawSize if you want to be sure to get *only*
 279  *          the size of the pixels)
 280  * @return  The image size
 281  */
 282 size_t FileHelper::GetImageDataSize()
 283 {
 284    if ( PixelWriteConverter->GetUserData() )
 285    {
 286       return PixelWriteConverter->GetUserDataSize();
 287    }
 288
 289    return PixelReadConverter->GetRGBSize();
 290 }
 291
 292 /**
 293  * \brief   Get the size of the image data
 294  *          If the image could be converted to RGB using a LUT,
 295  *          this transformation is not taken into account by GetImageDataRawSize
 296  *          (use GetImageDataSize if you wish)
 297  * @return  The raw image size
 298  */
 299 size_t FileHelper::GetImageDataRawSize()
 300 {
 301    if ( PixelWriteConverter->GetUserData() )
 302    {
 303       return PixelWriteConverter->GetUserDataSize();
 304    }
 305
 306    return PixelReadConverter->GetRawSize();
 307 }
 308
 309 /**
 310  * \brief   - Allocates necessary memory,
 311  *          - Reads the pixels from disk (uncompress if necessary),
 312  *          - Transforms YBR pixels, if any, into RGB pixels,
 313  *          - Transforms 3 planes R, G, B, if any, into a single RGB Plane
 314  *          - Transforms single Grey plane + 3 Palettes into a RGB Plane
 315  *          - Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
 316  * @return  Pointer to newly allocated pixel data.
 317  *          NULL if alloc fails
 318  */
 319 uint8_t *FileHelper::GetImageData()
 320 {
 321    if ( PixelWriteConverter->GetUserData() )
 322    {
 323       return PixelWriteConverter->GetUserData();
 324    }
 325
 326    if ( ! GetRaw() )
 327    {
 328       // If the decompression failed nothing can be done.
 329       return 0;
 330    }
 331
 332    if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
 333    {
 334       return PixelReadConverter->GetRGB();
 335    }
 336    else
 337    {
 338       // When no LUT or LUT conversion fails, return the Raw
 339       return PixelReadConverter->GetRaw();
 340    }
 341 }
 342
 343 /**
 344  * \brief   Allocates necessary memory,
 345  *          Transforms YBR pixels (if any) into RGB pixels
 346  *          Transforms 3 planes R, G, B  (if any) into a single RGB Plane
 347  *          Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
 348  *          DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
 349  * @return  Pointer to newly allocated pixel data.
 350  *          NULL if alloc fails
 351  */
 352 uint8_t *FileHelper::GetImageDataRaw ()
 353 {
 354    return GetRaw();
 355 }
 356
 357 /**
 358  * \brief
 359  *          Read the pixels from disk (uncompress if necessary),
 360  *          Transforms YBR pixels, if any, into RGB pixels
 361  *          Transforms 3 planes R, G, B, if any, into a single RGB Plane
 362  *          Transforms single Grey plane + 3 Palettes into a RGB Plane
 363  *          Copies at most MaxSize bytes of pixel data to caller allocated
 364  *          memory space.
 365  * \warning This function allows people that want to build a volume
 366  *          from an image stack *not to* have, first to get the image pixels,
 367  *          and then move them to the volume area.
 368  *          It's absolutely useless for any VTK user since vtk chooses
 369  *          to invert the lines of an image, that is the last line comes first
 370  *          (for some axis related reasons?). Hence he will have
 371  *          to load the image line by line, starting from the end.
 372  *          VTK users have to call GetImageData
 373  *
 374  * @param   destination Address (in caller's memory space) at which the
 375  *          pixel data should be copied
 376  * @param   maxSize Maximum number of bytes to be copied. When MaxSize
 377  *          is not sufficient to hold the pixel data the copy is not
 378  *          executed (i.e. no partial copy).
 379  * @return  On success, the number of bytes actually copied. Zero on
 380  *          failure e.g. MaxSize is lower than necessary.
 381  */
 382 size_t FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
 383 {
 384    if ( ! GetRaw() )
 385    {
 386       // If the decompression failed nothing can be done.
 387       return 0;
 388    }
 389
 390    if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
 391    {
 392       if ( PixelReadConverter->GetRGBSize() > maxSize )
 393       {
 394          gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
 395          return 0;
 396       }
 397       memcpy( destination,
 398               (void*)PixelReadConverter->GetRGB(),
 399               PixelReadConverter->GetRGBSize() );
 400       return PixelReadConverter->GetRGBSize();
 401    }
 402
 403    // Either no LUT conversion necessary or LUT conversion failed
 404    if ( PixelReadConverter->GetRawSize() > maxSize )
 405    {
 406       gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
 407       return 0;
 408    }
 409    memcpy( destination,
 410            (void*)PixelReadConverter->GetRaw(),
 411            PixelReadConverter->GetRawSize() );
 412    return PixelReadConverter->GetRawSize();
 413 }
 414
 415 /**
 416  * \brief   Points the internal pointer to the callers inData
 417  *          image representation, BUT WITHOUT COPYING THE DATA.
 418  *          'image' Pixels are presented as C-like 2D arrays : line per line.
 419  *          'volume'Pixels are presented as C-like 3D arrays : plane per plane
 420  * \warning Since the pixels are not copied, it is the caller's responsability
 421  *          not to deallocate its data before gdcm uses them (e.g. with
 422  *          the Write() method )
 423  * @param inData user supplied pixel area (uint8_t* is just for the compiler.
 424  *               user is allowed to pass any kind of pixelsn since the size is
 425  *               given in bytes)
 426  * @param expectedSize total image size, *in Bytes*
 427  */
 428 void FileHelper::SetImageData(uint8_t *inData, size_t expectedSize)
 429 {
 430    SetUserData(inData, expectedSize);
 431 }
 432
 433 /**
 434  * \brief   Set the image data defined by the user
 435  * \warning When writting the file, this data are get as default data to write
 436  * @param inData user supplied pixel area (uint8_t* is just for the compiler.
 437  *               user is allowed to pass any kind of pixels since the size is
 438  *               given in bytes)
 439  * @param expectedSize total image size, *in Bytes*
 440  */
 441 void FileHelper::SetUserData(uint8_t *inData, size_t expectedSize)
 442 {
 443    PixelWriteConverter->SetUserData(inData, expectedSize);
 444 }
 445
 446 /**
 447  * \brief   Get the image data defined by the user
 448  * \warning When writting the file, this data are get as default data to write
 449  */
 450 uint8_t *FileHelper::GetUserData()
 451 {
 452    return PixelWriteConverter->GetUserData();
 453 }
 454
 455 /**
 456  * \brief   Get the image data size defined by the user
 457  * \warning When writting the file, this data are get as default data to write
 458  */
 459 size_t FileHelper::GetUserDataSize()
 460 {
 461    return PixelWriteConverter->GetUserDataSize();
 462 }
 463
 464 /**
 465  * \brief   Get the image data from the file.
 466  *          If a LUT is found, the data are expanded to be RGB
 467  */
 468 uint8_t *FileHelper::GetRGBData()
 469 {
 470    return PixelReadConverter->GetRGB();
 471 }
 472
 473 /**
 474  * \brief   Get the image data size from the file.
 475  *          If a LUT is found, the data are expanded to be RGB
 476  */
 477 size_t FileHelper::GetRGBDataSize()
 478 {
 479    return PixelReadConverter->GetRGBSize();
 480 }
 481
 482 /**
 483  * \brief   Get the image data from the file.
 484  *          Even when a LUT is found, the data are not expanded to RGB!
 485  */
 486 uint8_t *FileHelper::GetRawData()
 487 {
 488    return PixelReadConverter->GetRaw();
 489 }
 490
 491 /**
 492  * \brief   Get the image data size from the file.
 493  *          Even when a LUT is found, the data are not expanded to RGB!
 494  */
 495 size_t FileHelper::GetRawDataSize()
 496 {
 497    return PixelReadConverter->GetRawSize();
 498 }
 499
 500 /**
 501  * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
 502  */
 503 uint8_t* FileHelper::GetLutRGBA()
 504 {
 505    return PixelReadConverter->GetLutRGBA();
 506 }
 507
 508 /**
 509  * \brief Writes on disk A SINGLE Dicom file
 510  *        NO test is performed on  processor "Endiannity".
 511  *        It's up to the user to call his Reader properly
 512  * @param fileName name of the file to be created
 513  *                 (any already existing file is over written)
 514  * @return false if write fails
 515  */
 516 bool FileHelper::WriteRawData(std::string const &fileName)
 517 {
 518    std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary );
 519    if (!fp1)
 520    {
 521       gdcmWarningMacro( "Fail to open (write) file:" << fileName.c_str());
 522       return false;
 523    }
 524
 525    if( PixelWriteConverter->GetUserData() )
 526    {
 527       fp1.write( (char*)PixelWriteConverter->GetUserData(),
 528                  PixelWriteConverter->GetUserDataSize() );
 529    }
 530    else if ( PixelReadConverter->GetRGB() )
 531    {
 532       fp1.write( (char*)PixelReadConverter->GetRGB(),
 533                  PixelReadConverter->GetRGBSize());
 534    }
 535    else if ( PixelReadConverter->GetRaw() )
 536    {
 537       fp1.write( (char*)PixelReadConverter->GetRaw(),
 538                  PixelReadConverter->GetRawSize());
 539    }
 540    else
 541    {
 542       gdcmErrorMacro( "Nothing written." );
 543    }
 544
 545    fp1.close();
 546
 547    return true;
 548 }
 549
 550 /**
 551  * \brief Writes on disk A SINGLE Dicom file,
 552  *        using the Implicit Value Representation convention
 553  *        NO test is performed on  processor "Endiannity".
 554  * @param fileName name of the file to be created
 555  *                 (any already existing file is overwritten)
 556  * @return false if write fails
 557  */
 558
 559 bool FileHelper::WriteDcmImplVR (std::string const &fileName)
 560 {
 561    SetWriteTypeToDcmImplVR();
 562    return Write(fileName);
 563 }
 564
 565 /**
 566 * \brief Writes on disk A SINGLE Dicom file,
 567  *        using the Explicit Value Representation convention
 568  *        NO test is performed on  processor "Endiannity".
 569  * @param fileName name of the file to be created
 570  *                 (any already existing file is overwritten)
 571  * @return false if write fails
 572  */
 573
 574 bool FileHelper::WriteDcmExplVR (std::string const &fileName)
 575 {
 576    SetWriteTypeToDcmExplVR();
 577    return Write(fileName);
 578 }
 579
 580 /**
 581  * \brief Writes on disk A SINGLE Dicom file,
 582  *        using the ACR-NEMA convention
 583  *        NO test is performed on  processor "Endiannity".
 584  *        (a l'attention des logiciels cliniques
 585  *        qui ne prennent en entrée QUE des images ACR ...
 586  * \warning if a DICOM_V3 header is supplied,
 587  *         groups < 0x0008 and shadow groups are ignored
 588  * \warning NO TEST is performed on processor "Endiannity".
 589  * @param fileName name of the file to be created
 590  *                 (any already existing file is overwritten)
 591  * @return false if write fails
 592  */
 593
 594 bool FileHelper::WriteAcr (std::string const &fileName)
 595 {
 596    SetWriteTypeToAcr();
 597    return Write(fileName);
 598 }
 599
 600 /**
 601  * \brief Writes on disk A SINGLE Dicom file,
 602  * @param fileName name of the file to be created
 603  *                 (any already existing file is overwritten)
 604  * @return false if write fails
 605  */
 606 bool FileHelper::Write(std::string const &fileName)
 607 {
 608    switch(WriteType)
 609    {
 610       case ImplicitVR:
 611          SetWriteFileTypeToImplicitVR();
 612          CheckMandatoryElements();
 613          break;
 614       case ExplicitVR:
 615          SetWriteFileTypeToExplicitVR();
 616          CheckMandatoryElements();
 617          break;
 618       case ACR:
 619       case ACR_LIBIDO:
 620          SetWriteFileTypeToACR();
 621          break;
 622       default:
 623          SetWriteFileTypeToExplicitVR();
 624          CheckMandatoryElements();
 625    }
 626
 627    // --------------------------------------------------------------
 628    // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
 629    //
 630    // if recognition code tells us we dealt with a LibIDO image
 631    // we reproduce on disk the switch between lineNumber and columnNumber
 632    // just before writting ...
 633    /// \todo the best trick would be *change* the recognition code
 634    ///       but pb expected if user deals with, e.g. COMPLEX images
 635    if( WriteType == ACR_LIBIDO )
 636    {
 637       SetWriteToLibido();
 638    }
 639    else
 640    {
 641       SetWriteToNoLibido();
 642    }
 643    // ----------------- End of Special Patch ----------------
 644
 645    switch(WriteMode)
 646    {
 647       case WMODE_RAW :
 648          SetWriteToRaw(); // modifies and pushes to the archive, when necessary
 649          break;
 650       case WMODE_RGB :
 651          SetWriteToRGB(); // modifies and pushes to the archive, when necessary
 652          break;
 653    }
 654
 655    bool check = CheckWriteIntegrity(); // verifies length
 656    if(check)
 657    {
 658       check = FileInternal->Write(fileName,WriteType);
 659    }
 660
 661    RestoreWrite();
 662    RestoreWriteFileType();
 663    RestoreWriteMandatory();
 664
 665    // --------------------------------------------------------------
 666    // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
 667    //
 668    // ...and we restore the header to be Dicom Compliant again
 669    // just after writting
 670    RestoreWriteOfLibido();
 671    // ----------------- End of Special Patch ----------------
 672
 673    return check;
 674 }
 675
 676 //-----------------------------------------------------------------------------
 677 // Protected
 678 /**
 679  * \brief Checks the write integrity
 680  *
 681  * The tests made are :
 682  *  - verify the size of the image to write with the possible write
 683  *    when the user set an image data
 684  * @return true if check is successfull
 685  */
 686 bool FileHelper::CheckWriteIntegrity()
 687 {
 688    if(PixelWriteConverter->GetUserData())
 689    {
 690       int numberBitsAllocated = FileInternal->GetBitsAllocated();
 691       if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
 692       {
 693          numberBitsAllocated = 16;
 694       }
 695
 696       size_t decSize = FileInternal->GetXSize()
 697                     * FileInternal->GetYSize()
 698                     * FileInternal->GetZSize()
 699                     * ( numberBitsAllocated / 8 )
 700                     * FileInternal->GetSamplesPerPixel();
 701       size_t rgbSize = decSize;
 702       if( FileInternal->HasLUT() )
 703          rgbSize = decSize * 3;
 704
 705       switch(WriteMode)
 706       {
 707          case WMODE_RAW :
 708             if( decSize!=PixelWriteConverter->GetUserDataSize() )
 709             {
 710                gdcmWarningMacro( "Data size (Raw) is incorrect. Should be "
 711                            << decSize << " / Found :"
 712                            << PixelWriteConverter->GetUserDataSize() );
 713                return false;
 714             }
 715             break;
 716          case WMODE_RGB :
 717             if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
 718             {
 719                gdcmWarningMacro( "Data size (RGB) is incorrect. Should be "
 720                           << decSize << " / Found "
 721                           << PixelWriteConverter->GetUserDataSize() );
 722                return false;
 723             }
 724             break;
 725       }
 726    }
 727
 728    return true;
 729 }
 730
 731 /**
 732  * \brief Updates the File to write RAW data (as opposed to RGB data)
 733  *       (modifies, when necessary, photochromatic interpretation,
 734  *       bits allocated, Pixels element VR)
 735  */
 736 void FileHelper::SetWriteToRaw()
 737 {
 738    if( FileInternal->GetNumberOfScalarComponents() == 3
 739     && !FileInternal->HasLUT())
 740    {
 741       SetWriteToRGB();
 742    }
 743    else
 744    {
 745       ValEntry *photInt = CopyValEntry(0x0028,0x0004);
 746       if(FileInternal->HasLUT())
 747       {
 748          photInt->SetValue("PALETTE COLOR ");
 749       }
 750       else
 751       {
 752          photInt->SetValue("MONOCHROME2 ");
 753       }
 754
 755       PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
 756                                        PixelReadConverter->GetRawSize());
 757
 758       std::string vr = "OB";
 759       if( FileInternal->GetBitsAllocated()>8 )
 760          vr = "OW";
 761       if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
 762          vr = "OB";
 763       BinEntry *pixel =
 764          CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
 765       pixel->SetValue(GDCM_BINLOADED);
 766       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
 767       pixel->SetLength(PixelWriteConverter->GetDataSize());
 768
 769       Archive->Push(photInt);
 770       Archive->Push(pixel);
 771    }
 772 }
 773
 774 /**
 775  * \brief Updates the File to write RGB data (as opposed to RAW data)
 776  *       (modifies, when necessary, photochromatic interpretation,
 777  *       samples per pixel, Planar configuration,
 778  *       bits allocated, bits stored, high bit -ACR 24 bits-
 779  *       Pixels element VR, pushes out the LUT, )
 780  */
 781 void FileHelper::SetWriteToRGB()
 782 {
 783    if(FileInternal->GetNumberOfScalarComponents()==3)
 784    {
 785       PixelReadConverter->BuildRGBImage();
 786
 787       ValEntry *spp = CopyValEntry(0x0028,0x0002);
 788       spp->SetValue("3 ");
 789
 790       ValEntry *planConfig = CopyValEntry(0x0028,0x0006);
 791       planConfig->SetValue("0 ");
 792
 793       ValEntry *photInt = CopyValEntry(0x0028,0x0004);
 794       photInt->SetValue("RGB ");
 795
 796       if(PixelReadConverter->GetRGB())
 797       {
 798          PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
 799                                           PixelReadConverter->GetRGBSize());
 800       }
 801       else // Raw data
 802       {
 803          PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
 804                                           PixelReadConverter->GetRawSize());
 805       }
 806
 807       std::string vr = "OB";
 808       if( FileInternal->GetBitsAllocated()>8 )
 809          vr = "OW";
 810       if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
 811          vr = "OB";
 812       BinEntry *pixel =
 813          CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
 814       pixel->SetValue(GDCM_BINLOADED);
 815       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
 816       pixel->SetLength(PixelWriteConverter->GetDataSize());
 817
 818       Archive->Push(spp);
 819       Archive->Push(planConfig);
 820       Archive->Push(photInt);
 821       Archive->Push(pixel);
 822
 823       // Remove any LUT
 824       Archive->Push(0x0028,0x1101);
 825       Archive->Push(0x0028,0x1102);
 826       Archive->Push(0x0028,0x1103);
 827       Archive->Push(0x0028,0x1201);
 828       Archive->Push(0x0028,0x1202);
 829       Archive->Push(0x0028,0x1203);
 830
 831       // For old '24 Bits' ACR-NEMA
 832       // Thus, we have a RGB image and the bits allocated = 24 and
 833       // samples per pixels = 1 (in the read file)
 834       if(FileInternal->GetBitsAllocated()==24)
 835       {
 836          ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
 837          bitsAlloc->SetValue("8 ");
 838
 839          ValEntry *bitsStored = CopyValEntry(0x0028,0x0101);
 840          bitsStored->SetValue("8 ");
 841
 842          ValEntry *highBit = CopyValEntry(0x0028,0x0102);
 843          highBit->SetValue("7 ");
 844
 845          Archive->Push(bitsAlloc);
 846          Archive->Push(bitsStored);
 847          Archive->Push(highBit);
 848       }
 849    }
 850    else
 851    {
 852       SetWriteToRaw();
 853    }
 854 }
 855
 856 /**
 857  * \brief Restore the File write mode
 858  */
 859 void FileHelper::RestoreWrite()
 860 {
 861    Archive->Restore(0x0028,0x0002);
 862    Archive->Restore(0x0028,0x0004);
 863    Archive->Restore(0x0028,0x0006);
 864    Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
 865
 866    // For old ACR-NEMA (24 bits problem)
 867    Archive->Restore(0x0028,0x0100);
 868    Archive->Restore(0x0028,0x0101);
 869    Archive->Restore(0x0028,0x0102);
 870
 871    // For the LUT
 872    Archive->Restore(0x0028,0x1101);
 873    Archive->Restore(0x0028,0x1102);
 874    Archive->Restore(0x0028,0x1103);
 875    Archive->Restore(0x0028,0x1201);
 876    Archive->Restore(0x0028,0x1202);
 877    Archive->Restore(0x0028,0x1203);
 878
 879    // group 0002 may be pushed out for ACR-NEMA writting purposes
 880    Archive->Restore(0x0002,0x0000);
 881    Archive->Restore(0x0002,0x0001);
 882    Archive->Restore(0x0002,0x0002);
 883    Archive->Restore(0x0002,0x0003);
 884    Archive->Restore(0x0002,0x0010);
 885    Archive->Restore(0x0002,0x0012);
 886    Archive->Restore(0x0002,0x0013);
 887    Archive->Restore(0x0002,0x0016);
 888    Archive->Restore(0x0002,0x0100);
 889    Archive->Restore(0x0002,0x0102);
 890 }
 891
 892 /**
 893  * \brief Pushes out the whole group 0002
 894  *        FIXME : better, set a flag to tell the writer not to write it ...
 895  *        FIXME : method should probably have an other name !
 896  *                SetWriteFileTypeToACR is NOT opposed to
 897  *                SetWriteFileTypeToExplicitVR and SetWriteFileTypeToImplicitVR
 898  */
 899 void FileHelper::SetWriteFileTypeToACR()
 900 {
 901    Archive->Push(0x0002,0x0000);
 902    Archive->Push(0x0002,0x0001);
 903    Archive->Push(0x0002,0x0002);
 904    Archive->Push(0x0002,0x0003);
 905    Archive->Push(0x0002,0x0010);
 906    Archive->Push(0x0002,0x0012);
 907    Archive->Push(0x0002,0x0013);
 908    Archive->Push(0x0002,0x0016);
 909    Archive->Push(0x0002,0x0100);
 910    Archive->Push(0x0002,0x0102);
 911 }
 912
 913 /**
 914  * \brief Sets in the File the TransferSyntax to 'Explicit VR Little Endian"
 915  */
 916 void FileHelper::SetWriteFileTypeToExplicitVR()
 917 {
 918    std::string ts = Util::DicomString(
 919       Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
 920
 921    ValEntry *tss = CopyValEntry(0x0002,0x0010);
 922    tss->SetValue(ts);
 923
 924    Archive->Push(tss);
 925 }
 926
 927 /**
 928  * \brief Sets in the File the TransferSyntax to 'Implicit VR Little Endian"
 929  */
 930 void FileHelper::SetWriteFileTypeToImplicitVR()
 931 {
 932    std::string ts = Util::DicomString(
 933       Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
 934
 935    ValEntry *tss = CopyValEntry(0x0002,0x0010);
 936    tss->SetValue(ts);
 937
 938    Archive->Push(tss);
 939 }
 940
 941
 942 /**
 943  * \brief Restore in the File the initial group 0002
 944  */
 945 void FileHelper::RestoreWriteFileType()
 946 {
 947 }
 948
 949 /**
 950  * \brief Set the Write not to Libido format
 951  */
 952 void FileHelper::SetWriteToLibido()
 953 {
 954    ValEntry *oldRow = dynamic_cast<ValEntry *>
 955                 (FileInternal->GetDocEntry(0x0028, 0x0010));
 956    ValEntry *oldCol = dynamic_cast<ValEntry *>
 957                 (FileInternal->GetDocEntry(0x0028, 0x0011));
 958
 959    if( oldRow && oldCol )
 960    {
 961       std::string rows, columns;
 962
 963       ValEntry *newRow=new ValEntry(oldRow->GetDictEntry());
 964       ValEntry *newCol=new ValEntry(oldCol->GetDictEntry());
 965
 966       newRow->Copy(oldCol);
 967       newCol->Copy(oldRow);
 968
 969       newRow->SetValue(oldCol->GetValue());
 970       newCol->SetValue(oldRow->GetValue());
 971
 972       Archive->Push(newRow);
 973       Archive->Push(newCol);
 974    }
 975
 976    ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
 977    libidoCode->SetValue("ACRNEMA_LIBIDO_1.1");
 978    Archive->Push(libidoCode);
 979 }
 980
 981 /**
 982  * \brief Set the Write not to No Libido format
 983  */
 984 void FileHelper::SetWriteToNoLibido()
 985 {
 986    ValEntry *recCode = dynamic_cast<ValEntry *>
 987                 (FileInternal->GetDocEntry(0x0008,0x0010));
 988    if( recCode )
 989    {
 990       if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
 991       {
 992          ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
 993          libidoCode->SetValue("");
 994          Archive->Push(libidoCode);
 995       }
 996    }
 997 }
 998
 999 /**
1000  * \brief Restore the Write format
1001  */
1002 void FileHelper::RestoreWriteOfLibido()
1003 {
1004    Archive->Restore(0x0028,0x0010);
1005    Archive->Restore(0x0028,0x0011);
1006    Archive->Restore(0x0008,0x0010);
1007 }
1008
1009 /**
1010  * \brief Duplicates a ValEntry or creates it.
1011  * @param   group   Group number of the Entry
1012  * @param   elem  Element number of the Entry
1013  * \return  pointer to the new Val Entry (NULL when creation failed).
1014  */
1015 ValEntry *FileHelper::CopyValEntry(uint16_t group, uint16_t elem)
1016 {
1017    DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
1018    ValEntry *newE;
1019
1020    if( oldE )
1021    {
1022       newE = new ValEntry(oldE->GetDictEntry());
1023       newE->Copy(oldE);
1024    }
1025    else
1026    {
1027       newE = GetFile()->NewValEntry(group, elem);
1028    }
1029
1030    return newE;
1031 }
1032
1033 /**
1034  * \brief   Duplicates a BinEntry or creates it.
1035  * @param   group   Group number of the Entry
1036  * @param   elem  Element number of the Entry
1037  * @param   vr  Value Representation of the Entry
1038  *          FIXME : what is it used for?
1039  * \return  pointer to the new Bin Entry (NULL when creation failed).
1040  */
1041 BinEntry *FileHelper::CopyBinEntry(uint16_t group, uint16_t elem,
1042                                    const std::string &vr)
1043 {
1044    DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
1045    BinEntry *newE;
1046
1047    if( oldE )
1048       if( oldE->GetVR()!=vr )
1049          oldE = NULL;
1050
1051    if( oldE )
1052    {
1053       newE = new BinEntry(oldE->GetDictEntry());
1054       newE->Copy(oldE);
1055    }
1056    else
1057    {
1058       newE = GetFile()->NewBinEntry(group, elem, vr);
1059    }
1060
1061    return newE;
1062 }
1063
1064 /**
1065  * \brief   This method is called automatically, just before writting
1066  *         in order to produce a 'True Dicom V3' image
1067  *         We cannot know *how* the user made the File (reading an old ACR-NEMA
1068  *         file or a not very clean DICOM file ...)
1069  *
1070  *          Just before writting :
1071  *             - we check the Entries
1072  *             - we create the mandatory entries if they are missing
1073  *             - we modify the values if necessary
1074  *             - we push the sensitive entries to the Archive
1075  *          The writing process will restore the entries as they where before
1076  *          entering FileHelper::CheckMandatoryElements, so the user will always
1077  *          see the entries just as he left them.
1078  *
1079  * \todo : - warn the user if we had to add some entries :
1080  *         even if a mandatory entry is missing, we add it, with a default value
1081  *         (we don't want to give up the writting process if user forgot to
1082  *         specify Lena's Patient ID, for instance ...)
1083  *         - read the whole PS 3.3 Part of DICOM  (890 pages)
1084  *         and write a *full* checker (probably one method per Modality ...)
1085  *         Any contribution is welcome.
1086  *         - write a user callable full checker, to allow post reading
1087  *         and/or pre writting image consistency check.
1088  */
1089
1090 void FileHelper::CheckMandatoryElements()
1091 {
1092    // just to remember : 'official' 0002 group
1093
1094    //0002 0000 UL 1 Meta Group Length
1095    //0002 0001 OB 1 File Meta Information Version
1096    //0002 0002 UI 1 Media Stored SOP Class UID
1097    //0002 0003 UI 1 Media Stored SOP Instance UID
1098    //0002 0010 UI 1 Transfer Syntax UID
1099    //0002 0012 UI 1 Implementation Class UID
1100    //0002 0013 SH 1 Implementation Version Name
1101    //0002 0016 AE 1 Source Application Entity Title
1102    //0002 0100 UI 1 Private Information Creator
1103    //0002 0102 OB 1 Private Information
1104
1105    // Create them if not found
1106    // Always modify the value
1107    // Push the entries to the archive.
1108    ValEntry *e_0002_0000 = CopyValEntry(0x0002,0x0000);
1109       e_0002_0000->SetValue("0"); // for the moment
1110       Archive->Push(e_0002_0000);
1111
1112    BinEntry *e_0002_0001 = CopyBinEntry(0x0002,0x0001, "OB");
1113       e_0002_0001->SetBinArea((uint8_t*)Util::GetFileMetaInformationVersion(),
1114                                false);
1115       e_0002_0001->SetLength(2);
1116       Archive->Push(e_0002_0001);
1117
1118    ValEntry *e_0002_0002 = CopyValEntry(0x0002,0x0002);
1119       // [Secondary Capture Image Storage]
1120       e_0002_0002->SetValue("1.2.840.10008.5.1.4.1.1.7");
1121       Archive->Push(e_0002_0002);
1122
1123    // 'Media Stored SOP Instance UID'
1124    ValEntry *e_0002_0003 = CopyValEntry(0x0002,0x0003);
1125       e_0002_0003->SetValue(Util::CreateUniqueUID());
1126       Archive->Push(e_0002_0003);
1127
1128    // 'Implementation Class UID'
1129    ValEntry *e_0002_0012 = CopyValEntry(0x0002,0x0012);
1130       e_0002_0012->SetValue(Util::CreateUniqueUID());
1131       Archive->Push(e_0002_0012);
1132
1133    // 'Implementation Version Name'
1134    ValEntry *e_0002_0013 = CopyValEntry(0x0002,0x0013);
1135       e_0002_0013->SetValue("GDCM 1.0");
1136       Archive->Push(e_0002_0013);
1137
1138    //'Source Application Entity Title' Not Mandatory
1139    //ValEntry *e_0002_0016 = CopyValEntry(0x0002,0x0016);
1140    //   e_0002_0016->SetValue("1.2.840.10008.5.1.4.1.1.7");
1141    //   Archive->Push(e_0002_0016);
1142
1143    // Push out 'LibIDO-special' entries, if any
1144    Archive->Push(0x0028,0x0015);
1145    Archive->Push(0x0028,0x0016);
1146    Archive->Push(0x0028,0x0017);
1147    Archive->Push(0x0028,0x00199);
1148
1149    // --- Check UID-related Entries ---
1150
1151    // If 'SOP Class UID' exists ('true DICOM' image)
1152    // we create the 'Source Image Sequence' SeqEntry
1153    // to hold informations about the Source Image
1154
1155    ValEntry *e_0008_0016 = FileInternal->GetValEntry(0x0008, 0x0016);
1156    if ( e_0008_0016 != 0 )
1157    {
1158       // Create 'Source Image Sequence' SeqEntry
1159       SeqEntry *s = new SeqEntry (
1160             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x2112) );
1161       SQItem *sqi = new SQItem(1);
1162       // (we assume 'SOP Instance UID' exists too)
1163       // create 'Referenced SOP Class UID'
1164       ValEntry *e_0008_1150 = new ValEntry(
1165             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1150) );
1166       e_0008_1150->SetValue( e_0008_0016->GetValue());
1167       sqi->AddEntry(e_0008_1150);
1168
1169       // create 'Referenced SOP Instance UID'
1170       ValEntry *e_0008_0018 = FileInternal->GetValEntry(0x0008, 0x0018);
1171       ValEntry *e_0008_1155 = new ValEntry(
1172             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1155) );
1173       e_0008_1155->SetValue( e_0008_0018->GetValue());
1174       sqi->AddEntry(e_0008_1155);
1175
1176       s->AddSQItem(sqi,1);
1177       // temporarily replaces any previous 'Source Image Sequence'
1178       Archive->Push(s);
1179
1180       // 'Image Type' (The written image is no longer an 'ORIGINAL' one)
1181       ValEntry *e_0008_0008 = CopyValEntry(0x0008,0x0008);
1182       e_0008_0008->SetValue("DERIVED\\PRIMARY");
1183       Archive->Push(e_0008_0008);
1184    }
1185    else
1186    {
1187       // There was no 'SOP Class UID'.
1188       // the source image was NOT a true Dicom one.
1189       // We consider the image is a 'Secondary Capture' one
1190       // SOP Class UID
1191       e_0008_0016  =  new ValEntry(
1192             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0016) );
1193       // [Secondary Capture Image Storage]
1194       e_0008_0016 ->SetValue("1.2.840.10008.5.1.4.1.1.7");
1195       Archive->Push(e_0008_0016);
1196    }
1197
1198 // ---- The user will never have to take any action on the following ----.
1199
1200    // new value for 'SOP Instance UID'
1201    ValEntry *e_0008_0018 = new ValEntry(
1202          Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0018) );
1203    e_0008_0018->SetValue( Util::CreateUniqueUID() );
1204    Archive->Push(e_0008_0018);
1205
1206    // Instance Creation Date
1207    ValEntry *e_0008_0012 = CopyValEntry(0x0008,0x0012);
1208    std::string date = Util::GetCurrentDate();
1209    e_0008_0012->SetValue(date.c_str());
1210    Archive->Push(e_0008_0012);
1211
1212    // Instance Creation Time
1213    ValEntry *e_0008_0013 = CopyValEntry(0x0008,0x0013);
1214    std::string time = Util::GetCurrentTime();
1215    e_0008_0013->SetValue(time.c_str());
1216    Archive->Push(e_0008_0013);
1217
1218 // ----- Add Mandatory Entries if missing ---
1219
1220 // Entries whose type is 1 are mandatory, with a mandatory value
1221 // Entries whose type is 1c are mandatory-inside-a-Sequence
1222 // Entries whose type is 2 are mandatory, with a optional value
1223 // Entries whose type is 2c are mandatory-inside-a-Sequence
1224 // Entries whose type is 3 are optional
1225
1226    // 'Serie Instance UID'
1227    // Keep the value if exists
1228    // The user is allowed to create his own Series,
1229    // keeping the same 'Serie Instance UID' for various images
1230    // The user shouldn't add any image to a 'Manufacturer Serie'
1231    // but there is no way no to allowed him to do that
1232    ValEntry *e_0020_000e = FileInternal->GetValEntry(0x0020, 0x000e);
1233    if ( !e_0020_000e )
1234    {
1235       e_0020_000e = new ValEntry(
1236            Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0020, 0x000e) );
1237       e_0020_000e->SetValue(Util::CreateUniqueUID() );
1238       Archive->Push(e_0020_000e);
1239    }
1240
1241    // 'Study Instance UID'
1242    // Keep the value if exists
1243    // The user is allowed to create his own Study,
1244    //          keeping the same 'Study Instance UID' for various images
1245    // The user may add images to a 'Manufacturer Study',
1246    //          adding new series to an already existing Study
1247    ValEntry *e_0020_000d = FileInternal->GetValEntry(0x0020, 0x000d);
1248    if ( !e_0020_000d )
1249    {
1250       e_0020_000d = new ValEntry(
1251             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0020, 0x000d) );
1252       e_0020_000d->SetValue(Util::CreateUniqueUID() );
1253       Archive->Push(e_0020_000d);
1254    }
1255
1256    // Modality : if missing we set it to 'OTher'
1257    ValEntry *e_0008_0060 = FileInternal->GetValEntry(0x0008, 0x0060);
1258    if ( !e_0008_0060 )
1259    {
1260       e_0008_0060 = new ValEntry(
1261             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0060) );
1262       e_0008_0060->SetValue("OT");
1263       Archive->Push(e_0008_0060);
1264    }
1265
1266    // Manufacturer : if missing we set it to 'GDCM Factory'
1267    ValEntry *e_0008_0070 = FileInternal->GetValEntry(0x0008, 0x0070);
1268    if ( !e_0008_0070 )
1269    {
1270       e_0008_0070 = new ValEntry(
1271             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0070) );
1272       e_0008_0070->SetValue("GDCM Factory");
1273       Archive->Push(e_0008_0070);
1274    }
1275
1276    // Institution Name : if missing we set it to 'GDCM Hospital'
1277    ValEntry *e_0008_0080 = FileInternal->GetValEntry(0x0008, 0x0080);
1278    if ( !e_0008_0080 )
1279    {
1280       e_0008_0080 = new ValEntry(
1281             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0080) );
1282       e_0008_0080->SetValue("GDCM Hospital");
1283       Archive->Push(e_0008_0080);
1284    }
1285
1286    // Patient's Name : if missing, we set it to 'GDCM^Patient'
1287    ValEntry *e_0010_0010 = FileInternal->GetValEntry(0x0010, 0x0010);
1288    if ( !e_0010_0010 )
1289    {
1290       e_0010_0010 = new ValEntry(
1291             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0010) );
1292       e_0010_0010->SetValue("GDCM^Patient");
1293       Archive->Push(e_0010_0010);
1294    }
1295
1296    // Patient's ID : if missing, we set it to 'GDCM_Patient_ID'
1297    ValEntry *e_0010_0020 = FileInternal->GetValEntry(0x0010, 0x0020);
1298    if ( !e_0010_0020 )
1299    {
1300       e_0010_0020 = new ValEntry(
1301             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0020) );
1302       e_0010_0020->SetValue("GDCM_Patient_ID");
1303       Archive->Push(e_0010_0020);
1304    }
1305
1306    // Patient's Birth Date :'type 2' entry -> must exist, value not mandatory
1307    ValEntry *e_0010_0030 = FileInternal->GetValEntry(0x0010, 0x0030);
1308    if ( !e_0010_0030 )
1309    {
1310       e_0010_0030 = new ValEntry(
1311             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0030) );
1312       e_0010_0030->SetValue("");
1313       Archive->Push(e_0010_0030);
1314    }
1315
1316    // Patient's Sex :'type 2' entry -> must exist, value not mandatory
1317    ValEntry *e_0010_0040 = FileInternal->GetValEntry(0x0010, 0x0040);
1318    if ( !e_0010_0040 )
1319    {
1320       e_0010_0040 = new ValEntry(
1321             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0040) );
1322       e_0010_0040->SetValue("");
1323       Archive->Push(e_0010_0040);
1324    }
1325
1326    // Referring Physician's Name :'type 2' entry -> must exist, value not mandatory
1327    ValEntry *e_0008_0090 = FileInternal->GetValEntry(0x0008, 0x0090);
1328    if ( !e_0008_0090 )
1329    {
1330       e_0008_0090 = new ValEntry(
1331             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0090) );
1332       e_0008_0090->SetValue("");
1333       Archive->Push(e_0008_0090);
1334    }
1335
1336    // Remove some inconstencies (probably some more will be added)
1337
1338    // if (0028 0008)Number of Frames exists
1339    //    Push out (0020 0052),Frame of Reference UID
1340    //    (only meaningfull within a Serie)
1341    ValEntry *e_0028_0008 = FileInternal->GetValEntry(0x0028, 0x0008);
1342    if ( !e_0028_0008 )
1343    {
1344       Archive->Push(0x0020, 0X0052);
1345    }
1346 }
1347
1348 /**
1349  * \brief Restore in the File the initial group 0002
1350  */
1351 void FileHelper::RestoreWriteMandatory()
1352 {
1353    // group 0002 may be pushed out for ACR-NEMA writting purposes
1354    Archive->Restore(0x0002,0x0000);
1355    Archive->Restore(0x0002,0x0001);
1356    Archive->Restore(0x0002,0x0002);
1357    Archive->Restore(0x0002,0x0003);
1358    Archive->Restore(0x0002,0x0012);
1359    Archive->Restore(0x0002,0x0013);
1360    Archive->Restore(0x0002,0x0016);
1361    Archive->Restore(0x0002,0x0100);
1362    Archive->Restore(0x0002,0x0102);
1363 }
1364
1365 //-----------------------------------------------------------------------------
1366 // Private
1367 /**
1368  * \brief Factorization for various forms of constructors.
1369  */
1370 void FileHelper::Initialize()
1371 {
1372    WriteMode = WMODE_RAW;
1373    WriteType = ExplicitVR;
1374
1375    PixelReadConverter  = new PixelReadConvert;
1376    PixelWriteConverter = new PixelWriteConvert;
1377    Archive = new DocEntryArchive( FileInternal );
1378
1379    if ( FileInternal->IsReadable() )
1380    {
1381       PixelReadConverter->GrabInformationsFromFile( FileInternal );
1382    }
1383 }
1384
1385 /**
1386  * \brief
1387  */
1388 uint8_t *FileHelper::GetRaw()
1389 {
1390    uint8_t *raw = PixelReadConverter->GetRaw();
1391    if ( ! raw )
1392    {
1393       // The Raw image migth not be loaded yet:
1394       std::ifstream *fp = FileInternal->OpenFile();
1395       PixelReadConverter->ReadAndDecompressPixelData( fp );
1396       if(fp)
1397          FileInternal->CloseFile();
1398
1399       raw = PixelReadConverter->GetRaw();
1400       if ( ! raw )
1401       {
1402          gdcmWarningMacro( "Read/decompress of pixel data apparently went wrong.");
1403          return 0;
1404       }
1405    }
1406
1407    return raw;
1408 }
1409
1410 //-----------------------------------------------------------------------------
1411 // Print
1412 void FileHelper::Print(std::ostream &os, std::string const &)
1413 {
1414    FileInternal->SetPrintLevel(PrintLevel);
1415    FileInternal->Print(os);
1416
1417    PixelReadConverter->SetPrintLevel(PrintLevel);
1418    PixelReadConverter->Print(os);
1419 }
1420
1421 //-----------------------------------------------------------------------------
1422 } // end namespace gdcm