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