1 /*=========================================================================
4 Module: $RCSfile: PrintFile.cxx,v $
6 Date: $Date: 2005/10/01 19:39:14 $
7 Version: $Revision: 1.61 $
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 "gdcmBinEntry.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"
34 void ShowLutData(gdcm::File *f);
36 void ShowLutData(gdcm::File *f)
38 // Nothing is written yet to get LUT Data user friendly
39 // The following is to be moved into a PixelReadConvert method
40 // Let here, waiting for a clever idea on the way to do it.
42 gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
45 gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
48 std::string lutDescriptor = sqi->GetEntryValue(0x0028,0x3002);
49 if ( /*lutDescriptor == GDCM_UNFOUND*/ 0 )
51 //gdcmWarningMacro( "LUT Descriptor is missing" );
52 std::cout << "LUT Descriptor is missing" << std::endl;
55 int length; // LUT length in Bytes
56 int deb; // Subscript of the first Lut Value
57 int nbits; // Lut item size (in Bits)
59 int nbRead; // nb of items in LUT descriptor (must be = 3)
61 nbRead = sscanf( lutDescriptor.c_str(),
63 &length, &deb, &nbits );
64 std::cout << "length " << length
70 //gdcmWarningMacro( "Wrong LUT descriptor" );
71 std::cout << "Wrong LUT descriptor" << std::endl;
73 //LUT Data (CTX dependent)
74 gdcm::BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
77 int BitsAllocated = f->GetBitsAllocated();
78 if ( BitsAllocated <= 8 )
81 if ( ( nbits == 16 ) && ( BitsAllocated == 8 ) )
83 // when LUT item size is different than pixel size
84 mult = 2; // high byte must be = low byte
88 // See PS 3.3-2003 C.11.1.1.2 p 619
91 uint8_t *lut = b->GetBinArea();
92 for( int i=0; i < length; ++i )
94 std::cout << i+deb << " : \t"
95 << (int) (lut[i*mult + 1]) << std::endl;
100 uint16_t *lut = (uint16_t *)(b->GetBinArea());
101 for( int i=0; i < length; ++i )
103 std::cout << i+deb << " : \t"
104 << (int) (((uint16_t *)lut)[i])
110 std::cout << "No LUT Data BinEntry (0x0028,0x3006) found?!? "
114 std::cout << "No First SQ Item within (0x0028,0x3000) ?!? "
118 std::cout << "No LUT Data SeqEntry (0x0028,0x3000) found "
122 int main(int argc, char *argv[])
126 " \n PrintFile : \n ",
127 " Display the header of a ACR-NEMA/PAPYRUS/DICOM File ",
128 " usage: PrintFile {filein=inputFileName|dirin=inputDirectoryName}[level=n]",
129 " [forceload=listOfElementsToForceLoad] ",
130 " [dict= privateDirectory] ",
131 " [ { [noshadowseq] | [noshadow][noseq] } ] [debug] ",
132 " level = 0,1,2 : depending on the amount of details user wants to see",
133 " listOfElementsToForceLoad : group-elem,g2-e2,... (in hexa, no space)",
134 " of Elements to load whatever their length ",
135 " privateDirectory : source file full path name of Shadow Group elems ",
136 " noshadowseq: user doesn't want to load Private Sequences ",
137 " noshadow : user doesn't want to load Private groups (odd number) ",
138 " noseq : user doesn't want to load Sequences ",
139 " debug : user wants to run the program in 'debug mode' ",
140 " showlut :user wants to display the Palette Color (as an int array) ",
143 // Initialize Arguments Manager
144 gdcm::ArgMgr *am= new gdcm::ArgMgr(argc, argv);
146 if (argc == 1 || am->ArgMgrDefined("usage") )
148 am->ArgMgrUsage(usage); // Display 'usage'
153 char *fileName = am->ArgMgrGetString("filein",(char *)0);
154 char *dirName = am->ArgMgrGetString("dirin",(char *)0);
156 if ( (fileName == 0 && dirName == 0)
158 (fileName != 0 && dirName != 0) )
160 std::cout <<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 = new gdcm::File();
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 = new gdcm::FileHelper(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();
267 planarConfig = f->GetPlanarConfiguration();
269 std::cout << " pixelType= [" << pixelType
270 << "] SamplesPerPixel= [" << sPP
271 << "] PlanarConfiguration= [" << planarConfig
273 << " PhotometricInterpretation= ["
274 << f->GetEntryValue(0x0028,0x0004)
277 int numberOfScalarComponents=f->GetNumberOfScalarComponents();
278 std::cout << " NumberOfScalarComponents = " << numberOfScalarComponents
280 << " LUT = " << (f->HasLUT() ? "TRUE" : "FALSE")
283 if ( f->GetEntryValue(0x0002,0x0010) == gdcm::GDCM_NOTLOADED )
285 std::cout << "Transfer Syntax not loaded. " << std::endl
286 << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE"
291 std::string transferSyntaxName = f->GetTransferSyntaxName();
292 std::cout << " TransferSyntaxName= [" << transferSyntaxName << "]"
294 std::cout << " SwapCode= " << f->GetSwapCode() << std::endl;
295 std::cout << " ------" << std::endl;
296 //std::cout << "\n\n" << std::endl;
297 //std::cout << "X spacing " << f->GetXSpacing() << std::endl;
298 //std::cout << "Y spacing " << f->GetYSpacing() << std::endl;
299 //std::cout << "Z spacing " << f->GetZSpacing() << std::endl;
301 // Lets's get and print some usefull fields about 'Orientation'
302 // ------------------------------------------------------------
304 std::string strPatientPosition =
305 f->GetEntryValue(0x0018,0x5100);
306 if ( strPatientPosition != gdcm::GDCM_UNFOUND
307 && strPatientPosition != "" )
308 std::cout << "PatientPosition (0x0010,0x5100)= ["
309 << strPatientPosition << "]" << std::endl;
311 std::string strPatientOrientation =
312 f->GetEntryValue(0x0020,0x0020);
313 if ( strPatientOrientation != gdcm::GDCM_UNFOUND
314 && strPatientOrientation != "")
315 std::cout << "PatientOrientation (0x0020,0x0020)= ["
316 << strPatientOrientation << "]" << std::endl;
318 std::string strImageOrientationPatient =
319 f->GetEntryValue(0x0020,0x0037);
320 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND
321 && strImageOrientationPatient != "" )
322 std::cout << "ImageOrientationPatient (0x0020,0x0037)= ["
323 << strImageOrientationPatient << "]" << std::endl;
325 std::string strImageOrientationRET =
326 f->GetEntryValue(0x0020,0x0035);
327 if ( strImageOrientationRET != gdcm::GDCM_UNFOUND
328 && strImageOrientationRET != "" )
329 std::cout << "ImageOrientationRET (0x0020,0x0035)= ["
330 << strImageOrientationRET << "]" << std::endl;
332 // Let's compute 'user friendly' results about 'Orientation'
333 // ---------------------------------------------------------
337 if ( strImageOrientationPatient != gdcm::GDCM_UNFOUND ||
338 strImageOrientationRET != gdcm::GDCM_UNFOUND )
341 gdcm::OrientationType orient = o.GetOrientationType( f );
343 std::cout << "TypeOrientation = " << orient << " (-> "
344 << o.GetOrientationTypeString(orient) << " )" << std::endl;
347 std::string ori = o.GetOrientation ( f );
349 std::cout << "Orientation [" << ori << "]" << std::endl;
352 // Display the LUT as an int array (for debugging purpose)
353 if ( f->HasLUT() && showlut )
355 uint8_t* lutrgba = fh->GetLutRGBA();
358 std::cout << "Lut RGBA (Palette Color) not built " << std::endl;
360 // Nothing is written yet to get LUT Data user friendly
361 // The following is to be moved into a PixelRedaConvert method
363 gdcm::SeqEntry *modLutSeq = f->GetSeqEntry(0x0028,0x3000);
366 gdcm::SQItem *sqi= modLutSeq->GetFirstSQItem();
369 std::string lutDescriptor = sqi->GetEntryValue(0x0028,0x3002);
370 int length; // LUT length in Bytes
371 int deb; // Subscript of the first Lut Value
372 int nbits; // Lut item size (in Bits)
373 int nbRead; // nb of items in LUT descriptor (must be = 3)
375 nbRead = sscanf( lutDescriptor.c_str(),
377 &length, &deb, &nbits );
380 //gdcmWarningMacro( "Wrong LUT descriptor" );
381 std::cout << "Wrong LUT descriptor" << std::endl;
383 gdcm::BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
386 if ( b->GetLength() != 0 )
388 std::cout << "---------------------------------------"
389 << " We should never reach this point "
391 //LoadEntryBinArea(b); //LUT Data (CTX dependent)
397 std::cout << "No LUT Data (0x0028,0x3000) found " << std::endl;
401 if ( fh->GetLutItemSize() == 8 )
403 for (int i=0;i<fh->GetLutItemNumber();i++)
404 std::cout << i << " : \t"
405 << (int)(lutrgba[i*4]) << " "
406 << (int)(lutrgba[i*4+1]) << " "
407 << (int)(lutrgba[i*4+2]) << std::endl;
409 else // LutItemSize assumed to be = 16
411 uint16_t* lutrgba16 = (uint16_t*)lutrgba;
412 for (int i=0;i<fh->GetLutItemNumber();i++)
413 std::cout << i << " : \t"
414 << (int)(lutrgba16[i*4]) << " "
415 << (int)(lutrgba16[i*4+1]) << " "
416 << (int)(lutrgba16[i*4+2]) << std::endl;
422 std::cout << "Try LUT Data "<< std::endl;
426 //if( !f->gdcm::Document::IsReadable())
427 // Try downcast to please MSVC
428 if ( !((gdcm::Document *)f)->IsReadable() )
430 std::cout <<std::endl<<fileName<<" is NOT 'gdcm parsable'"<<std::endl;
434 std::cout <<std::endl<<fileName<<" is Readable"<<std::endl;
435 else if ( f->GetSeqEntry(0x0041,0x1010) )
437 std::cout <<std::endl<<fileName<<" looks like a 'PAPYRUS image' file"
440 else if ( f->GetSeqEntry(0x0004,0x1220) )
442 std::cout <<std::endl<<fileName<<" looks like a 'DICOMDIR file'"
447 std::cout <<std::endl<<fileName<<" doesn't look like an image file "
451 std::cout<<std::flush;
456 else // ====== Deal with a Directory ======
458 std::cout << "dirName [" << dirName << "]" << std::endl;
459 gdcm::DirList dirList(dirName,1); // gets recursively the file list
460 gdcm::DirListType fileList = dirList.GetFilenames();
463 for( gdcm::DirListType::iterator it = fileList.begin();
464 it != fileList.end();
467 std::cout << std::endl<<" Start processing :[" << it->c_str() << "]"
469 f = new gdcm::File();
470 f->SetLoadMode(loadMode);
471 f->SetFileName( it->c_str() );
473 for (int ri=0; ri<forceLoadNb; ri++)
475 printf("%04x,%04x\n",elemsToForceLoad[2*ri],
476 elemsToForceLoad[2*ri+1]);
477 f->AddForceLoadElement((uint32_t)elemsToForceLoad[2*ri],
478 (uint32_t)elemsToForceLoad[2*ri+1]);
484 std::cout << "Cannot process file [" << it->c_str() << "]"
486 std::cout << "Either it doesn't exist, or it's read protected "
488 std::cout << "or it's not a Dicom File, or its 'header' is bugged"
490 std::cout << "use 'PrintFile filein=... debug' "
491 << "to try to guess the pb"
497 gdcm::FileHelper *fh = new gdcm::FileHelper(f);
498 fh->SetPrintLevel( level );
502 std::string ori = o.GetOrientation ( f );
503 if (ori != gdcm::GDCM_UNFOUND )
504 std::cout << "- Orientation [" << ori << "]" << std::endl;
506 gdcm::OrientationType d = o.GetOrientationType( f );
508 std::cout << "TypeOrientation = " << d << " (-> "
509 << o.GetOrientationTypeString(d) << std::endl;
512 std::cout <<std::endl<<it->c_str()<<" is Readable"<<std::endl;
514 std::cout <<std::endl<<it->c_str()<<" is NOT Readable"<<std::endl;
515 std::cout << "\n\n" << std::endl;
519 std::cout<<std::flush;