src/gdcmFileHelper.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.cxx,v $
   5   Language:  C++
   6
   7   Date:      $Date: 2006/03/13 14:44:07 $
   8   Version:   $Revision: 1.97 $
   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 "gdcmSeqEntry.h"
  27 #include "gdcmSQItem.h"
  28 #include "gdcmDataEntry.h"
  29 #include "gdcmDocEntry.h"
  30 #include "gdcmFile.h"
  31 #include "gdcmPixelReadConvert.h"
  32 #include "gdcmPixelWriteConvert.h"
  33 #include "gdcmDocEntryArchive.h"
  34 #include "gdcmDictSet.h"
  35 #include "gdcmOrientation.h"
  36
  37 #if defined(__BORLANDC__)
  38    #include <mem.h> // for memset
  39 #endif
  40
  41 #include <fstream>
  42
  43 /*
  44 // ----------------------------- WARNING -------------------------
  45
  46 These lines will be moved to the document-to-be 'User's Guide'
  47
  48 // To read an image, user needs a gdcm::File
  49 gdcm::File *f = new gdcm::File(fileName);
  50 // or (advanced) :
  51 // user may also decide he doesn't want to load some parts of the header
  52 gdcm::File *f = new gdcm::File();
  53 f->SetFileName(fileName);
  54    f->SetLoadMode(LD_NOSEQ);             // or
  55    f->SetLoadMode(LD_NOSHADOW);          // or
  56    f->SetLoadMode(LD_NOSEQ | LD_NOSHADOW); // or
  57    f->SetLoadMode(LD_NOSHADOWSEQ);
  58 f->Load();
  59
  60 // user can now check some values
  61 std::string v = f->GetEntryValue(groupNb,ElementNb);
  62
  63 // to get the pixels, user needs a gdcm::FileHelper
  64 gdcm::FileHelper *fh = new gdcm::FileHelper(f);
  65 // user may ask not to convert Palette to RGB
  66 uint8_t *pixels = fh->GetImageDataRaw();
  67 int imageLength = fh->GetImageDataRawSize();
  68 // He can now use the pixels, create a new image, ...
  69 uint8_t *userPixels = ...
  70
  71 To re-write the image, user re-uses the gdcm::FileHelper
  72
  73 fh->SetImageData( userPixels, userPixelsLength);
  74 fh->SetTypeToRaw(); // Even if it was possible to convert Palette to RGB
  75                      // (WriteMode is set)
  76
  77 fh->SetWriteTypeToDcmExpl();  // he wants Explicit Value Representation
  78                               // Little Endian is the default
  79                               // no other value is allowed
  80                                 (-->SetWriteType(ExplicitVR);)
  81                                    -->WriteType = ExplicitVR;
  82 fh->Write(newFileName);      // overwrites the file, if any
  83
  84 // or :
  85 fh->WriteDcmExplVR(newFileName);
  86
  87
  88 // ----------------------------- WARNING -------------------------
  89
  90 These lines will be moved to the document-to-be 'Developer's Guide'
  91
  92 WriteMode : WMODE_RAW / WMODE_RGB
  93 WriteType : ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO
  94
  95 fh1->Write(newFileName);
  96    SetWriteFileTypeToImplicitVR() / SetWriteFileTypeToExplicitVR();
  97    (modifies TransferSyntax)
  98    SetWriteToRaw(); / SetWriteToRGB();
  99       (modifies, when necessary : photochromatic interpretation,
 100          samples per pixel, Planar configuration,
 101          bits allocated, bits stored, high bit -ACR 24 bits-
 102          Pixels element VR, pushes out the LUT )
 103    CheckWriteIntegrity();
 104       (checks user given pixels length)
 105    FileInternal->Write(fileName,WriteType)
 106    fp = opens file(fileName);
 107    ComputeGroup0002Length( );
 108    BitsAllocated 12->16
 109       RemoveEntry(palettes, etc)
 110       Document::WriteContent(fp, writetype);
 111    RestoreWrite();
 112       (moves back to the File all the archived elements)
 113    RestoreWriteFileType();
 114       (pushes back group 0002, with TransferSyntax)
 115 */
 116
 117
 118
 119
 120 namespace gdcm
 121 {
 122 typedef std::map<uint16_t, int> GroupHT;    //  Hash Table
 123 //-------------------------------------------------------------------------
 124 // Constructor / Destructor
 125 /**
 126  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
 127  *        file (gdcm::File only deals with the ... header)
 128  *        Opens (in read only and when possible) an existing file and checks
 129  *        for DICOM compliance. Returns NULL on failure.
 130  *        It will be up to the user to load the pixels into memory
 131  *        ( GetImageDataSize() + GetImageData() methods)
 132  * \note  the in-memory representation of all available tags found in
 133  *        the DICOM header is post-poned to first header information access.
 134  *        This avoid a double parsing of public part of the header when
 135  *        one sets an a posteriori shadow dictionary (efficiency can be
 136  *        seen as a side effect).
 137  */
 138 FileHelper::FileHelper( )
 139 {
 140    FileInternal = File::New( );
 141    Initialize();
 142 }
 143
 144 /**
 145  * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
 146  *        file (File only deals with the ... header)
 147  *        Opens (in read only and when possible) an existing file and checks
 148  *        for DICOM compliance. Returns NULL on failure.
 149  *        It will be up to the user to load the pixels into memory
 150  *        ( GetImageDataSize() + GetImageData() methods)
 151  * \note  the in-memory representation of all available tags found in
 152  *        the DICOM header is post-poned to first header information access.
 153  *        This avoid a double parsing of public part of the header when
 154  *        user sets an a posteriori shadow dictionary (efficiency can be
 155  *        seen as a side effect).
 156  * @param header already built Header
 157  */
 158 FileHelper::FileHelper(File *header)
 159 {
 160    gdcmAssertMacro(header);
 161
 162    FileInternal = header;
 163    FileInternal->Register();
 164    Initialize();
 165    if ( FileInternal->IsReadable() )
 166    {
 167       PixelReadConverter->GrabInformationsFromFile( FileInternal, this );
 168    }
 169 }
 170
 171 /**
 172  * \brief canonical destructor
 173  * \note  If the header (gdcm::File) was created by the FileHelper constructor,
 174  *        it is destroyed by the FileHelper
 175  */
 176 FileHelper::~FileHelper()
 177 {
 178    if ( PixelReadConverter )
 179    {
 180       delete PixelReadConverter;
 181    }
 182    if ( PixelWriteConverter )
 183    {
 184       delete PixelWriteConverter;
 185    }
 186    if ( Archive )
 187    {
 188       delete Archive;
 189    }
 190
 191    FileInternal->Unregister();
 192 }
 193
 194 //-----------------------------------------------------------------------------
 195 // Public
 196
 197 /**
 198  * \brief Sets the LoadMode of the internal gdcm::File as a boolean string.
 199  *        NO_SEQ, NO_SHADOW, NO_SHADOWSEQ ... (nothing more, right now)
 200  *        WARNING : before using NO_SHADOW, be sure *all* your files
 201  *        contain accurate values in the 0x0000 element (if any)
 202  *        of *each* Shadow Group. The parser will fail if the size is wrong !
 203  * @param   loadMode Load mode to be used
 204  */
 205 void FileHelper::SetLoadMode(int loadMode)
 206 {
 207    GetFile()->SetLoadMode( loadMode );
 208 }
 209 /**
 210  * \brief Sets the LoadMode of the internal gdcm::File
 211  * @param  fileName name of the file to be open
 212  */
 213 void FileHelper::SetFileName(std::string const &fileName)
 214 {
 215    FileInternal->SetFileName( fileName );
 216 }
 217
 218 /**
 219  * \brief   Loader
 220  * @return false if file cannot be open or no swap info was found,
 221  *         or no tag was found.
 222  */
 223 bool FileHelper::Load()
 224 {
 225    if ( !FileInternal->Load() )
 226       return false;
 227
 228    PixelReadConverter->GrabInformationsFromFile( FileInternal, this );
 229    return true;
 230 }
 231
 232 /**
 233  * \brief   Accesses an existing DataEntry through it's (group, element)
 234  *          and modifies it's content with the given value.
 235  * @param   content new value (string) to substitute with
 236  * @param   group  group number of the Dicom Element to modify
 237  * @param   elem element number of the Dicom Element to modify
 238  * \return  false if DataEntry not found
 239  */
 240 bool FileHelper::SetEntryString(std::string const &content,
 241                                 uint16_t group, uint16_t elem)
 242 {
 243    return FileInternal->SetEntryString(content, group, elem);
 244 }
 245
 246
 247 /**
 248  * \brief   Accesses an existing DataEntry through it's (group, element)
 249  *          and modifies it's content with the given value.
 250  * @param   content new value (void*  -> uint8_t*) to substitute with
 251  * @param   lgth new value length
 252  * @param   group  group number of the Dicom Element to modify
 253  * @param   elem element number of the Dicom Element to modify
 254  * \return  false if DataEntry not found
 255  */
 256 bool FileHelper::SetEntryBinArea(uint8_t *content, int lgth,
 257                                  uint16_t group, uint16_t elem)
 258 {
 259    return FileInternal->SetEntryBinArea(content, lgth, group, elem);
 260 }
 261
 262 /**
 263  * \brief   Modifies the value of a given DataEntry when it exists.
 264  *          Creates it with the given value when unexistant.
 265  * @param   content (string) value to be set
 266  * @param   group   Group number of the Entry
 267  * @param   elem  Element number of the Entry
 268  * \return  pointer to the modified/created DataEntry (NULL when creation
 269  *          failed).
 270  */
 271 DataEntry *FileHelper::InsertEntryString(std::string const &content,
 272                                                 uint16_t group, uint16_t elem)
 273 {
 274    return FileInternal->InsertEntryString(content, group, elem);
 275 }
 276
 277 /**
 278  * \brief   Modifies the value of a given DataEntry when it exists.
 279  *          Creates it with the given value when unexistant.
 280  *          A copy of the binArea is made to be kept in the Document.
 281  * @param   binArea (binary)value to be set
 282  * @param   lgth new value length
 283  * @param   group   Group number of the Entry
 284  * @param   elem  Element number of the Entry
 285  * \return  pointer to the modified/created DataEntry (NULL when creation
 286  *          failed).
 287  */
 288 DataEntry *FileHelper::InsertEntryBinArea(uint8_t *binArea, int lgth,
 289                                           uint16_t group, uint16_t elem)
 290 {
 291    return FileInternal->InsertEntryBinArea(binArea, lgth, group, elem);
 292 }
 293
 294 /**
 295  * \brief   Adds an empty SeqEntry
 296  *          (remove any existing entry with same group,elem)
 297  * @param   group   Group number of the Entry
 298  * @param   elem  Element number of the Entry
 299  * \return  pointer to the created SeqEntry (NULL when creation
 300  *          failed).
 301  */
 302 SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
 303 {
 304    return FileInternal->InsertSeqEntry(group, elem);
 305 }
 306
 307 /**
 308  * \brief   Get the size of the image data
 309  *          If the image can be RGB (with a lut or by default), the size
 310  *          corresponds to the RGB image
 311  *         (use GetImageDataRawSize if you want to be sure to get *only*
 312  *          the size of the pixels)
 313  * @return  The image size
 314  */
 315 size_t FileHelper::GetImageDataSize()
 316 {
 317    if ( PixelWriteConverter->GetUserData() )
 318    {
 319       return PixelWriteConverter->GetUserDataSize();
 320    }
 321    return PixelReadConverter->GetRGBSize();
 322 }
 323
 324 /**
 325  * \brief   Get the size of the image data.
 326  *          If the image could be converted to RGB using a LUT,
 327  *          this transformation is not taken into account by GetImageDataRawSize
 328  *          (use GetImageDataSize if you wish)
 329  * @return  The raw image size
 330  */
 331 size_t FileHelper::GetImageDataRawSize()
 332 {
 333    if ( PixelWriteConverter->GetUserData() )
 334    {
 335       return PixelWriteConverter->GetUserDataSize();
 336    }
 337    return PixelReadConverter->GetRawSize();
 338 }
 339
 340 /**
 341  * \brief brings pixels into memory :
 342  *          - Allocates necessary memory,
 343  *          - Reads the pixels from disk (uncompress if necessary),
 344  *          - Transforms YBR pixels, if any, into RGB pixels,
 345  *          - Transforms 3 planes R, G, B, if any, into a single RGB Plane
 346  *          - Transforms single Grey plane + 3 Palettes into a RGB Plane
 347  *          - Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
 348  * @return  Pointer to newly allocated pixel data.
 349  *          (uint8_t is just for prototyping. feel free to cast)
 350  *          NULL if alloc fails
 351  */
 352 uint8_t *FileHelper::GetImageData()
 353 {
 354    if ( PixelWriteConverter->GetUserData() )
 355    {
 356       return PixelWriteConverter->GetUserData();
 357    }
 358
 359    if ( ! GetRaw() )
 360    {
 361       // If the decompression failed nothing can be done.
 362       return 0;
 363    }
 364
 365    if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
 366    {
 367       return PixelReadConverter->GetRGB();
 368    }
 369    else
 370    {
 371       // When no LUT or LUT conversion fails, return the Raw
 372       return PixelReadConverter->GetRaw();
 373    }
 374 }
 375
 376 /**
 377  * \brief brings pixels into memory :
 378  *          - Allocates necessary memory,
 379  *          - Transforms YBR pixels (if any) into RGB pixels
 380  *          - Transforms 3 planes R, G, B  (if any) into a single RGB Plane
 381  *          - Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
 382  *          - DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
 383  * @return  Pointer to newly allocated pixel data.
 384  *          (uint8_t is just for prototyping. feel free to cast)
 385  *          NULL if alloc fails
 386  */
 387 uint8_t *FileHelper::GetImageDataRaw ()
 388 {
 389    return GetRaw();
 390 }
 391
 392 #ifndef GDCM_LEGACY_REMOVE
 393 /*
 394  * \brief   Useless function, since PixelReadConverter forces us
 395  *          copy the Pixels anyway.
 396  *          Reads the pixels from disk (uncompress if necessary),
 397  *          Transforms YBR pixels, if any, into RGB pixels
 398  *          Transforms 3 planes R, G, B, if any, into a single RGB Plane
 399  *          Transforms single Grey plane + 3 Palettes into a RGB Plane
 400  *          Copies at most MaxSize bytes of pixel data to caller allocated
 401  *          memory space.
 402  * \warning This function allows people that want to build a volume
 403  *          from an image stack *not to* have, first to get the image pixels,
 404  *          and then move them to the volume area.
 405  *          It's absolutely useless for any VTK user since vtk chooses
 406  *          to invert the lines of an image, that is the last line comes first
 407  *          (for some axis related reasons?). Hence he will have
 408  *          to load the image line by line, starting from the end.
 409  *          VTK users have to call GetImageData
 410  *
 411  * @param   destination Address (in caller's memory space) at which the
 412  *          pixel data should be copied
 413  * @param   maxSize Maximum number of bytes to be copied. When MaxSize
 414  *          is not sufficient to hold the pixel data the copy is not
 415  *          executed (i.e. no partial copy).
 416  * @return  On success, the number of bytes actually copied. Zero on
 417  *          failure e.g. MaxSize is lower than necessary.
 418  */
 419 size_t FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
 420 {
 421    if ( ! GetRaw() )
 422    {
 423       // If the decompression failed nothing can be done.
 424       return 0;
 425    }
 426
 427    if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
 428    {
 429       if ( PixelReadConverter->GetRGBSize() > maxSize )
 430       {
 431          gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
 432          return 0;
 433       }
 434       memcpy( destination,
 435               (void*)PixelReadConverter->GetRGB(),
 436               PixelReadConverter->GetRGBSize() );
 437       return PixelReadConverter->GetRGBSize();
 438    }
 439
 440    // Either no LUT conversion necessary or LUT conversion failed
 441    if ( PixelReadConverter->GetRawSize() > maxSize )
 442    {
 443       gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
 444       return 0;
 445    }
 446    memcpy( destination,
 447            (void *)PixelReadConverter->GetRaw(),
 448            PixelReadConverter->GetRawSize() );
 449    return PixelReadConverter->GetRawSize();
 450 }
 451 #endif
 452
 453 /**
 454  * \brief   Points the internal pointer to the callers inData
 455  *          image representation, BUT WITHOUT COPYING THE DATA.
 456  *          'image' Pixels are presented as C-like 2D arrays : line per line.
 457  *          'volume'Pixels are presented as C-like 3D arrays : plane per plane
 458  * \warning Since the pixels are not copied, it is the caller's responsability
 459  *          not to deallocate its data before gdcm uses them (e.g. with
 460  *          the Write() method )
 461  * @param inData user supplied pixel area (uint8_t* is just for the compiler.
 462  *               user is allowed to pass any kind of pixelsn since the size is
 463  *               given in bytes)
 464  * @param expectedSize total image size, *in Bytes*
 465  */
 466 void FileHelper::SetImageData(uint8_t *inData, size_t expectedSize)
 467 {
 468    SetUserData(inData, expectedSize);
 469 }
 470
 471 /**
 472  * \brief   Set the image data defined by the user
 473  * \warning When writting the file, this data are get as default data to write
 474  * @param inData user supplied pixel area (uint8_t* is just for the compiler.
 475  *               user is allowed to pass any kind of pixels since the size is
 476  *               given in bytes)
 477  * @param expectedSize total image size, *in Bytes*
 478  */
 479 void FileHelper::SetUserData(uint8_t *inData, size_t expectedSize)
 480 {
 481    PixelWriteConverter->SetUserData(inData, expectedSize);
 482 }
 483
 484 /**
 485  * \brief   Get the image data defined by the user
 486  * \warning When writting the file, this data are get as default data to write
 487  */
 488 uint8_t *FileHelper::GetUserData()
 489 {
 490    return PixelWriteConverter->GetUserData();
 491 }
 492
 493 /**
 494  * \brief   Get the image data size defined by the user
 495  * \warning When writting the file, this data are get as default data to write
 496  */
 497 size_t FileHelper::GetUserDataSize()
 498 {
 499    return PixelWriteConverter->GetUserDataSize();
 500 }
 501
 502 /**
 503  * \brief   Get the image data from the file.
 504  *          If a LUT is found, the data are expanded to be RGB
 505  */
 506 uint8_t *FileHelper::GetRGBData()
 507 {
 508    return PixelReadConverter->GetRGB();
 509 }
 510
 511 /**
 512  * \brief   Get the image data size from the file.
 513  *          If a LUT is found, the data are expanded to be RGB
 514  */
 515 size_t FileHelper::GetRGBDataSize()
 516 {
 517    return PixelReadConverter->GetRGBSize();
 518 }
 519
 520 /**
 521  * \brief   Get the image data from the file.
 522  *          Even when a LUT is found, the data are not expanded to RGB!
 523  */
 524 uint8_t *FileHelper::GetRawData()
 525 {
 526    return PixelReadConverter->GetRaw();
 527 }
 528
 529 /**
 530  * \brief   Get the image data size from the file.
 531  *          Even when a LUT is found, the data are not expanded to RGB!
 532  */
 533 size_t FileHelper::GetRawDataSize()
 534 {
 535    return PixelReadConverter->GetRawSize();
 536 }
 537
 538 /**
 539  * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
 540  */
 541 uint8_t* FileHelper::GetLutRGBA()
 542 {
 543    if ( PixelReadConverter->GetLutRGBA() ==0 )
 544       PixelReadConverter->BuildLUTRGBA();
 545    return PixelReadConverter->GetLutRGBA();
 546 }
 547
 548 /**
 549  * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Number
 550  */
 551 int FileHelper::GetLutItemNumber()
 552 {
 553    return PixelReadConverter->GetLutItemNumber();
 554 }
 555
 556 /**
 557  * \brief Access to the underlying \ref PixelReadConverter RGBA LUT Item Size
 558  */
 559 int FileHelper::GetLutItemSize()
 560 {
 561    return PixelReadConverter->GetLutItemSize();
 562 }
 563
 564 /**
 565  * \brief Writes on disk A SINGLE Dicom file
 566  *        NO test is performed on  processor "Endiannity".
 567  *        It's up to the user to call his Reader properly
 568  * @param fileName name of the file to be created
 569  *                 (any already existing file is over written)
 570  * @return false if write fails
 571  */
 572 bool FileHelper::WriteRawData(std::string const &fileName)
 573 {
 574    std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary );
 575    if (!fp1)
 576    {
 577       gdcmWarningMacro( "Fail to open (write) file:" << fileName.c_str());
 578       return false;
 579    }
 580
 581    if ( PixelWriteConverter->GetUserData() )
 582    {
 583       fp1.write( (char *)PixelWriteConverter->GetUserData(),
 584                  PixelWriteConverter->GetUserDataSize() );
 585    }
 586    else if ( PixelReadConverter->GetRGB() )
 587    {
 588       fp1.write( (char *)PixelReadConverter->GetRGB(),
 589                  PixelReadConverter->GetRGBSize());
 590    }
 591    else if ( PixelReadConverter->GetRaw() )
 592    {
 593       fp1.write( (char *)PixelReadConverter->GetRaw(),
 594                  PixelReadConverter->GetRawSize());
 595    }
 596    else
 597    {
 598       gdcmErrorMacro( "Nothing written." );
 599    }
 600
 601    fp1.close();
 602
 603    return true;
 604 }
 605
 606 /**
 607  * \brief Writes on disk A SINGLE Dicom file,
 608  *        using the Implicit Value Representation convention
 609  *        NO test is performed on  processor "Endianity".
 610  * @param fileName name of the file to be created
 611  *                 (any already existing file is overwritten)
 612  * @return false if write fails
 613  */
 614
 615 bool FileHelper::WriteDcmImplVR (std::string const &fileName)
 616 {
 617    SetWriteTypeToDcmImplVR();
 618    return Write(fileName);
 619 }
 620
 621 /**
 622 * \brief Writes on disk A SINGLE Dicom file,
 623  *        using the Explicit Value Representation convention
 624  *        NO test is performed on  processor "Endiannity".
 625  * @param fileName name of the file to be created
 626  *                 (any already existing file is overwritten)
 627  * @return false if write fails
 628  */
 629
 630 bool FileHelper::WriteDcmExplVR (std::string const &fileName)
 631 {
 632    SetWriteTypeToDcmExplVR();
 633    return Write(fileName);
 634 }
 635
 636 /**
 637  * \brief Writes on disk A SINGLE Dicom file,
 638  *        using the ACR-NEMA convention
 639  *        NO test is performed on  processor "Endiannity".
 640  *        (a l'attention des logiciels cliniques
 641  *        qui ne prennent en entrée QUE des images ACR ...
 642  * \warning if a DICOM_V3 header is supplied,
 643  *         groups < 0x0008 and shadow groups are ignored
 644  * \warning NO TEST is performed on processor "Endiannity".
 645  * @param fileName name of the file to be created
 646  *                 (any already existing file is overwritten)
 647  * @return false if write fails
 648  */
 649
 650 bool FileHelper::WriteAcr (std::string const &fileName)
 651 {
 652    SetWriteTypeToAcr();
 653    return Write(fileName);
 654 }
 655
 656 /**
 657  * \brief Writes on disk A SINGLE Dicom file,
 658  * @param fileName name of the file to be created
 659  *                 (any already existing file is overwritten)
 660  * @return false if write fails
 661  */
 662 bool FileHelper::Write(std::string const &fileName)
 663 {
 664    bool flag = false;
 665    DocEntry *e;
 666    switch(WriteType)
 667    {
 668       case ImplicitVR:
 669          SetWriteFileTypeToImplicitVR();
 670          break;
 671
 672       case Unknown:  // should never happen; ExplicitVR is the default value
 673       case ExplicitVR:
 674
 675    // User should ask gdcm to write an image in Explicit VR mode
 676    // only when he is sure *all* the VR of *all* the DataElements is known.
 677    // i.e : when there are *only* Public Groups
 678    // or *all* the Shadow Groups are fully described in the relevant Shadow
 679    // Dictionnary
 680    // Let's just *dream* about it; *never* trust a user !
 681    // We turn to Implicit VR if at least the VR of one element is unknown.
 682
 683          e = FileInternal->GetFirstEntry();
 684          while (e != 0)
 685          {
 686             if (e->GetVR() == "  ")
 687             {
 688                SetWriteTypeToDcmImplVR();
 689                SetWriteFileTypeToImplicitVR();
 690                flag = true;
 691                break;
 692             }
 693             e = FileInternal->GetNextEntry();
 694          }
 695
 696          if (!flag)
 697          {
 698             SetWriteFileTypeToExplicitVR();
 699          }
 700          break;
 701
 702       case ACR:
 703       case ACR_LIBIDO:
 704       // NOTHING is done here just for LibIDO.
 705       // Just to avoid further trouble if user creates a file ex-nihilo,
 706       // wants to write it as an ACR-NEMA file,
 707       // and forgets to create any Entry belonging to group 0008
 708       // (shame on him !)
 709       // We add Recognition Code (RET)
 710         if ( ! FileInternal->GetDataEntry(0x0008, 0x0010) )
 711             FileInternal->InsertEntryString("ACR-NEMA V1.0 ", 0x0008, 0x0010);
 712          SetWriteFileTypeToACR();
 713         // SetWriteFileTypeToImplicitVR(); // ACR IS implicit VR !
 714          break;
 715
 716       /// \todo FIXME : JPEG may be either ExplicitVR or ImplicitVR
 717       case JPEG:
 718          SetWriteFileTypeToJPEG();
 719          break;
 720    }
 721
 722    CheckMandatoryElements();
 723
 724    // --------------------------------------------------------------
 725    // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
 726    //
 727    // if recognition code tells us we dealt with a LibIDO image
 728    // we reproduce on disk the switch between lineNumber and columnNumber
 729    // just before writting ...
 730    /// \todo the best trick would be *change* the recognition code
 731    ///       but pb expected if user deals with, e.g. COMPLEX images
 732
 733    if ( WriteType == ACR_LIBIDO )
 734    {
 735       SetWriteToLibido();
 736    }
 737    else
 738    {
 739       SetWriteToNoLibido();
 740    }
 741    // ----------------- End of Special Patch ----------------
 742
 743    switch(WriteMode)
 744    {
 745       case WMODE_RAW :
 746          SetWriteToRaw(); // modifies and pushes to the archive, when necessary
 747          break;
 748       case WMODE_RGB :
 749          SetWriteToRGB(); // modifies and pushes to the archive, when necessary
 750          break;
 751    }
 752
 753    bool check = CheckWriteIntegrity(); // verifies length
 754    if (WriteType == JPEG ) check = true;
 755    if (check)
 756    {
 757       check = FileInternal->Write(fileName,WriteType);
 758    }
 759
 760    RestoreWrite();
 761    RestoreWriteFileType();
 762    RestoreWriteMandatory();
 763
 764    // --------------------------------------------------------------
 765    // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
 766    //
 767    // ...and we restore the header to be Dicom Compliant again
 768    // just after writting
 769    RestoreWriteOfLibido();
 770    // ----------------- End of Special Patch ----------------
 771
 772    return check;
 773 }
 774
 775 //-----------------------------------------------------------------------------
 776 // Protected
 777 /**
 778  * \brief Checks the write integrity
 779  *
 780  * The tests made are :
 781  *  - verify the size of the image to write with the possible write
 782  *    when the user set an image data
 783  * @return true if check is successfull
 784  */
 785 bool FileHelper::CheckWriteIntegrity()
 786 {
 787    if ( PixelWriteConverter->GetUserData() )
 788    {
 789       int numberBitsAllocated = FileInternal->GetBitsAllocated();
 790       if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
 791       {
 792          gdcmWarningMacro( "numberBitsAllocated changed from "
 793                           << numberBitsAllocated << " to 16 "
 794                           << " for consistency purpose" );
 795          numberBitsAllocated = 16;
 796       }
 797
 798       size_t decSize = FileInternal->GetXSize()
 799                      * FileInternal->GetYSize()
 800                      * FileInternal->GetZSize()
 801                      * FileInternal->GetSamplesPerPixel()
 802                      * ( numberBitsAllocated / 8 );
 803       size_t rgbSize = decSize;
 804       if ( FileInternal->HasLUT() )
 805          rgbSize = decSize * 3;
 806
 807       switch(WriteMode)
 808       {
 809          case WMODE_RAW :
 810             if ( decSize!=PixelWriteConverter->GetUserDataSize() )
 811             {
 812                gdcmWarningMacro( "Data size (Raw) is incorrect. Should be "
 813                            << decSize << " / Found :"
 814                            << PixelWriteConverter->GetUserDataSize() );
 815                return false;
 816             }
 817             break;
 818          case WMODE_RGB :
 819             if ( rgbSize!=PixelWriteConverter->GetUserDataSize() )
 820             {
 821                gdcmWarningMacro( "Data size (RGB) is incorrect. Should be "
 822                           << decSize << " / Found "
 823                           << PixelWriteConverter->GetUserDataSize() );
 824                return false;
 825             }
 826             break;
 827       }
 828    }
 829
 830    return true;
 831 }
 832
 833 /**
 834  * \brief Updates the File to write RAW data (as opposed to RGB data)
 835  *       (modifies, when necessary, photochromatic interpretation,
 836  *       bits allocated, Pixels element VR)
 837  */
 838 void FileHelper::SetWriteToRaw()
 839 {
 840    if ( FileInternal->GetNumberOfScalarComponents() == 3
 841     && !FileInternal->HasLUT() )
 842    {
 843       SetWriteToRGB();
 844    }
 845    else
 846    {
 847       DataEntry *photInt = CopyDataEntry(0x0028,0x0004);
 848       if (FileInternal->HasLUT() )
 849       {
 850          photInt->SetString("PALETTE COLOR ");
 851       }
 852       else
 853       {
 854          photInt->SetString("MONOCHROME2 ");
 855       }
 856
 857       PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
 858                                        PixelReadConverter->GetRawSize());
 859
 860       std::string vr = "OB";
 861       if ( FileInternal->GetBitsAllocated()>8 )
 862          vr = "OW";
 863       if ( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
 864          vr = "OB";
 865       DataEntry *pixel =
 866          CopyDataEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
 867       pixel->SetFlag(DataEntry::FLAG_PIXELDATA);
 868       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
 869       pixel->SetLength(PixelWriteConverter->GetDataSize());
 870
 871       Archive->Push(photInt);
 872       Archive->Push(pixel);
 873
 874       photInt->Delete();
 875       pixel->Delete();
 876    }
 877 }
 878
 879 /**
 880  * \brief Updates the File to write RGB data (as opposed to RAW data)
 881  *       (modifies, when necessary, photochromatic interpretation,
 882  *       samples per pixel, Planar configuration,
 883  *       bits allocated, bits stored, high bit -ACR 24 bits-
 884  *       Pixels element VR, pushes out the LUT, )
 885  */
 886 void FileHelper::SetWriteToRGB()
 887 {
 888    if ( FileInternal->GetNumberOfScalarComponents()==3 )
 889    {
 890       PixelReadConverter->BuildRGBImage();
 891
 892       DataEntry *spp = CopyDataEntry(0x0028,0x0002);
 893       spp->SetString("3 ");
 894
 895       DataEntry *planConfig = CopyDataEntry(0x0028,0x0006);
 896       planConfig->SetString("0 ");
 897
 898       DataEntry *photInt = CopyDataEntry(0x0028,0x0004);
 899       photInt->SetString("RGB ");
 900
 901       if ( PixelReadConverter->GetRGB() )
 902       {
 903          PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
 904                                           PixelReadConverter->GetRGBSize());
 905       }
 906       else // Raw data
 907       {
 908          PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
 909                                           PixelReadConverter->GetRawSize());
 910       }
 911
 912       std::string vr = "OB";
 913       if ( FileInternal->GetBitsAllocated()>8 )
 914          vr = "OW";
 915       if ( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
 916          vr = "OB";
 917       DataEntry *pixel =
 918          CopyDataEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
 919       pixel->SetFlag(DataEntry::FLAG_PIXELDATA);
 920       pixel->SetBinArea(PixelWriteConverter->GetData(),false);
 921       pixel->SetLength(PixelWriteConverter->GetDataSize());
 922
 923       Archive->Push(spp);
 924       Archive->Push(planConfig);
 925       Archive->Push(photInt);
 926       Archive->Push(pixel);
 927
 928       spp->Delete();
 929       planConfig->Delete();
 930       photInt->Delete();
 931       pixel->Delete();
 932
 933       // Remove any LUT
 934       Archive->Push(0x0028,0x1101);
 935       Archive->Push(0x0028,0x1102);
 936       Archive->Push(0x0028,0x1103);
 937       Archive->Push(0x0028,0x1201);
 938       Archive->Push(0x0028,0x1202);
 939       Archive->Push(0x0028,0x1203);
 940
 941       // push out Palette Color Lookup Table UID, if any
 942       Archive->Push(0x0028,0x1199);
 943
 944       // For old '24 Bits' ACR-NEMA
 945       // Thus, we have a RGB image and the bits allocated = 24 and
 946       // samples per pixels = 1 (in the read file)
 947       if ( FileInternal->GetBitsAllocated()==24 )
 948       {
 949          DataEntry *bitsAlloc = CopyDataEntry(0x0028,0x0100);
 950          bitsAlloc->SetString("8 ");
 951
 952          DataEntry *bitsStored = CopyDataEntry(0x0028,0x0101);
 953          bitsStored->SetString("8 ");
 954
 955          DataEntry *highBit = CopyDataEntry(0x0028,0x0102);
 956          highBit->SetString("7 ");
 957
 958          Archive->Push(bitsAlloc);
 959          Archive->Push(bitsStored);
 960          Archive->Push(highBit);
 961
 962          bitsAlloc->Delete();
 963          bitsStored->Delete();
 964          highBit->Delete();
 965       }
 966    }
 967    else
 968    {
 969       SetWriteToRaw();
 970    }
 971 }
 972
 973 /**
 974  * \brief Restore the File write mode
 975  */
 976 void FileHelper::RestoreWrite()
 977 {
 978    Archive->Restore(0x0028,0x0002);
 979    Archive->Restore(0x0028,0x0004);
 980    Archive->Restore(0x0028,0x0006);
 981    Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
 982
 983    // For old ACR-NEMA (24 bits problem)
 984    Archive->Restore(0x0028,0x0100);
 985    Archive->Restore(0x0028,0x0101);
 986    Archive->Restore(0x0028,0x0102);
 987
 988    // For the LUT
 989    Archive->Restore(0x0028,0x1101);
 990    Archive->Restore(0x0028,0x1102);
 991    Archive->Restore(0x0028,0x1103);
 992    Archive->Restore(0x0028,0x1201);
 993    Archive->Restore(0x0028,0x1202);
 994    Archive->Restore(0x0028,0x1203);
 995
 996    // For the Palette Color Lookup Table UID
 997    Archive->Restore(0x0028,0x1203);
 998
 999
1000    // group 0002 may be pushed out for ACR-NEMA writting purposes
1001    Archive->Restore(0x0002,0x0000);
1002    Archive->Restore(0x0002,0x0001);
1003    Archive->Restore(0x0002,0x0002);
1004    Archive->Restore(0x0002,0x0003);
1005    Archive->Restore(0x0002,0x0010);
1006    Archive->Restore(0x0002,0x0012);
1007    Archive->Restore(0x0002,0x0013);
1008    Archive->Restore(0x0002,0x0016);
1009    Archive->Restore(0x0002,0x0100);
1010    Archive->Restore(0x0002,0x0102);
1011 }
1012
1013 /**
1014  * \brief Pushes out the whole group 0002
1015  *        FIXME : better, set a flag to tell the writer not to write it ...
1016  *        FIXME : method should probably have an other name !
1017  *                SetWriteFileTypeToACR is NOT opposed to
1018  *                SetWriteFileTypeToExplicitVR and SetWriteFileTypeToImplicitVR
1019  */
1020 void FileHelper::SetWriteFileTypeToACR()
1021 {
1022    Archive->Push(0x0002,0x0000);
1023    Archive->Push(0x0002,0x0001);
1024    Archive->Push(0x0002,0x0002);
1025    Archive->Push(0x0002,0x0003);
1026    Archive->Push(0x0002,0x0010);
1027    Archive->Push(0x0002,0x0012);
1028    Archive->Push(0x0002,0x0013);
1029    Archive->Push(0x0002,0x0016);
1030    Archive->Push(0x0002,0x0100);
1031    Archive->Push(0x0002,0x0102);
1032 }
1033
1034 /**
1035  * \brief Sets in the File the TransferSyntax to 'JPEG'
1036  */
1037 void FileHelper::SetWriteFileTypeToJPEG()
1038 {
1039    std::string ts = Util::DicomString(
1040       Global::GetTS()->GetSpecialTransferSyntax(TS::JPEGBaselineProcess1) );
1041
1042    DataEntry *tss = CopyDataEntry(0x0002,0x0010);
1043    tss->SetString(ts);
1044
1045    Archive->Push(tss);
1046    tss->Delete();
1047 }
1048
1049 /**
1050  * \brief Sets in the File the TransferSyntax to 'Explicit VR Little Endian"
1051  */
1052 void FileHelper::SetWriteFileTypeToExplicitVR()
1053 {
1054    std::string ts = Util::DicomString(
1055       Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
1056
1057    DataEntry *tss = CopyDataEntry(0x0002,0x0010);
1058    tss->SetString(ts);
1059    Archive->Push(tss);
1060    tss->Delete();
1061 }
1062
1063 /**
1064  * \brief Sets in the File the TransferSyntax to 'Implicit VR Little Endian"
1065  */
1066 void FileHelper::SetWriteFileTypeToImplicitVR()
1067 {
1068    std::string ts = Util::DicomString(
1069       Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
1070
1071    DataEntry *tss = CopyDataEntry(0x0002,0x0010);
1072    tss->SetString(ts);
1073    Archive->Push(tss);
1074    tss->Delete();
1075 }
1076
1077
1078 /**
1079  * \brief Restore in the File the initial group 0002
1080  */
1081 void FileHelper::RestoreWriteFileType()
1082 {
1083 }
1084
1085 /**
1086  * \brief Set the Write not to Libido format
1087  */
1088 void FileHelper::SetWriteToLibido()
1089 {
1090    DataEntry *oldRow = FileInternal->GetDataEntry(0x0028, 0x0010);
1091    DataEntry *oldCol = FileInternal->GetDataEntry(0x0028, 0x0011);
1092
1093    if ( oldRow && oldCol )
1094    {
1095       std::string rows, columns;
1096
1097       DataEntry *newRow=DataEntry::New(oldRow->GetDictEntry());
1098       DataEntry *newCol=DataEntry::New(oldCol->GetDictEntry());
1099
1100       newRow->Copy(oldCol);
1101       newCol->Copy(oldRow);
1102
1103       newRow->SetString(oldCol->GetString());
1104       newCol->SetString(oldRow->GetString());
1105
1106       Archive->Push(newRow);
1107       Archive->Push(newCol);
1108
1109       newRow->Delete();
1110       newCol->Delete();
1111    }
1112
1113    DataEntry *libidoCode = CopyDataEntry(0x0008,0x0010);
1114    libidoCode->SetString("ACRNEMA_LIBIDO_1.1");
1115    Archive->Push(libidoCode);
1116    libidoCode->Delete();
1117 }
1118
1119 /**
1120  * \brief Set the Write not to No Libido format
1121  */
1122 void FileHelper::SetWriteToNoLibido()
1123 {
1124    DataEntry *recCode = FileInternal->GetDataEntry(0x0008,0x0010);
1125    if ( recCode )
1126    {
1127       if ( recCode->GetString() == "ACRNEMA_LIBIDO_1.1" )
1128       {
1129          DataEntry *libidoCode = CopyDataEntry(0x0008,0x0010);
1130          libidoCode->SetString("");
1131          Archive->Push(libidoCode);
1132          libidoCode->Delete();
1133       }
1134    }
1135 }
1136
1137 /**
1138  * \brief Restore the Write format
1139  */
1140 void FileHelper::RestoreWriteOfLibido()
1141 {
1142    Archive->Restore(0x0028,0x0010);
1143    Archive->Restore(0x0028,0x0011);
1144    Archive->Restore(0x0008,0x0010);
1145
1146    // Restore 'LibIDO-special' entries, if any
1147    Archive->Restore(0x0028,0x0015);
1148    Archive->Restore(0x0028,0x0016);
1149    Archive->Restore(0x0028,0x0017);
1150    Archive->Restore(0x0028,0x00199);
1151 }
1152
1153 /**
1154  * \brief   Duplicates a DataEntry or creates it.
1155  * @param   group   Group number of the Entry
1156  * @param   elem  Element number of the Entry
1157  * @param   vr  Value Representation of the Entry
1158  *          FIXME : what is it used for?
1159  * \return  pointer to the new Bin Entry (NULL when creation failed).
1160  */
1161 DataEntry *FileHelper::CopyDataEntry(uint16_t group, uint16_t elem,
1162                                    const TagName &vr)
1163 {
1164    DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
1165    DataEntry *newE;
1166
1167    if ( oldE && vr != GDCM_VRUNKNOWN )
1168       if ( oldE->GetVR() != vr )
1169          oldE = NULL;
1170
1171    if ( oldE )
1172    {
1173       newE = DataEntry::New(oldE->GetDictEntry());
1174       newE->Copy(oldE);
1175    }
1176    else
1177    {
1178       newE = GetFile()->NewDataEntry(group, elem, vr);
1179    }
1180
1181    return newE;
1182 }
1183
1184 /**
1185  * \brief   This method is called automatically, just before writting
1186  *         in order to produce a 'True Dicom V3' image.
1187  *
1188  *         We cannot know *how* the user made the File :
1189  *         (reading an old ACR-NEMA file or a not very clean DICOM file ...)
1190  *          Just before writting :
1191  *             - we check the Entries
1192  *             - we create the mandatory entries if they are missing
1193  *             - we modify the values if necessary
1194  *             - we push the sensitive entries to the Archive
1195  *          The writing process will restore the entries as they where before
1196  *          entering FileHelper::CheckMandatoryElements, so the user will always
1197  *          see the entries just as they were before he decided to write.
1198  *
1199  * \note
1200  *       -  Entries whose type is 1 are mandatory, with a mandatory value
1201  *       -  Entries whose type is 1c are mandatory-inside-a-Sequence,
1202  *                             with a mandatory value
1203  *       -  Entries whose type is 2 are mandatory, with an optional value
1204  *       -  Entries whose type is 2c are mandatory-inside-a-Sequence,
1205  *                             with an optional value
1206  *       -  Entries whose type is 3 are optional
1207  *
1208  * \todo
1209  *         - warn the user if we had to add some entries :
1210  *         even if a mandatory entry is missing, we add it, with a default value
1211  *         (we don't want to give up the writting process if user forgot to
1212  *         specify Lena's Patient ID, for instance ...)
1213  *         - read the whole PS 3.3 Part of DICOM  (890 pages)
1214  *         and write a *full* checker (probably one method per Modality ...)
1215  *         Any contribution is welcome.
1216  *         - write a user callable full checker, to allow post reading
1217  *         and/or pre writting image consistency check.
1218  */
1219
1220 /* -------------------------------------------------------------------------------------
1221 To be moved to User's guide / WIKI  ?
1222
1223 We have to deal with 4 *very* different cases :
1224 -1) user created ex nihilo his own image and wants to write it as a Dicom image.
1225     USER_OWN_IMAGE
1226 -2) user modified the pixels of an existing image.
1227    FILTERED_IMAGE
1228 -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
1229    CREATED_IMAGE
1230 -4) user modified/added some tags *without processing* the pixels (anonymization..
1231    UNMODIFIED_PIXELS_IMAGE
1232
1233 gdcm::FileHelper::CheckMandatoryElements() deals automatically with these cases.
1234
1235 1)2)3)4)
1236 0008 0012 Instance Creation Date
1237 0008 0013 Instance Creation Time
1238 0008 0018 SOP Instance UID
1239 are *always* created with the current values; user has *no* possible intervention on
1240 them.
1241
1242 'Serie Instance UID'(0x0020,0x000e)
1243 'Study Instance UID'(0x0020,0x000d) are kept as is if already exist,
1244                                     created  if it doesn't.
1245  The user is allowed to create his own Series/Studies,
1246      keeping the same 'Serie Instance UID' / 'Study Instance UID' for various images
1247  Warning :
1248  The user shouldn't add any image to a 'Manufacturer Serie'
1249      but there is no way no to allow him to do that
1250
1251  None of the 'shadow elements' are droped out.
1252
1253
1254 1)
1255 'Conversion Type (0x0008,0x0064) is forced to 'SYN' (Synthetic Image).
1256
1257 1)3)
1258 'Media Storage SOP Class UID' (0x0002,0x0002)
1259 'SOP Class UID'               (0x0008,0x0016) are set to
1260                                                [Secondary Capture Image Storage]
1261 'Image Type'                  (0x0008,0x0008) is forced to  "DERIVED\PRIMARY"
1262 Conversion Type               (0x0008,0x0064) is forced to 'SYN' (Synthetic Image)
1263
1264 2)4)
1265 If 'SOP Class UID' exists in the native image  ('true DICOM' image)
1266     we create the 'Source Image Sequence' SeqEntry (0x0008, 0x2112)
1267     --> 'Referenced SOP Class UID' (0x0008, 0x1150)
1268          whose value is the original 'SOP Class UID'
1269     --> 'Referenced SOP Instance UID' (0x0008, 0x1155)
1270          whose value is the original 'SOP Class UID'
1271
1272 3) TODO : find a trick to allow user to pass to the writter the list of the Dicom images
1273           or the Series, (or the Study ?) he used to created his image
1274           (MIP, MPR, cartography image, ...)
1275            These info should be stored (?)
1276           0008 1110 SQ 1 Referenced Study Sequence
1277           0008 1115 SQ 1 Referenced Series Sequence
1278           0008 1140 SQ 1 Referenced Image Sequence
1279
1280 4) When user *knows* he didn't modified the pixels, we keep some informations unchanged :
1281 'Media Storage SOP Class UID' (0x0002,0x0002)
1282 'SOP Class UID'               (0x0008,0x0016)
1283 'Image Type'                  (0x0008,0x0008)
1284 'Conversion Type'             (0x0008,0x0064)
1285
1286
1287 Bellow follows the full description (hope so !) of the consistency checks performed
1288 by gdcm::FileHelper::CheckMandatoryElements()
1289
1290
1291 -->'Media Storage SOP Class UID' (0x0002,0x0002)
1292 -->'SOP Class UID'               (0x0008,0x0016) are defaulted to
1293                                                [Secondary Capture Image Storage]
1294 --> 'Image Type'  (0x0008,0x0008)
1295      is forced to  "DERIVED\PRIMARY"
1296      (The written image is no longer an 'ORIGINAL' one)
1297   Except if user knows he didn't modify the image (e.g. : he just anonymized the file)
1298
1299  -->  Conversion Type (0x0008,0x0064)
1300      is defaulted to 'SYN' (Synthetic Image)
1301   when *he* knows he created his own image ex nihilo
1302
1303 --> 'Modality' (0x0008,0x0060)
1304     is defaulted to "OT" (other) if missing.
1305     (a fully user created image belongs to *no* modality)
1306
1307 --> 'Media Storage SOP Instance UID' (0x0002,0x0003)
1308 --> 'Implementation Class UID'       (0x0002,0x0012)
1309     are automatically generated; no user intervention possible
1310
1311 --> 'Serie Instance UID'(0x0020,0x000e)
1312 --> 'Study Instance UID'(0x0020,0x000d) are kept as is if already exist
1313                                              created  if it doesn't.
1314      The user is allowed to create his own Series/Studies,
1315      keeping the same 'Serie Instance UID' / 'Study Instance UID'
1316      for various images
1317      Warning :
1318      The user shouldn't add any image to a 'Manufacturer Serie'
1319      but there is no way no to allowed him to do that
1320
1321 --> If 'SOP Class UID' exists in the native image  ('true DICOM' image)
1322     we create the 'Source Image Sequence' SeqEntry (0x0008, 0x2112)
1323
1324     --> 'Referenced SOP Class UID' (0x0008, 0x1150)
1325          whose value is the original 'SOP Class UID'
1326     --> 'Referenced SOP Instance UID' (0x0008, 0x1155)
1327          whose value is the original 'SOP Class UID'
1328
1329 --> Bits Stored, Bits Allocated, Hight Bit Position are checked for consistency
1330 --> Pixel Spacing     (0x0028,0x0030) is defaulted to "1.0\1.0"
1331 --> Samples Per Pixel (0x0028,0x0002) is defaulted to 1 (grayscale)
1332
1333 --> Imager Pixel Spacing (0x0018,0x1164) : defaulted to Pixel Spacing value
1334
1335 --> Instance Creation Date, Instance Creation Time are forced to current Date and Time
1336
1337 --> Study Date, Study Time are defaulted to current Date and Time
1338    (they remain unchanged if they exist)
1339
1340 --> Patient Orientation : (0x0020,0x0020), if not present, is deduced from
1341     Image Orientation (Patient) : (0020|0037) or from
1342     Image Orientation (RET)     : (0020 0035)
1343
1344 --> Study ID, Series Number, Instance Number, Patient Orientation (Type 2)
1345     are created, with empty value if there are missing.
1346
1347 --> Manufacturer, Institution Name, Patient's Name, (Type 2)
1348     are defaulted with a 'gdcm' value.
1349
1350 --> Patient ID, Patient's Birth Date, Patient's Sex, (Type 2)
1351 --> Referring Physician's Name  (Type 2)
1352     are created, with empty value if there are missing.
1353
1354  -------------------------------------------------------------------------------------*/
1355
1356 void FileHelper::CheckMandatoryElements()
1357 {
1358    std::string sop =  Util::CreateUniqueUID();
1359
1360    // --------------------- For Meta Elements ---------------------
1361    // just to remember : 'official' 0002 group
1362    if ( WriteType != ACR && WriteType != ACR_LIBIDO )
1363    {
1364      // Group 000002 (Meta Elements) already pushed out
1365
1366    //0002 0000 UL 1 Meta Group Length
1367    //0002 0001 OB 1 File Meta Information Version
1368    //0002 0002 UI 1 Media Stored SOP Class UID
1369    //0002 0003 UI 1 Media Stored SOP Instance UID
1370    //0002 0010 UI 1 Transfer Syntax UID
1371    //0002 0012 UI 1 Implementation Class UID
1372    //0002 0013 SH 1 Implementation Version Name
1373    //0002 0016 AE 1 Source Application Entity Title
1374    //0002 0100 UI 1 Private Information Creator
1375    //0002 0102 OB 1 Private Information
1376
1377    // Create them if not found
1378    // Always modify the value
1379    // Push the entries to the archive.
1380       CopyMandatoryEntry(0x0002,0x0000,"0");
1381
1382       DataEntry *e_0002_0001 = CopyDataEntry(0x0002,0x0001, "OB");
1383       e_0002_0001->SetBinArea((uint8_t*)Util::GetFileMetaInformationVersion(),
1384                                false);
1385       e_0002_0001->SetLength(2);
1386       Archive->Push(e_0002_0001);
1387       e_0002_0001->Delete();
1388
1389       if ( ContentType == FILTERED_IMAGE || ContentType == UNMODIFIED_PIXELS_IMAGE)
1390       {
1391    // we keep the original 'Media Storage SOP Class UID', we default it if missing
1392          CheckMandatoryEntry(0x0002,0x0002,"1.2.840.10008.5.1.4.1.1.7");
1393       }
1394       else
1395       {
1396    // It's *not* an image comming straight from a source. We force
1397    // 'Media Storage SOP Class UID'  --> [Secondary Capture Image Storage]
1398          CopyMandatoryEntry(0x0002,0x0002,"1.2.840.10008.5.1.4.1.1.7");
1399       }
1400
1401    // 'Media Storage SOP Instance UID'
1402       CopyMandatoryEntry(0x0002,0x0003,sop);
1403
1404    // 'Implementation Class UID'
1405    // FIXME : in all examples we have, 0x0002,0x0012 is not so long :
1406    //         seems to be Root UID + 4 digits (?)
1407       CopyMandatoryEntry(0x0002,0x0012,Util::CreateUniqueUID());
1408
1409    // 'Implementation Version Name'
1410       std::string version = "GDCM ";
1411       version += Util::GetVersion();
1412       CopyMandatoryEntry(0x0002,0x0013,version);
1413    }
1414
1415    // --------------------- For DataSet ---------------------
1416
1417    if ( ContentType == FILTERED_IMAGE || ContentType == UNMODIFIED_PIXELS_IMAGE)
1418    {
1419    // we keep the original 'Media Storage SOP Class UID', we default it if missing (it should be present !)
1420          CheckMandatoryEntry(0x0008,0x0016,"1.2.840.10008.5.1.4.1.1.7");
1421    }
1422    else
1423    {
1424    // It's *not* an image comming straight from a source. We force
1425    // 'Media Storage SOP Class UID'  --> [Secondary Capture Image Storage]
1426          CopyMandatoryEntry(0x0008,0x0016,"1.2.840.10008.5.1.4.1.1.7");
1427    }
1428
1429    // Push out 'LibIDO-special' entries, if any
1430    Archive->Push(0x0028,0x0015);
1431    Archive->Push(0x0028,0x0016);
1432    Archive->Push(0x0028,0x0017);
1433    Archive->Push(0x0028,0x00199);
1434
1435    // Deal with the pb of (Bits Stored = 12)
1436    // - we're gonna write the image as Bits Stored = 16
1437    if ( FileInternal->GetEntryString(0x0028,0x0100) ==  "12")
1438    {
1439       CopyMandatoryEntry(0x0028,0x0100,"16");
1440    }
1441
1442    // Check if user wasn't drunk ;-)
1443
1444    std::ostringstream s;
1445    // check 'Bits Allocated' vs decent values
1446    int nbBitsAllocated = FileInternal->GetBitsAllocated();
1447    if ( nbBitsAllocated == 0 || nbBitsAllocated > 32)
1448    {
1449       CopyMandatoryEntry(0x0028,0x0100,"16");
1450       gdcmWarningMacro("(0028,0100) changed from "
1451          << nbBitsAllocated << " to 16 for consistency purpose");
1452       nbBitsAllocated = 16;
1453    }
1454    // check 'Bits Stored' vs 'Bits Allocated'
1455    int nbBitsStored = FileInternal->GetBitsStored();
1456    if ( nbBitsStored == 0 || nbBitsStored > nbBitsAllocated )
1457    {
1458       s.str("");
1459       s << nbBitsAllocated;
1460       CopyMandatoryEntry(0x0028,0x0101,s.str());
1461       gdcmWarningMacro("(0028,0101) changed from "
1462                        << nbBitsStored << " to " << nbBitsAllocated
1463                        << " for consistency purpose" );
1464       nbBitsStored = nbBitsAllocated;
1465     }
1466    // check 'Hight Bit Position' vs 'Bits Allocated' and 'Bits Stored'
1467    int highBitPosition = FileInternal->GetHighBitPosition();
1468    if ( highBitPosition == 0 ||
1469         highBitPosition > nbBitsAllocated-1 ||
1470         highBitPosition < nbBitsStored-1  )
1471    {
1472       s.str("");
1473       s << nbBitsStored - 1;
1474       CopyMandatoryEntry(0x0028,0x0102,s.str());
1475       gdcmWarningMacro("(0028,0102) changed from "
1476                        << highBitPosition << " to " << nbBitsAllocated-1
1477                        << " for consistency purpose");
1478    }
1479
1480    std::string pixelSpacing = FileInternal->GetEntryString(0x0028,0x0030);
1481    if ( pixelSpacing == GDCM_UNFOUND )
1482    {
1483       pixelSpacing = "1.0\\1.0";
1484        // if missing, Pixel Spacing forced to "1.0\1.0"
1485       CopyMandatoryEntry(0x0028,0x0030,pixelSpacing);
1486    }
1487
1488    // 'Imager Pixel Spacing' : defaulted to 'Pixel Spacing'
1489    // --> This one is the *legal* one !
1490    if ( ContentType != USER_OWN_IMAGE)
1491    //  we write it only when we are *sure* the image comes from
1492    //         an imager (see also 0008,0x0064)
1493       CheckMandatoryEntry(0x0018,0x1164,pixelSpacing);
1494
1495    // Samples Per Pixel (type 1) : default to grayscale
1496    CheckMandatoryEntry(0x0028,0x0002,"1");
1497
1498    // --- Check UID-related Entries ---
1499
1500
1501    if ( ContentType != USER_OWN_IMAGE) // when it's not a user made image
1502    {
1503     // If 'SOP Class UID' exists ('true DICOM' image)
1504    // we create the 'Source Image Sequence' SeqEntry
1505    // to hold informations about the Source Image
1506
1507       DataEntry *e_0008_0016 = FileInternal->GetDataEntry(0x0008, 0x0016);
1508       if ( e_0008_0016 )
1509       {
1510       // Create 'Source Image Sequence' SeqEntry
1511       SeqEntry *sis = SeqEntry::New (
1512             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x2112) );
1513       SQItem *sqi = SQItem::New(1);
1514       // (we assume 'SOP Instance UID' exists too)
1515       // create 'Referenced SOP Class UID'
1516       DataEntry *e_0008_1150 = DataEntry::New(
1517             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1150) );
1518       e_0008_1150->SetString( e_0008_0016->GetString());
1519       sqi->AddEntry(e_0008_1150);
1520       e_0008_1150->Delete();
1521
1522       // create 'Referenced SOP Instance UID'
1523       DataEntry *e_0008_0018 = FileInternal->GetDataEntry(0x0008, 0x0018);
1524       DataEntry *e_0008_1155 = DataEntry::New(
1525             Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1155) );
1526       e_0008_1155->SetString( e_0008_0018->GetString());
1527       sqi->AddEntry(e_0008_1155);
1528       e_0008_1155->Delete();
1529
1530       sis->AddSQItem(sqi,1);
1531       sqi->Delete();
1532
1533       // temporarily replaces any previous 'Source Image Sequence'
1534       Archive->Push(sis);
1535       sis->Delete();
1536
1537       // FIXME : is 'Image Type' *really* depending on the presence of 'SOP Class UID'?
1538        if ( ContentType == FILTERED_IMAGE)
1539       // the user *knows* he just modified the pixels
1540       // the image is no longer an 'Original' one
1541          CopyMandatoryEntry(0x0008,0x0008,"DERIVED\\PRIMARY");
1542       }
1543    }
1544
1545    // At the end, not to overwrite the original ones,
1546    // needed by 'Referenced SOP Instance UID', 'Referenced SOP Class UID'
1547    // 'SOP Instance UID'
1548    CopyMandatoryEntry(0x0008,0x0018,sop);
1549
1550    if ( ContentType == USER_OWN_IMAGE)
1551    {
1552        // Conversion Type.
1553        // Other possible values are :
1554        // See PS 3.3, Page 408
1555
1556        // DV = Digitized Video
1557        // DI = Digital Interface
1558        // DF = Digitized Film
1559        // WSD = Workstation
1560        // SD = Scanned Document
1561        // SI = Scanned Image
1562        // DRW = Drawing
1563        // SYN = Synthetic Image
1564
1565       CheckMandatoryEntry(0x0008,0x0064,"SYN"); // Why not?
1566    }
1567 /*
1568    if ( ContentType == CREATED_IMAGE)
1569    {
1570    /// \todo : find a trick to pass the Media Storage SOP Instance UID of the images used to create the current image
1571
1572    }
1573 */
1574
1575    // ---- The user will never have to take any action on the following ----
1576
1577    // new value for 'SOP Instance UID'
1578    //SetMandatoryEntry(0x0008,0x0018,Util::CreateUniqueUID());
1579
1580    // Instance Creation Date
1581    const std::string &date = Util::GetCurrentDate();
1582    CopyMandatoryEntry(0x0008,0x0012,date);
1583
1584    // Instance Creation Time
1585    const std::string &time = Util::GetCurrentTime();
1586    CopyMandatoryEntry(0x0008,0x0013,time);
1587
1588    // Study Date
1589    CheckMandatoryEntry(0x0008,0x0020,date);
1590    // Study Time
1591    CheckMandatoryEntry(0x0008,0x0030,time);
1592
1593    // Accession Number
1594    //CopyMandatoryEntry(0x0008,0x0050,"");
1595    CheckMandatoryEntry(0x0008,0x0050,"");
1596
1597
1598    // ----- Add Mandatory Entries if missing ---
1599    // Entries whose type is 1 are mandatory, with a mandatory value
1600    // Entries whose type is 1c are mandatory-inside-a-Sequence,
1601    //                          with a mandatory value
1602    // Entries whose type is 2 are mandatory, with an optional value
1603    // Entries whose type is 2c are mandatory-inside-a-Sequence,
1604    //                          with an optional value
1605    // Entries whose type is 3 are optional
1606
1607    // 'Study Instance UID'
1608    // Keep the value if exists
1609    // The user is allowed to create his own Study,
1610    //          keeping the same 'Study Instance UID' for various images
1611    // The user may add images to a 'Manufacturer Study',
1612    //          adding new Series to an already existing Study
1613    CheckMandatoryEntry(0x0020,0x000d,Util::CreateUniqueUID());
1614
1615    // 'Serie Instance UID'
1616    // Keep the value if exists
1617    // The user is allowed to create his own Series,
1618    // keeping the same 'Serie Instance UID' for various images
1619    // The user shouldn't add any image to a 'Manufacturer Serie'
1620    // but there is no way no to prevent him for doing that
1621    CheckMandatoryEntry(0x0020,0x000e,Util::CreateUniqueUID());
1622
1623    // Study ID
1624    CheckMandatoryEntry(0x0020,0x0010,"");
1625
1626    // Series Number
1627    CheckMandatoryEntry(0x0020,0x0011,"");
1628
1629    // Instance Number
1630    CheckMandatoryEntry(0x0020,0x0013,"");
1631
1632    // Patient Orientation
1633    // Can be computed from (0020|0037) :  Image Orientation (Patient)
1634    gdcm::Orientation *o = gdcm::Orientation::New();
1635    std::string ori = o->GetOrientation ( FileInternal );
1636    o->Delete();
1637    if (ori != "\\" && ori != GDCM_UNFOUND)
1638       CheckMandatoryEntry(0x0020,0x0020,ori);
1639    else
1640       CheckMandatoryEntry(0x0020,0x0020,"");
1641
1642    // Default Patient Position to HFS
1643    CheckMandatoryEntry(0x0018,0x5100,"HFS");
1644
1645    // Modality : if missing we set it to 'OTher'
1646    CheckMandatoryEntry(0x0008,0x0060,"OT");
1647
1648    // Manufacturer : if missing we set it to 'GDCM Factory'
1649    CheckMandatoryEntry(0x0008,0x0070,"GDCM Factory");
1650
1651    // Institution Name : if missing we set it to 'GDCM Hospital'
1652    CheckMandatoryEntry(0x0008,0x0080,"GDCM Hospital");
1653
1654    // Patient's Name : if missing, we set it to 'GDCM^Patient'
1655    CheckMandatoryEntry(0x0010,0x0010,"GDCM^Patient");
1656
1657    // Patient ID
1658    CheckMandatoryEntry(0x0010,0x0020,"");
1659
1660    // Patient's Birth Date : 'type 2' entry -> must exist, value not mandatory
1661    CheckMandatoryEntry(0x0010,0x0030,"");
1662
1663    // Patient's Sex :'type 2' entry -> must exist, value not mandatory
1664    CheckMandatoryEntry(0x0010,0x0040,"");
1665
1666    // Referring Physician's Name :'type 2' entry -> must exist, value not mandatory
1667    CheckMandatoryEntry(0x0008,0x0090,"");
1668
1669  /*
1670    // Deal with element 0x0000 (group length) of each group.
1671    // First stage : get all the different Groups
1672
1673   GroupHT grHT;
1674   DocEntry *d = FileInternal->GetFirstEntry();
1675   while(d)
1676   {
1677     grHT[d->GetGroup()] = 0;
1678     d=FileInternal->GetNextEntry();
1679   }
1680   // Second stage : add the missing ones (if any)
1681   for (GroupHT::iterator it = grHT.begin(); it != grHT.end(); ++it)
1682   {
1683       CheckMandatoryEntry(it->first, 0x0000, "0");
1684   }
1685   // Third stage : update all 'zero level' groups length
1686 */
1687
1688 }
1689
1690 void FileHelper::CheckMandatoryEntry(uint16_t group,uint16_t elem,std::string value)
1691 {
1692    DataEntry *entry = FileInternal->GetDataEntry(group,elem);
1693    if ( !entry )
1694    {
1695       entry = DataEntry::New(Global::GetDicts()->GetDefaultPubDict()->GetEntry(group,elem));
1696       entry->SetString(value);
1697       Archive->Push(entry);
1698       entry->Delete();
1699    }
1700 }
1701
1702 void FileHelper::SetMandatoryEntry(uint16_t group,uint16_t elem,std::string value)
1703 {
1704    DataEntry *entry = DataEntry::New(Global::GetDicts()->GetDefaultPubDict()->GetEntry(group,elem));
1705    entry->SetString(value);
1706    Archive->Push(entry);
1707    entry->Delete();
1708 }
1709
1710 void FileHelper::CopyMandatoryEntry(uint16_t group,uint16_t elem,std::string value)
1711 {
1712    DataEntry *entry = CopyDataEntry(group,elem);
1713    entry->SetString(value);
1714    Archive->Push(entry);
1715    entry->Delete();
1716 }
1717
1718 /**
1719  * \brief Restore in the File the initial group 0002
1720  */
1721 void FileHelper::RestoreWriteMandatory()
1722 {
1723    // group 0002 may be pushed out for ACR-NEMA writting purposes
1724    Archive->Restore(0x0002,0x0000);
1725    Archive->Restore(0x0002,0x0001);
1726    Archive->Restore(0x0002,0x0002);
1727    Archive->Restore(0x0002,0x0003);
1728    Archive->Restore(0x0002,0x0010);
1729    Archive->Restore(0x0002,0x0012);
1730    Archive->Restore(0x0002,0x0013);
1731    Archive->Restore(0x0002,0x0016);
1732    Archive->Restore(0x0002,0x0100);
1733    Archive->Restore(0x0002,0x0102);
1734
1735    // FIXME : Check if none is missing !
1736
1737    Archive->Restore(0x0008,0x0012);
1738    Archive->Restore(0x0008,0x0013);
1739    Archive->Restore(0x0008,0x0016);
1740    Archive->Restore(0x0008,0x0018);
1741    Archive->Restore(0x0008,0x0060);
1742    Archive->Restore(0x0008,0x0070);
1743    Archive->Restore(0x0008,0x0080);
1744    Archive->Restore(0x0008,0x0090);
1745    Archive->Restore(0x0008,0x2112);
1746
1747    Archive->Restore(0x0010,0x0010);
1748    Archive->Restore(0x0010,0x0030);
1749    Archive->Restore(0x0010,0x0040);
1750
1751    Archive->Restore(0x0020,0x000d);
1752    Archive->Restore(0x0020,0x000e);
1753 }
1754
1755
1756 /**
1757  * \brief   CallStartMethod
1758  */
1759 void FileHelper::CallStartMethod()
1760 {
1761    Progress = 0.0f;
1762    Abort    = false;
1763    CommandManager::ExecuteCommand(this,CMD_STARTPROGRESS);
1764 }
1765
1766 /**
1767  * \brief   CallProgressMethod
1768  */
1769 void FileHelper::CallProgressMethod()
1770 {
1771    CommandManager::ExecuteCommand(this,CMD_PROGRESS);
1772 }
1773
1774 /**
1775  * \brief   CallEndMethod
1776  */
1777 void FileHelper::CallEndMethod()
1778 {
1779    Progress = 1.0f;
1780    CommandManager::ExecuteCommand(this,CMD_ENDPROGRESS);
1781 }
1782
1783 //-----------------------------------------------------------------------------
1784 // Private
1785 /**
1786  * \brief Factorization for various forms of constructors.
1787  */
1788 void FileHelper::Initialize()
1789 {
1790    UserFunction = 0;
1791    ContentType = USER_OWN_IMAGE;
1792
1793    WriteMode = WMODE_RAW;
1794    WriteType = ExplicitVR;
1795
1796    PixelReadConverter  = new PixelReadConvert;
1797    PixelWriteConverter = new PixelWriteConvert;
1798    Archive = new DocEntryArchive( FileInternal );
1799 }
1800
1801 /**
1802  * \brief Reads/[decompresses] the pixels,
1803  *        *without* making RGB from Palette Colors
1804  * @return the pixels area, whatever its type
1805  *         (uint8_t is just for prototyping : feel free to Cast it)
1806  */
1807 uint8_t *FileHelper::GetRaw()
1808 {
1809    PixelReadConverter->SetUserFunction( UserFunction );
1810
1811    uint8_t *raw = PixelReadConverter->GetRaw();
1812    if ( ! raw )
1813    {
1814       // The Raw image migth not be loaded yet:
1815       std::ifstream *fp = FileInternal->OpenFile();
1816       PixelReadConverter->ReadAndDecompressPixelData( fp );
1817       if ( fp )
1818          FileInternal->CloseFile();
1819
1820       raw = PixelReadConverter->GetRaw();
1821       if ( ! raw )
1822       {
1823          gdcmWarningMacro( "Read/decompress of pixel data apparently went wrong.");
1824          return 0;
1825       }
1826    }
1827    return raw;
1828 }
1829
1830 //-----------------------------------------------------------------------------
1831 /**
1832  * \brief   Prints the common part of DataEntry, SeqEntry
1833  * @param   os ostream we want to print in
1834  * @param indent (unused)
1835  */
1836 void FileHelper::Print(std::ostream &os, std::string const &)
1837 {
1838    FileInternal->SetPrintLevel(PrintLevel);
1839    FileInternal->Print(os);
1840
1841    if ( FileInternal->IsReadable() )
1842    {
1843       PixelReadConverter->SetPrintLevel(PrintLevel);
1844       PixelReadConverter->Print(os);
1845    }
1846 }
1847
1848 //-----------------------------------------------------------------------------
1849 } // end namespace gdcm