Testing/TestWriteSimple.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: TestWriteSimple.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2007/09/04 08:06:52 $
   7   Version:   $Revision: 1.52 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 /**
  20  * Write a dicom file from nothing
  21  * The written image is 256x256, 8 bits, unsigned char
  22  * The image content is a horizontal grayscale from
  23  *
  24  */
  25 #include "gdcmFile.h"
  26 #include "gdcmFileHelper.h"
  27 #include "gdcmDebug.h"
  28 #include "gdcmGlobal.h"
  29 #include "gdcmDictSet.h"
  30
  31 #include <iostream>
  32 #include <sstream>
  33
  34 typedef struct
  35 {
  36    int sizeX;         // Size X of the image
  37    int sizeY;         // Size Y of the image
  38    int sizeZ;         // Size Z of the image
  39    int components;    // Number of components for a pixel
  40    int componentSize; // Component size (in bits : 8, 16) // Bits Allocated
  41    int componentUse ; // Component size (in bits)         // Bits Stored
  42    int sign;          // Sign of components
  43    char writeMode;    // Write mode
  44                       //  - 'a' : ACR
  45                       //  - 'e' : Explicit VR
  46                       //  - 'i' : Implicit VR
  47 } Image;
  48
  49 Image Images [] = {
  50 // these ones are use to check further oddities.
  51
  52    {63, 127, 1, 1, 16,  8,  0 ,'e'},
  53    {63, 127, 1, 1, 16,  9,  0 ,'e'},
  54    {63, 127, 1, 1, 16, 10,  0 ,'e'},
  55    {63, 127, 1, 1, 16, 11,  0 ,'e'},
  56    {63, 127, 1, 1, 16, 12,  0 ,'e'},
  57    {63, 127, 1, 1, 16, 13,  0 ,'e'},
  58    {63, 127, 1, 1, 16, 14,  0 ,'e'},
  59    {63, 127, 1, 1, 16, 15,  0 ,'e'},
  60    {63, 127, 1, 1, 16, 16,  0 ,'e'},
  61
  62    {128, 128, 1, 1, 8,  8,  0, 'e'},
  63    {256, 128, 1, 1, 8,  8,  0, 'a'},
  64    {128, 128, 1, 1, 8,  8,  0, 'i'},
  65
  66    {128, 128, 1, 1, 8,  8,  0, 'a'},
  67    {256, 128, 1, 1, 8,  8,  0, 'i'},
  68
  69
  70    {256, 128, 1, 1, 8,  8,  0, 'e'},
  71    {128, 128, 1, 1, 16, 16, 0, 'e'},
  72    {128, 256, 1, 1, 16, 16, 0, 'e'},
  73
  74    {128, 256, 1, 1, 8,  8,  0, 'e'},
  75    {128, 256, 1, 1, 8,  8,  0, 'i'},
  76    {128, 256, 1, 1, 8,  8,  0, 'a'},
  77
  78    {128, 256, 1, 1, 16, 16, 0, 'i'},
  79    {128, 256, 1, 1, 16, 16, 0, 'i'},
  80    {128, 256, 1, 1, 16, 16, 0, 'a'},
  81    {128, 256, 1, 1, 16, 16, 0, 'a'},
  82
  83    {256, 128, 10, 1, 8, 8,  0, 'e'},
  84    {256, 128, 10, 3, 8, 8,  0, 'e'},
  85    {256, 128, 10, 3, 8, 8,  0, 'i'},
  86    {256, 128, 10, 1, 8, 8,  0, 'i'},
  87    {256, 128, 10, 1, 8, 8,  0, 'a'},
  88    {256, 128, 10, 3, 8, 8,  0, 'a'},
  89
  90    {128, 128, 1, 1, 8,  8,  1, 'e'},
  91    {128, 128, 1, 1, 8,  8,  1, 'i'},
  92    {128, 128, 1, 1, 8,  8,  1, 'a'},
  93
  94    {256, 128, 1, 1, 8,  8,  1, 'e'},
  95    {256, 128, 1, 1, 8,  8,  1, 'i'},
  96    {256, 128, 1, 1, 8,  8,  1, 'a'},
  97
  98    {128, 256, 1, 1, 8,  8,  1, 'a'},
  99    {128, 256, 1, 1, 8,  8,  1, 'e'},
 100    {128, 256, 1, 1, 8,  8,  1, 'i'},
 101
 102    {128, 256, 1, 1, 16, 16, 1, 'e'},
 103    {128, 256, 1, 1, 16, 16, 1, 'e'},
 104    {128, 256, 1, 1, 16, 16, 1, 'i'},
 105    {128, 256, 1, 1, 16, 16, 1, 'i'},
 106    {128, 256, 1, 1, 16, 16, 1, 'a'},
 107    {128, 256, 1, 1, 16, 16, 1, 'a'},
 108
 109    {256, 128, 10, 1, 8, 8,  1, 'e'},
 110    {256, 128, 10, 1, 8, 8,  1, 'i'},
 111    {256, 128, 10, 1, 8, 8,  1, 'a'},
 112
 113    {256, 128, 10, 3, 8, 8,  1, 'e'},
 114    {256, 128, 10, 3, 8, 8,  1, 'i'},
 115    {256, 128, 10, 3, 8, 8,  1, 'a'},
 116    {0,   0,   1,  1, 8, 8,  0, 'i'} // to find the end
 117 };
 118
 119
 120 const unsigned int MAX_NUMBER_OF_DIFFERENCE = 10;
 121
 122 int WriteSimple(Image &img)
 123 {
 124
 125    std::cout << "======================= WriteSimple =========(begin of processing current image)" << std::endl;
 126    std::ostringstream fileName;
 127    fileName.str("");
 128    fileName << "TestWriteSimple";
 129
 130 // Step 1 : Create an empty FileHelper
 131
 132    std::cout << "        1...";
 133    GDCM_NAME_SPACE::FileHelper *fileH = GDCM_NAME_SPACE::FileHelper::New();
 134
 135  //  Get the (empty) image header.
 136    GDCM_NAME_SPACE::File *fileToBuild = fileH->GetFile();
 137    std::ostringstream str;
 138
 139    // Set the image size
 140    str.str("");
 141    str << img.sizeX;
 142    fileToBuild->InsertEntryString(str.str(),0x0028,0x0011,"US"); // Columns
 143    str.str("");
 144    str << img.sizeY;
 145    fileToBuild->InsertEntryString(str.str(),0x0028,0x0010,"US"); // Rows
 146
 147    if(img.sizeZ>1)
 148    {
 149       str.str("");
 150       str << img.sizeZ;
 151       fileToBuild->InsertEntryString(str.str(),0x0028,0x0008, "IS"); // Number of Frames
 152    }
 153
 154    fileName << "-" << img.sizeX << "-" << img.sizeY << "-" << img.sizeZ;
 155
 156    // Set the pixel type
 157    str.str("");
 158    str << img.componentSize;
 159    fileToBuild->InsertEntryString(str.str(),0x0028,0x0100,"US"); // Bits Allocated
 160
 161    str.str("");
 162    str << img.componentUse;
 163    fileToBuild->InsertEntryString(str.str(),0x0028,0x0101,"US"); // Bits Stored
 164
 165    str.str("");
 166    str << ( img.componentUse - 1 );
 167    fileToBuild->InsertEntryString(str.str(),0x0028,0x0102,"US"); // High Bit
 168
 169    // Set the pixel representation
 170    str.str("");
 171    str << img.sign;
 172    fileToBuild->InsertEntryString(str.str(),0x0028,0x0103,"US"); // Pixel Representation
 173
 174    fileName << "-" << img.componentSize;
 175    if(img.sign == 0)
 176       fileName << "U";
 177    else
 178       fileName << "S";
 179
 180    fileName << "-" << img.componentSize << "-" << img.componentUse;
 181
 182    fileToBuild->InsertEntryString("0",0x0008,0x0000,"UL"); // Should be removed
 183                                                             // except for ACR
 184    switch (img.writeMode)
 185    {
 186       case 'a' :
 187          fileName << ".ACR";
 188          break;
 189       case 'e' :
 190          fileName << ".EXPL";
 191          break;
 192       case 'i' :
 193          fileName << ".IMPL";
 194          break;
 195    }
 196
 197    std::cout << "[" << fileName.str() << "]...";
 198    // Set the samples per pixel
 199    str.str("");
 200    str << img.components;
 201    fileToBuild->InsertEntryString(str.str(),0x0028,0x0002,"US"); // Samples per Pixel
 202
 203 // Step 2 : Create the output image
 204    std::cout << "2...";
 205    if( img.componentSize%8 > 0 )
 206    {
 207       img.componentSize += 8-img.componentSize%8;
 208    }
 209    size_t size = img.sizeX * img.sizeY * img.sizeZ
 210                * img.components * img.componentSize / 8;
 211    unsigned char *imageData = new unsigned char[size];
 212
 213    // FIXME : find a better heuristic to create the image
 214    unsigned char *tmp = imageData;
 215    for(int k=0;k<img.sizeZ;k++)
 216    {
 217       for(int j=0;j<img.sizeY;j++)
 218       {
 219          for(int i=0;i<img.sizeX;i++)
 220          {
 221             for(int c=0;c<img.components;c++)
 222             {
 223                *tmp = (unsigned char)(j%256);
 224                if( img.componentSize>8 )
 225                {
 226                   *(tmp+1) = (unsigned char)(j/256);
 227                }
 228                tmp += img.componentSize/8;
 229             }
 230          }
 231       }
 232    }
 233
 234 // Step 3 : Set the image Pixel Data
 235    std::cout << "3...";
 236    fileH->SetImageData(imageData,size);
 237
 238 // Step 4 : Set the writting mode and write the image
 239
 240    fileH->SetWriteModeToRaw();
 241    std::cout << "4'...";
 242    switch (img.writeMode)
 243    {
 244       case 'a' : // Write an ACR file
 245          fileH->SetWriteTypeToAcr();
 246          break;
 247
 248       case 'e' : // Write a DICOM Explicit VR file
 249          fileH->SetWriteTypeToDcmExplVR();
 250          break;
 251
 252       case 'i' : // Write a DICOM Implicit VR file
 253          fileH->SetWriteTypeToDcmImplVR();
 254          break;
 255
 256       default :
 257          std::cout << "Failed for [" << fileName.str() << "]\n"
 258                    << "        Write mode '"<<img.writeMode<<"' is undefined\n";
 259
 260          fileH->Delete();
 261          delete[] imageData;
 262          return 1;
 263    }
 264
 265    std::cout << std::endl;
 266    //fileToBuild->Print();
 267
 268    if( !fileH->Write(fileName.str()) )
 269    {
 270       std::cout << "Failed for [" << fileName.str() << "]\n"
 271                 << "           File is unwrittable" << std::endl;
 272
 273       fileH->Delete();
 274
 275       delete[] imageData;
 276       return 1;
 277    }
 278
 279 // Step 5 : Read the written image
 280    std::cout << "5..." << std::endl;
 281    // old form.
 282    //GDCM_NAME_SPACE::FileHelper *reread = new GDCM_NAME_SPACE::FileHelper( fileName.str() );
 283    // Better use :
 284    GDCM_NAME_SPACE::File *f = GDCM_NAME_SPACE::File::New( );
 285    f->SetLoadMode(GDCM_NAME_SPACE::LD_ALL);
 286    f->SetFileName( fileName.str() );
 287
 288    //reread->SetFileName( fileName.str() );
 289    //reread->SetLoadMode(GDCM_NAME_SPACE::LD_ALL); // Load everything
 290                            // Possible values are
 291                            //              GDCM_NAME_SPACE::LD_ALL,
 292                            //              GDCM_NAME_SPACE::LD_NOSEQ,
 293                            //              GDCM_NAME_SPACE::LD_NOSHADOW,
 294                            //              GDCM_NAME_SPACE::LD_NOSEQ|GDCM_NAME_SPACE::LD_NOSHADOW,
 295                            //              GDCM_NAME_SPACE::LD_NOSHADOWSEQ
 296
 297    f->Load();
 298   // reread->Load();
 299    GDCM_NAME_SPACE::FileHelper *reread = GDCM_NAME_SPACE::FileHelper::New( f );
 300
 301    //reread->Print();
 302
 303    if( !reread->GetFile()->IsReadable() )
 304    {
 305       std::cerr << "Failed" << std::endl
 306                 << "Could not read written image : " << fileName.str() << std::endl;
 307       fileToBuild->Delete();
 308       fileH->Delete();
 309       reread->Delete();
 310       delete[] imageData;
 311       return 1;
 312    }
 313
 314 // Step 6 : Compare to the written image
 315    std::cout << "6..." << std::endl;
 316    size_t dataSizeWritten = reread->GetImageDataSize();
 317    uint8_t *imageDataWritten = reread->GetImageData();
 318
 319    // Test the image write mode
 320    if (reread->GetFile()->GetFileType() != fileH->GetWriteType())
 321    {
 322       std::cout << "Failed" << std::endl
 323          << "        File type differ: "
 324          << fileH->GetWriteType() << " # "
 325          << reread->GetFile()->GetFileType() << std::endl;
 326       fileToBuild->Delete();
 327       fileH->Delete();
 328       reread->Delete();
 329       delete[] imageData;
 330
 331       return 1;
 332    }
 333    std::cout << "6.1..." << std::endl;
 334    // Test the image size
 335    if (fileToBuild->GetXSize() != reread->GetFile()->GetXSize() ||
 336        fileToBuild->GetYSize() != reread->GetFile()->GetYSize() ||
 337        fileToBuild->GetZSize() != reread->GetFile()->GetZSize())
 338    {
 339       std::cout << "Failed for [" << fileName.str() << "]" << std::endl
 340          << "        X Size differs: "
 341          << "X: " << fileToBuild->GetXSize() << " # "
 342                   << reread->GetFile()->GetXSize() << " | "
 343          << "Y: " << fileToBuild->GetYSize() << " # "
 344                   << reread->GetFile()->GetYSize() << " | "
 345          << "Z: " << fileToBuild->GetZSize() << " # "
 346                   << reread->GetFile()->GetZSize() << std::endl;
 347       fileToBuild->Delete();
 348       fileH->Delete();
 349       reread->Delete();
 350       delete[] imageData;
 351
 352       return 1;
 353    }
 354  std::cout << "6.2..." << std::endl;
 355    // Test the data size
 356    if (size != dataSizeWritten)
 357    {
 358       std::cout << "Failed" << std::endl
 359          << "        Pixel areas lengths differ: "
 360          << size << " # " << dataSizeWritten << std::endl;
 361       fileToBuild->Delete();
 362       fileH->Delete();
 363       reread->Delete();
 364       delete[] imageData;
 365
 366       return 1;
 367    }
 368 std::cout << "6.3..." << std::endl;
 369    // Test the data content
 370    if ( memcmp(imageData, imageDataWritten, size) !=0 )
 371    {
 372       std::cout << fileName.str() << " Failed " << std::endl
 373                 << "        Pixel differ (as expanded in memory)." << std::endl;
 374       std::cout << "        list of the first " << MAX_NUMBER_OF_DIFFERENCE
 375                   << " pixels differing (pos : test - ref) :"
 376                   << std::endl;
 377       unsigned int i;
 378       unsigned int j;
 379       for(i=0, j=0;i<dataSizeWritten && j<MAX_NUMBER_OF_DIFFERENCE;i++)
 380       {
 381          if(imageDataWritten[i]!=imageData[i])
 382             {
 383             std::cout << std::hex << "(" << i << " : "
 384                         << std::hex << (int)(imageDataWritten[i]) << " - "
 385                         << std::hex << (int)(imageData[i]) << ") "
 386                         << std::dec;
 387             ++j;
 388             }
 389       }
 390       std::cout << std::endl;
 391       fileToBuild->Delete();
 392       fileH->Delete();
 393       reread->Delete();
 394       delete[] imageData;
 395
 396       return 1;
 397    }
 398 std::cout << "======================= OK" << std::endl;
 399    fileH->Delete();
 400    reread->Delete();
 401    delete[] imageData;
 402    return 0;
 403 }
 404
 405 int TestWriteSimple(int argc, char *argv[])
 406 {
 407    if (argc < 1)
 408    {
 409       std::cerr << "usage: \n"
 410                 << argv[0] << " (without parameters) " << std::endl
 411                 << std::endl;
 412       return 1;
 413    }
 414
 415   // GDCM_NAME_SPACE::Debug::DebugOn();
 416
 417    int ret=0;
 418    int i=0;
 419    while( Images[i].sizeX>0 && Images[i].sizeY>0 )
 420    {
 421       std::cout << "Test n :" << i <<std::endl;;
 422       ret += WriteSimple(Images[i] );
 423       i++;
 424
 425    }
 426
 427    return ret;
 428 }