1 /*=========================================================================
4 Module: $RCSfile: PrintFile.cxx,v $
6 Date: $Date: 2005/11/18 11:45:34 $
7 Version: $Revision: 1.72 $
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] } ] ",
133 " [debug] [warning] ",
134 " level = 0,1,2 : depending on the amount of details user wants to see",
135 " listOfElementsToForceLoad : group-elem,g2-e2,... (in hexa, no space)",
136 " of Elements to load whatever their length ",
137 " privateDirectory : source file full path name of Shadow Group elems ",
138 " noshadowseq: user doesn't want to load Private Sequences ",
139 " noshadow : user doesn't want to load Private groups (odd number) ",
140 " noseq : user doesn't want to load Sequences ",
141 " debug : user wants to run the program in 'debug mode' ",
142 " warning : user wants to be warned about any oddity in the File ",
143 " showlut :user wants to display the Palette Color (as an int array) ",
146 // Initialize Arguments Manager
147 gdcm::ArgMgr *am= new gdcm::ArgMgr(argc, argv);
149 if (argc == 1 || am->ArgMgrDefined("usage") )
151 am->ArgMgrUsage(usage); // Display 'usage'
156 char *fileName = am->ArgMgrGetString("filein",(char *)0);
157 char *dirName = am->ArgMgrGetString("dirin",(char *)0);
159 if ( (fileName == 0 && dirName == 0) ||
160 (fileName != 0 && dirName != 0) )
162 std::cerr << std::endl
163 << "Either 'filein=' or 'dirin=' must be present;"
164 << std::endl << "Not both" << std::endl;
165 am->ArgMgrUsage(usage); // Display 'usage'
170 if (am->ArgMgrDefined("debug"))
171 gdcm::Debug::DebugOn();
173 if (am->ArgMgrDefined("warning"))
174 gdcm::Debug::WarningOn();
176 int loadMode = gdcm::LD_ALL;
177 if ( am->ArgMgrDefined("noshadowseq") )
178 loadMode |= gdcm::LD_NOSHADOWSEQ;
181 if ( am->ArgMgrDefined("noshadow") )
182 loadMode |= gdcm::LD_NOSHADOW;
183 if ( am->ArgMgrDefined("noseq") )
184 loadMode |= gdcm::LD_NOSEQ;
187 int level = am->ArgMgrGetInt("level", 1);
190 uint16_t *elemsToForceLoad
191 = am->ArgMgrGetXInt16Enum("forceload", &forceLoadNb);
193 bool showlut = ( 0 != am->ArgMgrDefined("SHOWLUT") );
195 bool ddict = am->ArgMgrDefined("dict") ? true : false;
200 dict = am->ArgMgrGetString("dict",(char *)0);
203 /* if unused Param we give up */
204 if ( am->ArgMgrPrintUnusedLabels() )
206 am->ArgMgrUsage(usage);
211 delete am; // we don't need Argument Manager any longer
213 // ----------- End Arguments Manager ---------
218 gdcm::Global::GetDicts()->GetDefaultPubDict()->AddDict(dict);
221 if ( fileName != 0 ) // ====== Deal with a single file ======
223 gdcm::File *f = gdcm::File::New();
224 f->SetLoadMode(loadMode);
225 f->SetFileName( fileName );
227 for (int ri=0; ri<forceLoadNb; ri++)
229 f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
230 (uint32_t)elemsToForceLoad[2*ri+1] );
233 bool res = f->Load();
234 // gdcm::File::IsReadable() is no usable here, because we deal with
235 // any kind of gdcm-Parsable *document*
236 // not only gdcm::File (as opposed to gdcm::DicomDir)
239 std::cout << "Cannot process file [" << fileName << "]" << std::endl;
240 std::cout << "Either it doesn't exist, or it's read protected "
242 std::cout << "or it's not a Dicom File, or its 'header' is bugged"
244 std::cout << "use 'PrintFile filein=... debug' to try to guess the pb"
250 gdcm::FileHelper *fh = gdcm::FileHelper::New(f);
251 fh->SetPrintLevel( level );
255 std::cout << "\n\n" << std::endl;
257 std::cout <<std::endl;
258 std::cout <<" dataSize " << fh->GetImageDataSize() << std::endl;
259 std::cout <<" dataSizeRaw " << fh->GetImageDataRawSize() << std::endl;
261 int nX,nY,nZ,sPP,planarConfig;
262 std::string pixelType;
266 std::cout << " DIMX=" << nX << " DIMY=" << nY << " DIMZ=" << nZ
269 pixelType = f->GetPixelType();
270 sPP = f->GetSamplesPerPixel();
271 std::cout << " pixelType= [" << pixelType
272 << "] SamplesPerPixel= [" << sPP
277 planarConfig = f->GetPlanarConfiguration();
278 std::cout << " PlanarConfiguration= [" << planarConfig
281 std::cout << " PhotometricInterpretation= ["
282 << f->GetEntryString(0x0028,0x0004)
285 int numberOfScalarComponents=f->GetNumberOfScalarComponents();
286 std::cout << " NumberOfScalarComponents = " << numberOfScalarComponents
288 << " LUT = " << (f->HasLUT() ? "TRUE" : "FALSE")
291 if ( f->GetDataEntry(0x0002,0x0010) )
292 if ( f->GetDataEntry(0x0002,0x0010)->IsNotLoaded() )
294 std::cout << "Transfer Syntax not loaded. " << std::endl
295 << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE"
301 std::string transferSyntaxName = f->GetTransferSyntaxName();
302 std::cout << " TransferSyntaxName= [" << transferSyntaxName << "]"
304 std::cout << " SwapCode= " << f->GetSwapCode() << std::endl;
305 std::cout << " ------" << std::endl;
307 //std::cout << "\n\n" << std::endl;
308 //std::cout << "X spacing " << f->GetXSpacing() << std::endl;
309 //std::cout << "Y spacing " << f->GetYSpacing() << std::endl;
310 //std::cout << "Z spacing " << f->GetZSpacing() << std::endl;
312 //------------------------------
313 // Lets's get and print some usefull fields about 'Orientation'
314 // ------------------------------------------------------------
316 std::string strPatientPosition =
317 f->GetEntryString(0x0018,0x5100);
318 if ( strPatientPosition != gdcm::GDCM_UNFOUND
319 && strPatientPosition != "" )
320 std::cout << "PatientPosition (0x0010,0x5100)= ["
321 << strPatientPosition << "]" << std::endl;
323 std::string strViewPosition =
324 f->GetEntryString(0x0018,0x5101);
325 if ( strViewPosition != gdcm::GDCM_UNFOUND
326 && strViewPosition != "" )
327 std::cout << "strViewPosition (0x0010,0x5101)= ["
328 << strViewPosition << "]" << std::endl;
330 std::string strPatientOrientation =
331 f->GetEntryString(0x0020,0x0020);
332 if ( strPatientOrientation != gdcm::GDCM_UNFOUND
333 && strPatientOrientation != "")
334 std::cout << "PatientOrientation (0x0020,0x0020)= ["
335 << strPatientOrientation << "]" << std::endl;
337 std::string strImageOrientationPatient =
338 f->GetEntryString(0x0020,0x0037);
339 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
340 && strImageOrientationPatient != "" )
341 std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
342 << strImageOrientationPatient << "]" << std::endl;
344 std::string strImageOrientationRET =
345 f->GetEntryString(0x0020,0x0035);
346 if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
347 && strImageOrientationRET != "" )
348 std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
349 << strImageOrientationRET << "]" << std::endl;
351 // Let's compute 'user friendly' results about 'Orientation'
352 // ---------------------------------------------------------
354 gdcm::Orientation *o = gdcm::Orientation::New();
356 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
357 strImageOrientationRET != gdcm::GDCM_UNFOUND )
360 gdcm::OrientationType orient = o->GetOrientationType( f );
362 std::cout << "TypeOrientation = " << orient << " (-> "
363 << o->GetOrientationTypeString(orient) << " )" << std::endl;
366 std::string ori = o->GetOrientation ( f );
368 std::cout << "Orientation [" << ori << "]" << std::endl;
370 o->gdcm::Orientation::Delete();
371 //------------------------------
374 // Display the LUT as an int array (for debugging purpose)
375 if ( f->HasLUT() && showlut )
377 uint8_t* lutrgba = fh->GetLutRGBA();
380 std::cout << "Lut RGBA (Palette Color) not built " << std::endl;
382 // Nothing is written yet to get LUT Data user friendly
383 // The following is to be moved into a PixelRedaConvert method
385 gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
388 gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
391 std::string lutDescriptor = sqi->GetEntryString(0x0028,0x3002);
392 int length; // LUT length in Bytes
393 int deb; // Subscript of the first Lut Value
394 int nbits; // Lut item size (in Bits)
395 int nbRead; // nb of items in LUT descriptor (must be = 3)
397 nbRead = sscanf( lutDescriptor.c_str(),
399 &length, &deb, &nbits );
402 //gdcmWarningMacro( "Wrong LUT descriptor" );
403 std::cout << "Wrong LUT descriptor" << std::endl;
405 gdcm::DataEntry *b = sqi->GetDataEntry(0x0028,0x3006);
408 if ( b->GetLength() != 0 )
410 std::cout << "---------------------------------------"
411 << " We should never reach this point "
413 //LoadEntryBinArea(b); //LUT Data (CTX dependent)
419 std::cout << "No LUT Data (0x0028,0x3000) found " << std::endl;
423 if ( fh->GetLutItemSize() == 8 )
425 for (int i=0;i<fh->GetLutItemNumber();i++)
426 std::cout << i << " : \t"
427 << (int)(lutrgba[i*4]) << " "
428 << (int)(lutrgba[i*4+1]) << " "
429 << (int)(lutrgba[i*4+2]) << std::endl;
431 else // LutItemSize assumed to be = 16
433 uint16_t* lutrgba16 = (uint16_t*)lutrgba;
434 for (int i=0;i<fh->GetLutItemNumber();i++)
435 std::cout << i << " : \t"
436 << (int)(lutrgba16[i*4]) << " "
437 << (int)(lutrgba16[i*4+1]) << " "
438 << (int)(lutrgba16[i*4+2]) << std::endl;
444 std::cout << "Try LUT Data "<< std::endl;
448 // Parsability of the gdcm::Document already checked, after Load() !
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 // ---------------------------------------------------------
565 gdcm::Orientation *o = gdcm::Orientation::New();
568 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
569 strImageOrientationRET != gdcm::GDCM_UNFOUND )
572 gdcm::OrientationType orient = o->GetOrientationType( f );
574 std::cout << "TypeOrientation = " << orient << " (-> "
575 << o->GetOrientationTypeString(orient) << " )" << std::endl;
578 std::string ori = o->GetOrientation ( f );
580 std::cout << "Orientation [" << ori << "]" << std::endl;
582 o->gdcm::Orientation::Delete();
584 //-------------------------------
587 std::cout <<std::endl<<it->c_str()<<" is Readable"<<std::endl;
589 std::cout <<std::endl<<it->c_str()<<" is NOT Readable"<<std::endl;
590 std::cout << "\n\n" << std::endl;
594 std::cout<<std::flush;