1 /*=========================================================================
4 Module: $RCSfile: TestAllReadCompareDicom.cxx,v $
6 Date: $Date: 2005/04/27 09:14:06 $
7 Version: $Revision: 1.40 $
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"
27 #include "gdcmDataImages.h"
30 * /brief File Read/Writer specific for the TestAllReadCompareDicom test
31 * /remarks The Test file format is (only in little endian) :
36 * - 2 bytes : scalar size (8,16,32)
37 * - 2 bytes : number of components per pixel (1,2,3)
46 bool IsReadable(void) {return readable;}
47 int GetXSize(void) {return sizeX;};
48 void SetXSize(int size) {sizeX = size;};
49 int GetYSize(void) {return sizeY;};
50 void SetYSize(int size) {sizeY = size;};
51 int GetZSize(void) {return sizeZ;};
52 void SetZSize(int size) {sizeZ = size;};
53 int GetScalarSize(void) {return scalarSize;};
54 void SetScalarSize(int size) {scalarSize = size;};
55 int GetNumberOfComponents(void) {return components;};
56 void SetNumberOfComponents(int size) {components = size;};
58 unsigned long GetDataSize(void) {return GetLineSize()*sizeY*sizeZ;}
59 uint8_t *GetData(void) {return data;}
60 void SetData(const uint8_t *newData);
62 void Load(const std::string &filename);
63 void Write(const std::string &filename);
66 unsigned long GetLineSize(void) {return sizeX*scalarSize*components;}
67 int GetSwapCode(uint32_t tag);
70 void DeleteData(void);
73 bool ReadFileHeader(std::ifstream *fp);
74 bool ReadFileData(std::ifstream *fp);
76 bool WriteFileHeader(std::ofstream *fp);
77 bool WriteFileData(std::ofstream *fp);
79 uint8_t ReadInt8 (std::ifstream *fp)
80 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
81 throw( std::ios::failure );
85 uint16_t ReadInt16(std::ifstream *fp)
86 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
87 throw( std::ios::failure );
91 uint32_t ReadInt32(std::ifstream *fp)
92 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
93 throw( std::ios::failure );
97 void WriteInt8 (std::ofstream *fp,uint8_t value);
98 void WriteInt16(std::ofstream *fp,uint16_t value);
99 void WriteInt32(std::ofstream *fp,uint32_t value);
101 std::string fileName;
112 static const unsigned int HEADER_SIZE;
115 const unsigned int TestFile::HEADER_SIZE = 20;
117 TestFile::TestFile(void)
132 TestFile::~TestFile(void)
137 void TestFile::SetData(const uint8_t *newData)
142 memcpy(data,newData,GetDataSize());
145 void TestFile::Load(const std::string &filename)
151 void TestFile::Write(const std::string &filename)
157 int TestFile::GetSwapCode(uint32_t tag)
162 switch(tag&0x000000FF)
184 void TestFile::NewData(void)
187 if( GetDataSize() == 0 )
189 data = new uint8_t[GetDataSize()];
192 void TestFile::DeleteData(void)
199 void TestFile::ReadFile(void)
202 std::ifstream fp(fileName.c_str(),std::ios::in | std::ios::binary);
212 readable=ReadFileHeader(&fp);
215 std::cout << "Problems when reading Header part" << std::endl;
220 readable=ReadFileData(&fp);
223 std::cout << "Problems when reading datas" << std::endl;
238 bool TestFile::ReadFileHeader(std::ifstream *fp)
240 uint32_t tag = ReadInt32(fp);
241 swapCode = GetSwapCode(tag);
244 std::cout << "TestFile: Bad tag - Must be 'gdcm'" << std::endl;
248 sizeX = ReadInt32(fp); // Size X
249 sizeY = ReadInt32(fp); // Size Y
250 sizeZ = ReadInt32(fp); // Size Z
251 scalarSize = ReadInt16(fp)/8; // bits per scalar
252 components = ReadInt16(fp); // Number of components
257 bool TestFile::ReadFileData(std::ifstream *fp)
267 fp->read((char *)data,GetDataSize());
272 void TestFile::WriteFile(void)
274 std::ofstream fp(fileName.c_str(),std::ios::out | std::ios::binary);
282 WriteFileHeader(&fp);
288 bool TestFile::WriteFileHeader(std::ofstream *fp)
290 WriteInt8(fp,'g'); // Bitmap tag - must be 'g'
291 WriteInt8(fp,'d'); // Bitmap tag - must be 'd'
292 WriteInt8(fp,'c'); // Bitmap tag - must be 'c'
293 WriteInt8(fp,'m'); // Bitmap tag - must be 'm'
294 WriteInt32(fp,sizeX); // Size X
295 WriteInt32(fp,sizeY); // Size Y
296 WriteInt32(fp,sizeZ); // Size Z
297 WriteInt16(fp,scalarSize*8); // bits per scalar
298 WriteInt16(fp,components); // number of components
303 bool TestFile::WriteFileData(std::ofstream *fp)
305 fp->write((char *)data,GetDataSize());
310 uint8_t TestFile::ReadInt8 (std::ifstream *fp)
311 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
312 throw( std::ios::failure )
316 fp->read ((char*)&g, (size_t)1);
317 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
319 throw std::ios::failure( "TestFile::ReadInt8() - file error." );
321 throw std::ios::failure( "TestFile::ReadInt8() - EOF." );
326 uint16_t TestFile::ReadInt16(std::ifstream *fp)
327 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
328 throw( std::ios::failure )
332 fp->read ((char*)&g, (size_t)2);
333 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
335 throw std::ios::failure( "TestFile::ReadInt16() - file error." );
337 throw std::ios::failure( "TestFile::ReadInt16() - EOF." );
340 #if defined(GDCM_WORDS_BIGENDIAN)
341 g = ( g << 8 | g >> 8 );
346 uint32_t TestFile::ReadInt32(std::ifstream *fp)
347 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
348 throw( std::ios::failure )
352 fp->read ((char*)&g, (size_t)4);
353 #if !(__GNUC__==2 && __GNUC_MINOR__<=96)
355 throw std::ios::failure( "TestFile::ReadInt32() - file error." );
357 throw std::ios::failure( "TestFile::ReadInt32() - EOF." );
360 #if defined(GDCM_WORDS_BIGENDIAN)
361 g = ( (g<<24) | ((g<<8) & 0x00ff0000) |
362 ( (g>>8) & 0x0000ff00) | (g>>24) );
367 void TestFile::WriteInt8 (std::ofstream *fp,uint8_t value)
369 fp->write((char*)&value, (size_t)1);
372 void TestFile::WriteInt16(std::ofstream *fp,uint16_t value)
374 #if defined(GDCM_WORDS_BIGENDIAN)
375 value = ( value << 8 | value >> 8 );
377 fp->write((char*)&value, (size_t)2);
380 void TestFile::WriteInt32(std::ofstream *fp,uint32_t value)
382 #if defined(GDCM_WORDS_BIGENDIAN)
383 value = ( (value<<24) | ((value<<8) & 0x00ff0000) |
384 ( (value>>8) & 0x0000ff00) | (value>>24) );
386 fp->write((char*)&value, (size_t)4);
389 int InternalTest(std::string const &filename,
390 std::string const &referenceFileName )
392 std::cout << " Testing: " << filename << std::endl;
397 gdcm::FileHelper *tested = new gdcm::FileHelper( filename );
398 if( !tested->GetFile()->IsReadable() )
400 std::cout << " Failed" << std::endl
401 << " Image not gdcm compatible:"
402 << filename << std::endl;
408 ////// Check for existence of reference baseline dicom file:
411 TestFile *reference = new TestFile();
412 std::ifstream refFile(referenceFileName.c_str(),
413 std::ios::binary|std::ios::in);
416 std::cout << " Failed" << std::endl
417 << " Image not found:"
418 << referenceFileName << std::endl;
419 reference->SetXSize(tested->GetFile()->GetXSize());
420 reference->SetYSize(tested->GetFile()->GetYSize());
421 reference->SetZSize(tested->GetFile()->GetZSize());
422 reference->SetScalarSize(tested->GetFile()->GetPixelSize());
423 reference->SetNumberOfComponents(tested->GetFile()->GetNumberOfScalarComponents());
424 reference->SetData(tested->GetImageData());
425 reference->Write(referenceFileName);
430 reference->Load(referenceFileName);
431 if(!reference->IsReadable())
433 std::cout << " Failed" << std::endl
434 << " Image not Testing compatible:"
435 << filename << std::endl;
442 std::string PixelType = tested->GetFile()->GetPixelType();
444 int testedDataSize = tested->GetImageDataSize();
445 uint8_t *testedImageData = tested->GetImageData();
447 int referenceDataSize = reference->GetDataSize();
448 uint8_t *referenceImageData = reference->GetData();
450 // Test the image size
451 if (tested->GetFile()->GetXSize() != reference->GetXSize() ||
452 tested->GetFile()->GetYSize() != reference->GetYSize() ||
453 tested->GetFile()->GetZSize() != reference->GetZSize())
455 std::cout << "Failed" << std::endl
457 << "X: " << tested->GetFile()->GetXSize() << " # "
458 << reference->GetXSize() << " | "
459 << "Y: " << tested->GetFile()->GetYSize() << " # "
460 << reference->GetYSize() << " | "
461 << "Z: " << tested->GetFile()->GetZSize() << " # "
462 << reference->GetZSize() << std::endl;
468 // Test the pixel size
469 if (tested->GetFile()->GetPixelSize() != reference->GetScalarSize() ||
470 tested->GetFile()->GetNumberOfScalarComponents() != reference->GetNumberOfComponents())
472 std::cout << "Failed" << std::endl
473 << " Pixel size differs: " << std::endl
474 << " Scalar size: " << tested->GetFile()->GetPixelSize() << " # "
475 << reference->GetScalarSize() << std::endl
476 << " Number of scalar: " << tested->GetFile()->GetNumberOfScalarComponents() << " # "
477 << reference->GetNumberOfComponents() << std::endl;
483 // Test the data size
484 if (testedDataSize != referenceDataSize)
486 std::cout << " Failed" << std::endl
489 <<") areas lengths differ: "
490 << testedDataSize << " # " << referenceDataSize
493 << tested->GetFile()->GetXSize() << ","
494 << tested->GetFile()->GetYSize() << ","
495 << tested->GetFile()->GetZSize() << ")"
502 // Test the data content
503 if (int res = memcmp(testedImageData, referenceImageData,
504 testedDataSize) != 0 )
507 std::string ts = tested->GetFile()->GetTransferSyntax();
509 std::cout << " Failed" << std::endl
512 << ") differ (as expanded in memory)."
515 << gdcm::Global::GetTS()->GetValue(ts) << std::endl;
517 std::cout << " list of pixels differing (pos : test - ref) :"
519 for(int i=0;i<testedDataSize;i++)
521 if(testedImageData[i]!=referenceImageData[i])
522 std::cout << std::hex << "(" << i << " : "
523 << std::hex << (int)(testedImageData[i]) << " - "
524 << std::hex << (int)(referenceImageData[i]) << ") "
527 std::cout << std::endl;
534 //////////////// Clean up:
538 std::cout << "OK." << std::endl;
543 int TestAllReadCompareDicom(int argc, char *argv[])
547 // The test is specified a specific filename, use it instead of looping
549 const std::string input = argv[1];
550 const std::string reference = argv[2];
551 return InternalTest( input, reference );
553 else if ( argc > 3 || argc == 2 )
555 std::cerr << " Usage: " << argv[0]
556 << " (no arguments needed)." << std::endl;
557 std::cerr << "or Usage: " << argv[0]
558 << " filename.dcm reference.dcm" << std::endl;
563 std::cout << " Description (Test::TestAllReadCompareDicom): "
565 std::cout << " For all images in gdcmData (and not blacklisted in "
566 "Test/CMakeLists.txt)"
568 std::cout << " apply the following to each filename.xxx: "
570 std::cout << " step 1: parse the image (as gdcmFile) and call"
573 std::cout << " step 2: find in GDCM_DATA_ROOT/BaselineDicom/filename.tst"
575 << " special internal file format containing the"
577 << " caracteristic of the image and the pixel datas "
578 << "(uncompressed). This file is written if it's not found."
580 std::cout << " step 3: compare the DICOM image with the reference image"
582 << " (.tst file). The test is made on the caracteristics"
584 << " of the image and the pixel datas"
585 << std::endl << std::endl;
589 while( gdcmDataImages[i] != 0 )
591 ////// Check for existence of reference baseline directory
593 std::string baseLineDir = GDCM_DATA_ROOT;
594 baseLineDir += "/BaselineDicom";
596 if( !gdcm::DirList::IsDirectory(baseLineDir) )
598 std::cerr << " The reference baseline directory " << std::endl
600 << baseLineDir << std::endl
601 << " couldn't be opened."
606 ////// Step 1 (see above description):
607 std::string filename = GDCM_DATA_ROOT;
609 filename += gdcmDataImages[i];
612 std::string referenceFileName = baseLineDir + gdcmDataImages[i++];
613 std::string::size_type slash_pos = referenceFileName.rfind( "." );
614 if( slash_pos != std::string::npos )
616 referenceFileName.replace( slash_pos + 1, 3, "tst" );
619 if( InternalTest( filename, referenceFileName ) != 0 )