1 /*=========================================================================
4 Module: $RCSfile: TestAllReadCompareDicom.cxx,v $
6 Date: $Date: 2005/11/15 11:43:22 $
7 Version: $Revision: 1.55 $
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 =========================================================================*/
18 #include "gdcmDirList.h"
20 #include "gdcmFileHelper.h"
21 #include "gdcmGlobal.h"
23 #include "gdcmDebug.h"
29 #include "gdcmDataImages.h"
33 //--> The .tst files *must* be generated on a Little Endian based computer.
36 * /brief File Read/Writer specific for the TestAllReadCompareDicom test
37 * /remarks The Test file format is (only in little endian) :
42 * - 2 bytes : scalar size (8,16,32) --> ?!? 1 or 2 only in DICOM V3 !
43 * - 2 bytes : number of components per pixel (1,2,3) ---> 1 or 3 only in DICOMV3 !
52 bool IsReadable() {return readable;}
54 int GetXSize() {return SizeX;}
55 int GetYSize() {return SizeY;}
56 int GetZSize() {return SizeZ;}
58 void SetXSize(int size) {SizeX = size;}
59 void SetYSize(int size) {SizeY = size;}
60 void SetZSize(int size) {SizeZ = size;}
62 int GetScalarSize() {return ScalarSize;}
63 void SetScalarSize(int size) {ScalarSize = size;}
65 int GetNumberOfComponents() {return Components;}
66 void SetNumberOfComponents(int size) {Components = size;}
67 int GetSwapCode() {return SwapCode;}
69 unsigned long GetDataSize() {return GetLineSize()*SizeY*SizeZ;}
70 uint8_t *GetData() {return Data;}
71 void SetData(const uint8_t *newData);
73 void Load(const std::string &filename);
74 void Write(const std::string &filename);
77 unsigned long GetLineSize() {return SizeX*ScalarSize*Components;}
78 int ComputeSwapCode(uint32_t tag);
84 bool ReadFileHeader(std::ifstream *fp);
85 bool ReadFileData(std::ifstream *fp);
87 bool WriteFileHeader(std::ofstream *fp);
88 bool WriteFileData(std::ofstream *fp);
90 uint8_t ReadInt8 (std::ifstream *fp)
91 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
92 throw( std::ios::failure );
96 uint16_t ReadInt16(std::ifstream *fp)
97 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
98 throw( std::ios::failure );
102 uint32_t ReadInt32(std::ifstream *fp)
103 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
104 throw( std::ios::failure );
108 void WriteInt8 (std::ofstream *fp,uint8_t value);
109 void WriteInt16(std::ofstream *fp,uint16_t value);
110 void WriteInt32(std::ofstream *fp,uint32_t value);
112 std::string fileName;
123 static const unsigned int HEADER_SIZE;
126 const unsigned int MAX_NUMBER_OF_DIFFERENCE = 10;
127 const unsigned int TestFile::HEADER_SIZE = 20;
144 TestFile::~TestFile()
149 void TestFile::SetData(const uint8_t *newData)
154 memcpy(Data,newData,GetDataSize());
157 void TestFile::Load(const std::string &filename)
163 void TestFile::Write(const std::string &filename)
169 int TestFile::ComputeSwapCode(uint32_t tag)
171 // FIXME : 100 % useless method !
172 // "gdcm" was written on disc byte per byte.
173 // when you fread if, you'll get *allways* "gdcm"
174 // whatever the processor indianess is !
177 //std::cout << std::hex << "0x(" << tag << ")" << std::dec << std::endl;
181 switch(tag&0x000000FF)
203 void TestFile::NewData()
206 if( GetDataSize() == 0 )
208 Data = new uint8_t[GetDataSize()];
211 void TestFile::DeleteData()
218 void TestFile::ReadFile()
221 std::ifstream fp(fileName.c_str(),std::ios::in | std::ios::binary);
231 readable=ReadFileHeader(&fp);
234 std::cout << "Problems when reading Header part" << std::endl;
239 readable=ReadFileData(&fp);
242 std::cout << "Problems when reading data" << std::endl;
257 bool TestFile::ReadFileHeader(std::ifstream *fp)
259 uint32_t tag = ReadInt32(fp);
260 SwapCode = ComputeSwapCode(tag);
263 std::cout << "TestFile: Bad tag - Must be 'gdcm'" << std::endl;
267 SizeX = ReadInt32(fp); // Size X
268 SizeY = ReadInt32(fp); // Size Y
269 SizeZ = ReadInt32(fp); // Size Z
270 ScalarSize = ReadInt16(fp)/8; // bytes per scalar
271 Components = ReadInt16(fp); // Number of components
276 bool TestFile::ReadFileData(std::ifstream *fp)
286 fp->read((char *)Data,GetDataSize());
288 // Track BigEndian troubles
289 std::cout << " ScalarSize : " << GetScalarSize()
290 << " SwapCode:" << GetSwapCode()
293 //if (GetScalarSize() == 1 || GetSwapCode() == 1234)
294 if (GetScalarSize() == 1 || !gdcm::Util::IsCurrentProcessorBigEndian() )
298 // We *know* the .tst files are written in 'Little Endian' format.
299 // We *know* DataSize may be 1 or 2 !
302 std::cout << " Let's swap Pixels" <<std::endl;
304 for (unsigned int i=0; i<GetDataSize()/2; i++)
306 g = ((uint16_t *)Data)[i];
307 g = ( g << 8 | g >> 8 );
308 ((uint16_t *)Data)[i] = g;
313 void TestFile::WriteFile()
315 std::ofstream fp(fileName.c_str(),std::ios::out | std::ios::binary);
323 WriteFileHeader(&fp);
329 bool TestFile::WriteFileHeader(std::ofstream *fp)
331 WriteInt8(fp,'g'); // Bitmap tag - must be 'g'
332 WriteInt8(fp,'d'); // Bitmap tag - must be 'd'
333 WriteInt8(fp,'c'); // Bitmap tag - must be 'c'
334 WriteInt8(fp,'m'); // Bitmap tag - must be 'm'
336 // FIXME : Think of writting an int32, better !
337 // (('g' << 8 + 'd') << 8 + 'c') + 'm'
338 // if you want to use it to check the endianess.
339 // (and upload again *all* the .tst files ...)
340 WriteInt32(fp,SizeX); // Size X
341 WriteInt32(fp,SizeY); // Size Y
342 WriteInt32(fp,SizeZ); // Size Z
343 WriteInt16(fp,ScalarSize*8); // bits per scalar
344 WriteInt16(fp,Components); // number of components
349 bool TestFile::WriteFileData(std::ofstream *fp)
351 fp->write((char *)Data,GetDataSize());
356 uint8_t TestFile::ReadInt8 (std::ifstream *fp)
357 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
358 throw( std::ios::failure )
362 fp->read ((char*)&g, (size_t)1);
363 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
365 throw std::ios::failure( "TestFile::ReadInt8() - file error." );
367 throw std::ios::failure( "TestFile::ReadInt8() - EOF." );
372 uint16_t TestFile::ReadInt16(std::ifstream *fp)
373 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
374 throw( std::ios::failure )
378 fp->read ((char*)&g, (size_t)2);
379 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
381 throw std::ios::failure( "TestFile::ReadInt16() - file error." );
383 throw std::ios::failure( "TestFile::ReadInt16() - EOF." );
386 #if defined(GDCM_WORDS_BIGENDIAN)
387 g = ( g << 8 | g >> 8 );
392 uint32_t TestFile::ReadInt32(std::ifstream *fp)
393 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
394 throw( std::ios::failure )
398 fp->read ((char*)&g, (size_t)4);
399 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
401 throw std::ios::failure( "TestFile::ReadInt32() - file error." );
403 throw std::ios::failure( "TestFile::ReadInt32() - EOF." );
406 #if defined(GDCM_WORDS_BIGENDIAN)
407 g = ( (g<<24) | ((g<<8) & 0x00ff0000) |
408 ( (g>>8) & 0x0000ff00) | (g>>24) );
413 void TestFile::WriteInt8 (std::ofstream *fp,uint8_t value)
415 fp->write((char*)&value, (size_t)1);
418 void TestFile::WriteInt16(std::ofstream *fp,uint16_t value)
420 #if defined(GDCM_WORDS_BIGENDIAN)
421 value = ( value << 8 | value >> 8 );
423 fp->write((char*)&value, (size_t)2);
426 void TestFile::WriteInt32(std::ofstream *fp,uint32_t value)
428 #if defined(GDCM_WORDS_BIGENDIAN)
429 value = ( (value<<24) | ((value<<8) & 0x00ff0000) |
430 ( (value>>8) & 0x0000ff00) | (value>>24) );
432 fp->write((char*)&value, (size_t)4);
435 int InternalTest(std::string const &filename,
436 std::string const &referenceFileName )
438 std::cout << " Testing: " << filename << std::endl;
445 gdcm::File *f = gdcm::File::New();
446 f->SetLoadMode ( gdcm::LD_ALL ); // Load everything
447 f->SetFileName( filename );
450 if( !f->IsReadable() )
452 std::cout << " Failed" << std::endl
453 << " Image not gdcm compatible:"
454 << filename << std::endl;
458 gdcm::FileHelper *tested = gdcm::FileHelper::New( f );
461 ////// Check for existence of reference baseline dicom file:
464 TestFile *reference = new TestFile();
465 std::ifstream refFile(referenceFileName.c_str(),
466 std::ios::binary|std::ios::in);
469 std::cout << " Failed" << std::endl
470 << " Image not found:"
471 << referenceFileName << std::endl;
472 reference->SetXSize(tested->GetFile()->GetXSize());
473 reference->SetYSize(tested->GetFile()->GetYSize());
474 reference->SetZSize(tested->GetFile()->GetZSize());
475 reference->SetScalarSize(tested->GetFile()->GetPixelSize());
476 reference->SetNumberOfComponents(tested->GetFile()->GetNumberOfScalarComponents());
477 reference->SetData(tested->GetImageData());
478 reference->Write(referenceFileName);
483 reference->Load(referenceFileName);
484 if(!reference->IsReadable())
486 std::cout << " Failed" << std::endl
487 << " Image not Testing compatible:"
488 << filename << std::endl;
496 std::string PixelType = tested->GetFile()->GetPixelType();
498 int testedDataSize = tested->GetImageDataSize();
499 uint8_t *testedImageData = tested->GetImageData();
501 int referenceDataSize = reference->GetDataSize();
502 uint8_t *referenceImageData = reference->GetData();
504 // Test the image size
505 if (tested->GetFile()->GetXSize() != reference->GetXSize() ||
506 tested->GetFile()->GetYSize() != reference->GetYSize() ||
507 tested->GetFile()->GetZSize() != reference->GetZSize())
509 std::cout << "Failed" << std::endl
511 << "X: " << tested->GetFile()->GetXSize() << " # "
512 << reference->GetXSize() << " | "
513 << "Y: " << tested->GetFile()->GetYSize() << " # "
514 << reference->GetYSize() << " | "
515 << "Z: " << tested->GetFile()->GetZSize() << " # "
516 << reference->GetZSize() << std::endl;
523 // Test the pixel size
524 if (tested->GetFile()->GetPixelSize() != reference->GetScalarSize() ||
525 tested->GetFile()->GetNumberOfScalarComponents() != reference->GetNumberOfComponents())
527 std::cout << "Failed" << std::endl
528 << " Pixel size differs: " << std::endl
529 << " Scalar size: " << tested->GetFile()->GetPixelSize() << " # "
530 << reference->GetScalarSize() << std::endl
531 << " Number of scalar: " << tested->GetFile()->GetNumberOfScalarComponents() << " # "
532 << reference->GetNumberOfComponents() << std::endl
533 << " Pixel type: " << tested->GetFile()->GetPixelType() << std::endl;
540 // Test the data size
541 if (testedDataSize != referenceDataSize)
543 std::cout << " Failed" << std::endl
546 <<") areas lengths differ: "
547 << testedDataSize << " # " << referenceDataSize
550 << tested->GetFile()->GetXSize() << ","
551 << tested->GetFile()->GetYSize() << ","
552 << tested->GetFile()->GetZSize() << ")"
560 // Test the data content
561 if ( memcmp(testedImageData, referenceImageData,
562 testedDataSize) != 0 )
564 std::string ts = tested->GetFile()->GetTransferSyntax();
566 std::cout << " Failed" << std::endl
569 << ") differ (as expanded in memory)."
572 << gdcm::Global::GetTS()->GetValue(ts) << std::endl;
574 std::cout << " list of the first " << MAX_NUMBER_OF_DIFFERENCE
575 << " pixels differing (pos : test - ref) :"
579 for(i=0, j=0;i<testedDataSize && j<MAX_NUMBER_OF_DIFFERENCE;i++)
581 if(testedImageData[i]!=referenceImageData[i])
583 std::cout << std::hex << "(" << i << " : "
584 << std::hex << (int)(testedImageData[i]) << " - "
585 << std::hex << (int)(referenceImageData[i]) << ") "
590 std::cout << std::endl;
598 //////////////// Clean up:
603 std::cout << "OK." << std::endl;
608 int TestAllReadCompareDicom(int argc, char *argv[])
610 // Temporarily added, to track BigEndian troubles
611 gdcm::Debug::WarningOn();
614 gdcm::Debug::DebugOn();
618 // The test is specified a specific filename, use it instead of looping
620 const std::string input = argv[1];
621 const std::string reference = argv[2];
622 return InternalTest( input, reference );
624 else if ( argc > 4 || argc == 2 )
626 std::cerr << " Usage: " << argv[0]
627 << " (no arguments needed)." << std::endl;
628 std::cerr << "or Usage: " << argv[0]
629 << " filename.dcm reference.dcm" << std::endl;
634 std::cout << " Description (Test::TestAllReadCompareDicom): "
636 std::cout << " For all images in gdcmData (and not blacklisted in "
637 "Test/CMakeLists.txt)"
639 std::cout << " apply the following to each filename.xxx: "
641 std::cout << " step 1: parse the image (as gdcmFile) and call"
644 std::cout << " step 2: find in GDCM_DATA_ROOT/BaselineDicom/filename.tst"
646 << " special internal file format containing the"
648 << " caracteristic of the image and the pixel data "
649 << "(uncompressed). This file is written if it's not found."
651 std::cout << " step 3: compare the DICOM image with the reference image"
653 << " (.tst file). The test is made on the caracteristics"
655 << " of the image and the pixel data"
656 << std::endl << std::endl;
660 while( gdcmDataImages[i] != 0 )
662 ////// Check for existence of reference baseline directory
664 std::string baseLineDir = GDCM_DATA_ROOT;
665 baseLineDir += "/BaselineDicom";
667 if( !gdcm::DirList::IsDirectory(baseLineDir) )
669 std::cerr << " The reference baseline directory " << std::endl
671 << baseLineDir << std::endl
672 << " couldn't be opened."
677 ////// Step 1 (see above description):
678 std::string filename = GDCM_DATA_ROOT;
680 filename += gdcmDataImages[i];
683 std::string referenceFileName = baseLineDir + gdcmDataImages[i++];
684 std::string::size_type slash_pos = referenceFileName.rfind( "." );
685 if( slash_pos != std::string::npos )
687 referenceFileName.replace( slash_pos + 1, 3, "tst" );
690 if( InternalTest( filename, referenceFileName ) != 0 )