Example/PrintFile.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: PrintFile.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/13 09:18:34 $
   7   Version:   $Revision: 1.62 $
   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 #include "gdcmFile.h"
  19 #include "gdcmDocument.h"
  20 #include "gdcmSeqEntry.h"
  21 #include "gdcmSQItem.h"
  22 #include "gdcmBinEntry.h"
  23
  24 #include "gdcmFileHelper.h"
  25 #include "gdcmDebug.h"
  26 #include "gdcmDirList.h"
  27 #include "gdcmGlobal.h"
  28 #include "gdcmDictSet.h"
  29 #include "gdcmArgMgr.h"
  30 #include "gdcmOrientation.h"
  31 #include <iostream>
  32
  33 // TODO : code factorization, for 'sigle file' an 'whole directory' processing
  34
  35 void ShowLutData(gdcm::File *f);
  36
  37      // Nothing is written yet to get LUT Data user friendly
  38      // The following is to be moved into a PixelReadConvert method
  39      // Let here, waiting for a clever idea on the way to do it.
  40
  41 void ShowLutData(gdcm::File *f)
  42 {
  43       gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
  44       if ( modLutSeq !=0 )
  45       {
  46          gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
  47          if ( sqi != 0 )
  48          {
  49             std::string lutDescriptor = sqi->GetEntryValue(0x0028,0x3002);
  50            if (   /*lutDescriptor   == GDCM_UNFOUND*/ 0 )
  51            {
  52               //gdcmWarningMacro( "LUT Descriptor is missing" );
  53               std::cout << "LUT Descriptor is missing" << std::endl;
  54               return;
  55             }
  56             int length;   // LUT length in Bytes
  57             int deb;      // Subscript of the first Lut Value
  58             int nbits;    // Lut item size (in Bits)
  59
  60             int nbRead;    // nb of items in LUT descriptor (must be = 3)
  61
  62             nbRead = sscanf( lutDescriptor.c_str(),
  63                               "%d\\%d\\%d",
  64                                &length, &deb, &nbits );
  65            std::cout << "length " << length
  66                      << " deb " << deb
  67                      << " nbits " << nbits
  68                      << std::endl;
  69             if ( nbRead != 3 )
  70             {
  71                 //gdcmWarningMacro( "Wrong LUT descriptor" );
  72                 std::cout << "Wrong LUT descriptor" << std::endl;
  73             }
  74             //LUT Data (CTX dependent)
  75             gdcm::BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
  76             if ( b != 0 )
  77             {
  78                int BitsAllocated = f->GetBitsAllocated();
  79                if ( BitsAllocated <= 8 )
  80                {
  81                   int mult;
  82                   if ( ( nbits == 16 ) && ( BitsAllocated == 8 ) )
  83                   {
  84                   // when LUT item size is different than pixel size
  85                      mult = 2; // high byte must be = low byte
  86                   }
  87                   else
  88                   {
  89                   // See PS 3.3-2003 C.11.1.1.2 p 619
  90                      mult = 1;
  91                   }
  92                   uint8_t *lut = b->GetBinArea();
  93                   for( int i=0; i < length; ++i )
  94                   {
  95                      std::cout << i+deb << " : \t"
  96                                << (int) (lut[i*mult + 1]) << std::endl;
  97                   }
  98                }
  99                else
 100                {
 101                   uint16_t *lut = (uint16_t *)(b->GetBinArea());
 102                   for( int i=0; i < length; ++i )
 103                   {
 104                      std::cout << i+deb << " : \t"
 105                                << (int) (((uint16_t *)lut)[i])
 106                                << std::endl;
 107                   }
 108                }
 109             }
 110             else
 111                std::cout << "No LUT Data BinEntry (0x0028,0x3006) found?!? "
 112                          << std::endl;
 113          }
 114          else
 115             std::cout << "No First SQ Item within (0x0028,0x3000) ?!? "
 116                       << std::endl;
 117       }
 118       else
 119          std::cout << "No LUT Data SeqEntry (0x0028,0x3000) found "
 120                    << std::endl;
 121    }
 122
 123 int main(int argc, char *argv[])
 124 {
 125
 126    START_USAGE(usage)
 127    " \n PrintFile : \n                                                        ",
 128    " Display the header of a ACR-NEMA/PAPYRUS/DICOM File                      ",
 129    " usage: PrintFile {filein=inputFileName|dirin=inputDirectoryName}[level=n]",
 130    "                       [forceload=listOfElementsToForceLoad]              ",
 131    "                       [dict= privateDirectory]                           ",
 132    "                       [ { [noshadowseq] | [noshadow][noseq] } ] [debug]  ",
 133    "      level = 0,1,2 : depending on the amount of details user wants to see",
 134    "      listOfElementsToForceLoad : group-elem,g2-e2,... (in hexa, no space)",
 135    "                                of Elements to load whatever their length ",
 136    "      privateDirectory : source file full path name of Shadow Group elems ",
 137    "      noshadowseq: user doesn't want to load Private Sequences            ",
 138    "      noshadow   : user doesn't want to load Private groups (odd number)  ",
 139    "      noseq      : user doesn't want to load Sequences                    ",
 140    "      debug      : user wants to run the program in 'debug mode'          ",
 141    "      showlut :user wants to display the Palette Color (as an int array)  ",
 142    FINISH_USAGE
 143
 144    // Initialize Arguments Manager
 145    gdcm::ArgMgr *am= new gdcm::ArgMgr(argc, argv);
 146
 147    if (argc == 1 || am->ArgMgrDefined("usage") )
 148    {
 149       am->ArgMgrUsage(usage); // Display 'usage'
 150       delete am;
 151       return 0;
 152    }
 153
 154    char *fileName = am->ArgMgrGetString("filein",(char *)0);
 155    char *dirName  = am->ArgMgrGetString("dirin",(char *)0);
 156
 157    if ( (fileName == 0 && dirName == 0)
 158         ||
 159         (fileName != 0 && dirName != 0) )
 160    {
 161        std::cout <<std::endl
 162                  << "Either 'filein=' or 'dirin=' must be present;"
 163                  << std::endl << "Not both" << std::endl;
 164        am->ArgMgrUsage(usage); // Display 'usage'
 165        delete am;
 166        return 0;
 167  }
 168
 169    if (am->ArgMgrDefined("debug"))
 170       gdcm::Debug::DebugOn();
 171
 172    int loadMode = gdcm::LD_ALL;
 173    if ( am->ArgMgrDefined("noshadowseq") )
 174       loadMode |= gdcm::LD_NOSHADOWSEQ;
 175    else
 176    {
 177    if ( am->ArgMgrDefined("noshadow") )
 178          loadMode |= gdcm::LD_NOSHADOW;
 179       if ( am->ArgMgrDefined("noseq") )
 180          loadMode |= gdcm::LD_NOSEQ;
 181    }
 182
 183    int level = am->ArgMgrGetInt("level", 1);
 184
 185    int forceLoadNb;
 186    uint16_t *elemsToForceLoad
 187                            = am->ArgMgrGetXInt16Enum("forceload", &forceLoadNb);
 188
 189    bool showlut = ( 0 != am->ArgMgrDefined("SHOWLUT") );
 190
 191    bool ddict = am->ArgMgrDefined("dict") ? true : false;
 192    char *dict = 0;
 193
 194    if (ddict)
 195    {
 196      dict = am->ArgMgrGetString("dict",(char *)0);
 197    }
 198
 199    /* if unused Param we give up */
 200    if ( am->ArgMgrPrintUnusedLabels() )
 201    {
 202       am->ArgMgrUsage(usage);
 203       delete am;
 204       return 0;
 205    }
 206
 207    delete am;  // we don't need Argument Manager any longer
 208
 209    // ----------- End Arguments Manager ---------
 210
 211
 212    if (ddict)
 213    {
 214       gdcm::Global::GetDicts()->GetDefaultPubDict()->AddDict(dict);
 215    }
 216
 217    if ( fileName != 0 ) // ====== Deal with a single file ======
 218    {
 219       // gdcm::File::IsReadable() is no usable here, because we deal with
 220       // any kind of gdcm-Parsable *document*
 221       // not only gdcm::File (as opposed to gdcm::DicomDir)
 222
 223       gdcm::File *f = new gdcm::File();
 224       f->SetLoadMode(loadMode);
 225       f->SetFileName( fileName );
 226
 227       for (int ri=0; ri<forceLoadNb; ri++)
 228       {
 229          f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
 230                                 (uint32_t)elemsToForceLoad[2*ri+1] );
 231       }
 232
 233       bool res = f->Load();
 234       if ( !res )
 235       {
 236          std::cout << "Cannot process file [" << fileName << "]" << std::endl;
 237          std::cout << "Either it doesn't exist, or it's read protected "
 238                    << std::endl;
 239          std::cout << "or it's not a Dicom File, or its 'header' is bugged"
 240                    << std::endl;
 241          std::cout << "use 'PrintFile filein=... debug' to try to guess the pb"
 242                    << std::endl;
 243          delete f;
 244          return 0;
 245       }
 246
 247       gdcm::FileHelper *fh = new gdcm::FileHelper(f);
 248       fh->SetPrintLevel( level );
 249
 250       fh->Print();
 251
 252       std::cout << "\n\n" << std::endl;
 253
 254       std::cout <<std::endl;
 255       std::cout <<" dataSize    " << fh->GetImageDataSize()    << std::endl;
 256       std::cout <<" dataSizeRaw " << fh->GetImageDataRawSize() << std::endl;
 257
 258       int nX,nY,nZ,sPP,planarConfig;
 259       std::string pixelType;
 260       nX=f->GetXSize();
 261       nY=f->GetYSize();
 262       nZ=f->GetZSize();
 263       std::cout << " DIMX=" << nX << " DIMY=" << nY << " DIMZ=" << nZ
 264                 << std::endl;
 265
 266       pixelType    = f->GetPixelType();
 267       sPP          = f->GetSamplesPerPixel();
 268       planarConfig = f->GetPlanarConfiguration();
 269
 270       std::cout << " pixelType= ["            << pixelType
 271                 << "] SamplesPerPixel= ["     << sPP
 272                 << "] PlanarConfiguration= [" << planarConfig
 273                 << "] "<< std::endl
 274                 << " PhotometricInterpretation= ["
 275                                 << f->GetEntryValue(0x0028,0x0004)
 276                 << "] "<< std::endl;
 277
 278       int numberOfScalarComponents=f->GetNumberOfScalarComponents();
 279       std::cout << " NumberOfScalarComponents = " << numberOfScalarComponents
 280                 <<std::endl
 281                 << " LUT = " << (f->HasLUT() ? "TRUE" : "FALSE")
 282                 << std::endl;
 283
 284       if ( f->GetEntryValue(0x0002,0x0010) == gdcm::GDCM_NOTLOADED )
 285       {
 286          std::cout << "Transfer Syntax not loaded. " << std::endl
 287                    << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE"
 288                 << std::endl;
 289          return 0;
 290       }
 291
 292       std::string transferSyntaxName = f->GetTransferSyntaxName();
 293       std::cout << " TransferSyntaxName= [" << transferSyntaxName << "]"
 294                 << std::endl;
 295       std::cout << " SwapCode= " << f->GetSwapCode() << std::endl;
 296       std::cout << " ------" << std::endl;
 297       //std::cout << "\n\n" << std::endl;
 298       //std::cout << "X spacing " << f->GetXSpacing() << std::endl;
 299       //std::cout << "Y spacing " << f->GetYSpacing() << std::endl;
 300       //std::cout << "Z spacing " << f->GetZSpacing() << std::endl;
 301
 302 //------------------------------
 303       // Lets's get and print some usefull fields about 'Orientation'
 304       // ------------------------------------------------------------
 305
 306       std::string strPatientPosition =
 307                                       f->GetEntryValue(0x0018,0x5100);
 308       if ( strPatientPosition != gdcm::GDCM_UNFOUND
 309         && strPatientPosition != "" )
 310             std::cout << "PatientPosition (0x0010,0x5100)= ["
 311                       << strPatientPosition << "]" << std::endl;
 312
 313       std::string strViewPosition =
 314                                       f->GetEntryValue(0x0018,0x5101);
 315       if ( strViewPosition != gdcm::GDCM_UNFOUND
 316         && strViewPosition != "" )
 317             std::cout << "strViewPosition (0x0010,0x5101)= ["
 318                       << strViewPosition << "]" << std::endl;
 319
 320      std::string strPatientOrientation =
 321                                       f->GetEntryValue(0x0020,0x0020);
 322       if ( strPatientOrientation != gdcm::GDCM_UNFOUND
 323         && strPatientOrientation != "")
 324          std::cout << "PatientOrientation (0x0020,0x0020)= ["
 325                    << strPatientOrientation << "]" << std::endl;
 326
 327       std::string strImageOrientationPatient =
 328                                       f->GetEntryValue(0x0020,0x0037);
 329       if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
 330         && strImageOrientationPatient != "" )
 331          std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
 332                    << strImageOrientationPatient << "]" << std::endl;
 333
 334       std::string strImageOrientationRET =
 335                                       f->GetEntryValue(0x0020,0x0035);
 336       if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
 337         && strImageOrientationRET != "" )
 338          std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
 339                    << strImageOrientationRET << "]" << std::endl;
 340
 341       // Let's compute 'user friendly' results about 'Orientation'
 342       // ---------------------------------------------------------
 343
 344       gdcm::Orientation o;
 345
 346       if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
 347            strImageOrientationRET     != gdcm::GDCM_UNFOUND )
 348       {
 349
 350          gdcm::OrientationType orient = o.GetOrientationType( f );
 351
 352          std::cout << "TypeOrientation = " << orient << " (-> "
 353                    << o.GetOrientationTypeString(orient) << " )" << std::endl;
 354       }
 355
 356       std::string ori = o.GetOrientation ( f );
 357       if (ori != "\\" )
 358          std::cout << "Orientation [" << ori << "]" << std::endl;
 359
 360 //------------------------------
 361
 362
 363       // Display the LUT as an int array (for debugging purpose)
 364       if ( f->HasLUT() && showlut )
 365       {
 366          uint8_t* lutrgba = fh->GetLutRGBA();
 367          if ( lutrgba == 0 )
 368          {
 369             std::cout << "Lut RGBA (Palette Color) not built " << std::endl;
 370
 371            // Nothing is written yet to get LUT Data user friendly
 372            // The following is to be moved into a PixelRedaConvert method
 373
 374             gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
 375             if ( modLutSeq !=0 )
 376             {
 377                gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
 378                if ( !sqi )
 379                {
 380                std::string lutDescriptor = sqi->GetEntryValue(0x0028,0x3002);
 381                   int length;   // LUT length in Bytes
 382                   int deb;      // Subscript of the first Lut Value
 383                   int nbits;    // Lut item size (in Bits)
 384                   int nbRead;   // nb of items in LUT descriptor (must be = 3)
 385
 386                   nbRead = sscanf( lutDescriptor.c_str(),
 387                                     "%d\\%d\\%d",
 388                                      &length, &deb, &nbits );
 389                   if ( nbRead != 3 )
 390                   {
 391                       //gdcmWarningMacro( "Wrong LUT descriptor" );
 392                       std::cout << "Wrong LUT descriptor" << std::endl;
 393                   }
 394                   gdcm::BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
 395                   if ( b != 0 )
 396                   {
 397                      if ( b->GetLength() != 0 )
 398                      {
 399                         std::cout << "---------------------------------------"
 400                                << " We should never reach this point      "
 401                                << std::endl;
 402                         //LoadEntryBinArea(b);    //LUT Data (CTX dependent)
 403                      }
 404                  }
 405               }
 406             }
 407             else
 408                std::cout << "No LUT Data (0x0028,0x3000) found " << std::endl;
 409         }
 410          else
 411          {
 412             if ( fh->GetLutItemSize() == 8 )
 413             {
 414                for (int i=0;i<fh->GetLutItemNumber();i++)
 415                   std::cout << i << " : \t"
 416                          << (int)(lutrgba[i*4])   << " "
 417                          << (int)(lutrgba[i*4+1]) << " "
 418                          << (int)(lutrgba[i*4+2]) << std::endl;
 419             }
 420             else // LutItemSize assumed to be = 16
 421             {
 422                uint16_t* lutrgba16 = (uint16_t*)lutrgba;
 423                for (int i=0;i<fh->GetLutItemNumber();i++)
 424                   std::cout << i << " : \t"
 425                          << (int)(lutrgba16[i*4])   << " "
 426                          << (int)(lutrgba16[i*4+1]) << " "
 427                          << (int)(lutrgba16[i*4+2]) << std::endl;
 428             }
 429          }
 430       }
 431       else if (showlut)
 432       {
 433          std::cout << "Try LUT Data "<< std::endl;
 434          ShowLutData(f);
 435       }
 436
 437       //if( !f->gdcm::Document::IsReadable())
 438       // Try downcast to please MSVC
 439      if ( !((gdcm::Document *)f)->IsReadable() )
 440      {
 441          std::cout <<std::endl<<fileName<<" is NOT 'gdcm parsable'"<<std::endl;
 442       }
 443
 444       if (f->IsReadable())
 445          std::cout <<std::endl<<fileName<<" is Readable"<<std::endl;
 446       else if ( f->GetSeqEntry(0x0041,0x1010) )
 447       {
 448          std::cout <<std::endl<<fileName<<" looks like a 'PAPYRUS image' file"
 449                    <<std::endl;
 450       }
 451       else if ( f->GetSeqEntry(0x0004,0x1220) )
 452       {
 453          std::cout <<std::endl<<fileName<<" looks like a 'DICOMDIR file'"
 454                    <<std::endl;
 455       }
 456       else
 457       {
 458          std::cout <<std::endl<<fileName<<" doesn't look like an image file "
 459              <<std::endl;
 460       }
 461
 462       std::cout<<std::flush;
 463       delete f;
 464       delete fh;
 465       return 0;
 466    }
 467    else  // ====== Deal with a Directory ======
 468    {
 469       std::cout << "dirName [" << dirName << "]" << std::endl;
 470       gdcm::DirList dirList(dirName,1); // gets recursively the file list
 471       gdcm::DirListType fileList = dirList.GetFilenames();
 472       gdcm::File *f;
 473       bool res;
 474       for( gdcm::DirListType::iterator it  = fileList.begin();
 475                                  it != fileList.end();
 476                                  ++it )
 477       {
 478          std::cout << std::endl<<" Start processing :[" << it->c_str() << "]"
 479                    << std::endl;
 480          f = new gdcm::File();
 481          f->SetLoadMode(loadMode);
 482          f->SetFileName( it->c_str() );
 483
 484          for (int ri=0; ri<forceLoadNb; ri++)
 485          {
 486             printf("%04x,%04x\n",elemsToForceLoad[2*ri],
 487                                  elemsToForceLoad[2*ri+1]);
 488             f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
 489                                    (uint32_t)elemsToForceLoad[2*ri+1]);
 490          }
 491          res = f->Load();
 492
 493          if ( !res )
 494          {
 495             std::cout << "Cannot process file [" << it->c_str() << "]"
 496                       << std::endl;
 497             std::cout << "Either it doesn't exist, or it's read protected "
 498                       << std::endl;
 499             std::cout << "or it's not a Dicom File, or its 'header' is bugged"
 500                       << std::endl;
 501             std::cout << "use 'PrintFile filein=... debug' "
 502                       << "to try to guess the pb"
 503                       << std::endl;
 504             delete f;
 505             continue;
 506          }
 507
 508          gdcm::FileHelper *fh = new gdcm::FileHelper(f);
 509          fh->SetPrintLevel( level );
 510          fh->Print();
 511
 512 //------------------------------
 513
 514       // Lets's get and print some usefull fields about 'Orientation'
 515       // ------------------------------------------------------------
 516
 517       std::string strPatientPosition =
 518                                       f->GetEntryValue(0x0018,0x5100);
 519       if ( strPatientPosition != gdcm::GDCM_UNFOUND
 520         && strPatientPosition != "" )
 521             std::cout << "PatientPosition (0x0010,0x5100)= ["
 522                       << strPatientPosition << "]" << std::endl;
 523
 524       std::string strViewPosition =
 525                                       f->GetEntryValue(0x0018,0x5101);
 526       if ( strViewPosition != gdcm::GDCM_UNFOUND
 527         && strViewPosition != "" )
 528             std::cout << "strViewPosition (0x0010,0x5101)= ["
 529                       << strViewPosition << "]" << std::endl;
 530
 531      std::string strPatientOrientation =
 532                                       f->GetEntryValue(0x0020,0x0020);
 533       if ( strPatientOrientation != gdcm::GDCM_UNFOUND
 534         && strPatientOrientation != "")
 535          std::cout << "PatientOrientation (0x0020,0x0020)= ["
 536                    << strPatientOrientation << "]" << std::endl;
 537
 538       std::string strImageOrientationPatient =
 539                                       f->GetEntryValue(0x0020,0x0037);
 540       if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
 541         && strImageOrientationPatient != "" )
 542          std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
 543                    << strImageOrientationPatient << "]" << std::endl;
 544
 545       std::string strImageOrientationRET =
 546                                       f->GetEntryValue(0x0020,0x0035);
 547       if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
 548         && strImageOrientationRET != "" )
 549          std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
 550                    << strImageOrientationRET << "]" << std::endl;
 551
 552       // Let's compute 'user friendly' results about 'Orientation'
 553       // ---------------------------------------------------------
 554
 555       gdcm::Orientation o;
 556
 557       if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
 558            strImageOrientationRET     != gdcm::GDCM_UNFOUND )
 559       {
 560
 561          gdcm::OrientationType orient = o.GetOrientationType( f );
 562
 563          std::cout << "TypeOrientation = " << orient << " (-> "
 564                    << o.GetOrientationTypeString(orient) << " )" << std::endl;
 565       }
 566
 567       std::string ori = o.GetOrientation ( f );
 568       if (ori != "\\" )
 569          std::cout << "Orientation [" << ori << "]" << std::endl;
 570
 571 //-------------------------------
 572
 573
 574          if (f->IsReadable())
 575             std::cout <<std::endl<<it->c_str()<<" is Readable"<<std::endl;
 576          else
 577             std::cout <<std::endl<<it->c_str()<<" is NOT Readable"<<std::endl;
 578          std::cout << "\n\n" << std::endl;
 579          delete f;
 580          delete fh;
 581       }
 582       std::cout<<std::flush;
 583    }
 584 }