1 /*=========================================================================
4 Module: $RCSfile: PrintFile.cxx,v $
6 Date: $Date: 2005/10/27 09:07:45 $
7 Version: $Revision: 1.68 $
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.
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.
17 =========================================================================*/
19 #include "gdcmDocument.h"
20 #include "gdcmSeqEntry.h"
21 #include "gdcmSQItem.h"
22 #include "gdcmDataEntry.h"
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"
33 // TODO : code factorization, for 'single file' an 'whole directory' processing
35 void ShowLutData(gdcm::File *f);
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.
41 void ShowLutData(gdcm::File *f)
43 gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
46 gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
49 std::string lutDescriptor = sqi->GetEntryString(0x0028,0x3002);
50 if ( /*lutDescriptor == GDCM_UNFOUND*/ 0 )
52 //gdcmWarningMacro( "LUT Descriptor is missing" );
53 std::cout << "LUT Descriptor is missing" << std::endl;
56 int length; // LUT length in Bytes
57 int deb; // Subscript of the first Lut Value
58 int nbits; // Lut item size (in Bits)
60 int nbRead; // nb of items in LUT descriptor (must be = 3)
62 nbRead = sscanf( lutDescriptor.c_str(),
64 &length, &deb, &nbits );
65 std::cout << "length " << length
71 //gdcmWarningMacro( "Wrong LUT descriptor" );
72 std::cout << "Wrong LUT descriptor" << std::endl;
74 //LUT Data (CTX dependent)
75 gdcm::DataEntry *b = sqi->GetDataEntry(0x0028,0x3006);
78 int BitsAllocated = f->GetBitsAllocated();
79 if ( BitsAllocated <= 8 )
82 if ( ( nbits == 16 ) && ( BitsAllocated == 8 ) )
84 // when LUT item size is different than pixel size
85 mult = 2; // high byte must be = low byte
89 // See PS 3.3-2003 C.11.1.1.2 p 619
92 uint8_t *lut = b->GetBinArea();
93 for( int i=0; i < length; ++i )
95 std::cout << i+deb << " : \t"
96 << (int) (lut[i*mult + 1]) << std::endl;
101 uint16_t *lut = (uint16_t *)(b->GetBinArea());
102 for( int i=0; i < length; ++i )
104 std::cout << i+deb << " : \t"
105 << (int) (((uint16_t *)lut)[i])
111 std::cout << "No LUT Data DataEntry (0x0028,0x3006) found?!? "
115 std::cout << "No First SQ Item within (0x0028,0x3000) ?!? "
119 std::cout << "No LUT Data SeqEntry (0x0028,0x3000) found "
123 int main(int argc, char *argv[])
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) ",
144 // Initialize Arguments Manager
145 gdcm::ArgMgr *am= new gdcm::ArgMgr(argc, argv);
147 if (argc == 1 || am->ArgMgrDefined("usage") )
149 am->ArgMgrUsage(usage); // Display 'usage'
154 char *fileName = am->ArgMgrGetString("filein",(char *)0);
155 char *dirName = am->ArgMgrGetString("dirin",(char *)0);
157 if ( (fileName == 0 && dirName == 0) ||
158 (fileName != 0 && dirName != 0) )
160 std::cerr << std::endl
161 << "Either 'filein=' or 'dirin=' must be present;"
162 << std::endl << "Not both" << std::endl;
163 am->ArgMgrUsage(usage); // Display 'usage'
168 if (am->ArgMgrDefined("debug"))
169 gdcm::Debug::DebugOn();
171 int loadMode = gdcm::LD_ALL;
172 if ( am->ArgMgrDefined("noshadowseq") )
173 loadMode |= gdcm::LD_NOSHADOWSEQ;
176 if ( am->ArgMgrDefined("noshadow") )
177 loadMode |= gdcm::LD_NOSHADOW;
178 if ( am->ArgMgrDefined("noseq") )
179 loadMode |= gdcm::LD_NOSEQ;
182 int level = am->ArgMgrGetInt("level", 1);
185 uint16_t *elemsToForceLoad
186 = am->ArgMgrGetXInt16Enum("forceload", &forceLoadNb);
188 bool showlut = ( 0 != am->ArgMgrDefined("SHOWLUT") );
190 bool ddict = am->ArgMgrDefined("dict") ? true : false;
195 dict = am->ArgMgrGetString("dict",(char *)0);
198 /* if unused Param we give up */
199 if ( am->ArgMgrPrintUnusedLabels() )
201 am->ArgMgrUsage(usage);
206 delete am; // we don't need Argument Manager any longer
208 // ----------- End Arguments Manager ---------
213 gdcm::Global::GetDicts()->GetDefaultPubDict()->AddDict(dict);
216 if ( fileName != 0 ) // ====== Deal with a single file ======
218 // gdcm::File::IsReadable() is no usable here, because we deal with
219 // any kind of gdcm-Parsable *document*
220 // not only gdcm::File (as opposed to gdcm::DicomDir)
222 gdcm::File *f = gdcm::File::New();
223 f->SetLoadMode(loadMode);
224 f->SetFileName( fileName );
226 for (int ri=0; ri<forceLoadNb; ri++)
228 f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
229 (uint32_t)elemsToForceLoad[2*ri+1] );
232 bool res = f->Load();
235 std::cout << "Cannot process file [" << fileName << "]" << std::endl;
236 std::cout << "Either it doesn't exist, or it's read protected "
238 std::cout << "or it's not a Dicom File, or its 'header' is bugged"
240 std::cout << "use 'PrintFile filein=... debug' to try to guess the pb"
246 gdcm::FileHelper *fh = gdcm::FileHelper::New(f);
247 fh->SetPrintLevel( level );
251 std::cout << "\n\n" << std::endl;
253 std::cout <<std::endl;
254 std::cout <<" dataSize " << fh->GetImageDataSize() << std::endl;
255 std::cout <<" dataSizeRaw " << fh->GetImageDataRawSize() << std::endl;
257 int nX,nY,nZ,sPP,planarConfig;
258 std::string pixelType;
262 std::cout << " DIMX=" << nX << " DIMY=" << nY << " DIMZ=" << nZ
265 pixelType = f->GetPixelType();
266 sPP = f->GetSamplesPerPixel();
268 planarConfig = f->GetPlanarConfiguration();
270 std::cout << " pixelType= [" << pixelType
271 << "] SamplesPerPixel= [" << sPP
274 std::cout << " PlanarConfiguration= [" << planarConfig
277 std::cout << " PhotometricInterpretation= ["
278 << f->GetEntryString(0x0028,0x0004)
281 int numberOfScalarComponents=f->GetNumberOfScalarComponents();
282 std::cout << " NumberOfScalarComponents = " << numberOfScalarComponents
284 << " LUT = " << (f->HasLUT() ? "TRUE" : "FALSE")
287 if ( f->GetDataEntry(0x0002,0x0010) )
288 if ( f->GetDataEntry(0x0002,0x0010)->IsNotLoaded() )
290 std::cout << "Transfer Syntax not loaded. " << std::endl
291 << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE"
297 std::string transferSyntaxName = f->GetTransferSyntaxName();
298 std::cout << " TransferSyntaxName= [" << transferSyntaxName << "]"
300 std::cout << " SwapCode= " << f->GetSwapCode() << std::endl;
301 std::cout << " ------" << std::endl;
303 //std::cout << "\n\n" << std::endl;
304 //std::cout << "X spacing " << f->GetXSpacing() << std::endl;
305 //std::cout << "Y spacing " << f->GetYSpacing() << std::endl;
306 //std::cout << "Z spacing " << f->GetZSpacing() << std::endl;
308 //------------------------------
309 // Lets's get and print some usefull fields about 'Orientation'
310 // ------------------------------------------------------------
312 std::string strPatientPosition =
313 f->GetEntryString(0x0018,0x5100);
314 if ( strPatientPosition != gdcm::GDCM_UNFOUND
315 && strPatientPosition != "" )
316 std::cout << "PatientPosition (0x0010,0x5100)= ["
317 << strPatientPosition << "]" << std::endl;
319 std::string strViewPosition =
320 f->GetEntryString(0x0018,0x5101);
321 if ( strViewPosition != gdcm::GDCM_UNFOUND
322 && strViewPosition != "" )
323 std::cout << "strViewPosition (0x0010,0x5101)= ["
324 << strViewPosition << "]" << std::endl;
326 std::string strPatientOrientation =
327 f->GetEntryString(0x0020,0x0020);
328 if ( strPatientOrientation != gdcm::GDCM_UNFOUND
329 && strPatientOrientation != "")
330 std::cout << "PatientOrientation (0x0020,0x0020)= ["
331 << strPatientOrientation << "]" << std::endl;
333 std::string strImageOrientationPatient =
334 f->GetEntryString(0x0020,0x0037);
335 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
336 && strImageOrientationPatient != "" )
337 std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
338 << strImageOrientationPatient << "]" << std::endl;
340 std::string strImageOrientationRET =
341 f->GetEntryString(0x0020,0x0035);
342 if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
343 && strImageOrientationRET != "" )
344 std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
345 << strImageOrientationRET << "]" << std::endl;
347 // Let's compute 'user friendly' results about 'Orientation'
348 // ---------------------------------------------------------
352 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
353 strImageOrientationRET != gdcm::GDCM_UNFOUND )
356 gdcm::OrientationType orient = o.GetOrientationType( f );
358 std::cout << "TypeOrientation = " << orient << " (-> "
359 << o.GetOrientationTypeString(orient) << " )" << std::endl;
362 std::string ori = o.GetOrientation ( f );
364 std::cout << "Orientation [" << ori << "]" << std::endl;
366 //------------------------------
369 // Display the LUT as an int array (for debugging purpose)
370 if ( f->HasLUT() && showlut )
372 uint8_t* lutrgba = fh->GetLutRGBA();
375 std::cout << "Lut RGBA (Palette Color) not built " << std::endl;
377 // Nothing is written yet to get LUT Data user friendly
378 // The following is to be moved into a PixelRedaConvert method
380 gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
383 gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
386 std::string lutDescriptor = sqi->GetEntryString(0x0028,0x3002);
387 int length; // LUT length in Bytes
388 int deb; // Subscript of the first Lut Value
389 int nbits; // Lut item size (in Bits)
390 int nbRead; // nb of items in LUT descriptor (must be = 3)
392 nbRead = sscanf( lutDescriptor.c_str(),
394 &length, &deb, &nbits );
397 //gdcmWarningMacro( "Wrong LUT descriptor" );
398 std::cout << "Wrong LUT descriptor" << std::endl;
400 gdcm::DataEntry *b = sqi->GetDataEntry(0x0028,0x3006);
403 if ( b->GetLength() != 0 )
405 std::cout << "---------------------------------------"
406 << " We should never reach this point "
408 //LoadEntryBinArea(b); //LUT Data (CTX dependent)
414 std::cout << "No LUT Data (0x0028,0x3000) found " << std::endl;
418 if ( fh->GetLutItemSize() == 8 )
420 for (int i=0;i<fh->GetLutItemNumber();i++)
421 std::cout << i << " : \t"
422 << (int)(lutrgba[i*4]) << " "
423 << (int)(lutrgba[i*4+1]) << " "
424 << (int)(lutrgba[i*4+2]) << std::endl;
426 else // LutItemSize assumed to be = 16
428 uint16_t* lutrgba16 = (uint16_t*)lutrgba;
429 for (int i=0;i<fh->GetLutItemNumber();i++)
430 std::cout << i << " : \t"
431 << (int)(lutrgba16[i*4]) << " "
432 << (int)(lutrgba16[i*4+1]) << " "
433 << (int)(lutrgba16[i*4+2]) << std::endl;
439 std::cout << "Try LUT Data "<< std::endl;
443 //if( !f->gdcm::Document::IsReadable())
444 // Try downcast to please MSVC
445 if ( !((gdcm::Document *)f)->IsReadable() )
447 std::cout <<std::endl<<fileName<<" is NOT 'gdcm parsable'"<<std::endl;
450 if ( f->IsReadable() )
452 std::cout <<std::endl<<fileName<<" is Readable"<<std::endl;
454 else if ( f->GetSeqEntry(0x0041,0x1010) )
456 std::cout <<std::endl<<fileName<<" looks like a 'PAPYRUS image' file"
459 else if ( f->GetSeqEntry(0x0004,0x1220) )
461 std::cout <<std::endl<<fileName<<" looks like a 'DICOMDIR file'"
466 std::cout <<std::endl<<fileName<<" doesn't look like an image file "
470 std::cout<<std::flush;
474 else // ====== Deal with a Directory ======
476 std::cout << "dirName [" << dirName << "]" << std::endl;
477 gdcm::DirList dirList(dirName,1); // gets recursively the file list
478 gdcm::DirListType fileList = dirList.GetFilenames();
482 for( gdcm::DirListType::iterator it = fileList.begin();
483 it != fileList.end();
486 std::cout << std::endl<<" Start processing :[" << it->c_str() << "]"
488 f = gdcm::File::New();
489 f->SetLoadMode(loadMode);
490 f->SetFileName( it->c_str() );
492 for (int ri=0; ri<forceLoadNb; ri++)
494 printf("%04x,%04x\n",elemsToForceLoad[2*ri],
495 elemsToForceLoad[2*ri+1]);
496 f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
497 (uint32_t)elemsToForceLoad[2*ri+1]);
503 std::cout << "Cannot process file [" << it->c_str() << "]"
505 std::cout << "Either it doesn't exist, or it's read protected "
507 std::cout << "or it's not a Dicom File, or its 'header' is bugged"
509 std::cout << "use 'PrintFile filein=... debug' "
510 << "to try to guess the pb"
516 gdcm::FileHelper *fh = gdcm::FileHelper::New(f);
517 fh->SetPrintLevel( level );
520 //------------------------------
522 // Lets's get and print some usefull fields about 'Orientation'
523 // ------------------------------------------------------------
525 std::string strPatientPosition =
526 f->GetEntryString(0x0018,0x5100);
527 if ( strPatientPosition != gdcm::GDCM_UNFOUND
528 && strPatientPosition != "" )
529 std::cout << "PatientPosition (0x0010,0x5100)= ["
530 << strPatientPosition << "]" << std::endl;
532 std::string strViewPosition =
533 f->GetEntryString(0x0018,0x5101);
534 if ( strViewPosition != gdcm::GDCM_UNFOUND
535 && strViewPosition != "" )
536 std::cout << "strViewPosition (0x0010,0x5101)= ["
537 << strViewPosition << "]" << std::endl;
539 std::string strPatientOrientation =
540 f->GetEntryString(0x0020,0x0020);
541 if ( strPatientOrientation != gdcm::GDCM_UNFOUND
542 && strPatientOrientation != "")
543 std::cout << "PatientOrientation (0x0020,0x0020)= ["
544 << strPatientOrientation << "]" << std::endl;
546 std::string strImageOrientationPatient =
547 f->GetEntryString(0x0020,0x0037);
548 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
549 && strImageOrientationPatient != "" )
550 std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
551 << strImageOrientationPatient << "]" << std::endl;
553 std::string strImageOrientationRET =
554 f->GetEntryString(0x0020,0x0035);
555 if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
556 && strImageOrientationRET != "" )
558 std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
559 << strImageOrientationRET << "]" << std::endl;
562 // Let's compute 'user friendly' results about 'Orientation'
563 // ---------------------------------------------------------
567 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
568 strImageOrientationRET != gdcm::GDCM_UNFOUND )
571 gdcm::OrientationType orient = o.GetOrientationType( f );
573 std::cout << "TypeOrientation = " << orient << " (-> "
574 << o.GetOrientationTypeString(orient) << " )" << std::endl;
577 std::string ori = o.GetOrientation ( f );
579 std::cout << "Orientation [" << ori << "]" << std::endl;
581 //-------------------------------
585 std::cout <<std::endl<<it->c_str()<<" is Readable"<<std::endl;
587 std::cout <<std::endl<<it->c_str()<<" is NOT Readable"<<std::endl;
588 std::cout << "\n\n" << std::endl;
592 std::cout<<std::flush;