1 /*=========================================================================
4 Module: $RCSfile: TestAllReadCompareDicom.cxx,v $
6 Date: $Date: 2005/03/31 08:06:21 $
7 Version: $Revision: 1.33 $
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"
26 #include "gdcmDataImages.h"
29 * /brief File Read/Writer specific for the TestAllReadCompareDicom test
30 * /remarks The Test file format is (only in little endian) :
35 * - 2 bytes : scalar size (8,16,32)
36 * - 2 bytes : number of components per pixel (1,2,3)
45 bool IsReadable(void) {return readable;}
46 int GetXSize(void) {return sizeX;};
47 void SetXSize(int size) {sizeX = size;};
48 int GetYSize(void) {return sizeY;};
49 void SetYSize(int size) {sizeY = size;};
50 int GetZSize(void) {return sizeZ;};
51 void SetZSize(int size) {sizeZ = size;};
52 int GetScalarSize(void) {return scalarSize;};
53 void SetScalarSize(int size) {scalarSize = size;};
54 int GetNumberOfComponents(void) {return components;};
55 void SetNumberOfComponents(int size) {components = size;};
57 unsigned long GetDataSize(void) {return GetLineSize()*sizeY*sizeZ;}
58 uint8_t *GetData(void) {return data;}
59 void SetData(const uint8_t *newData);
61 void Load(const std::string &filename);
62 void Write(const std::string &filename);
65 unsigned long GetLineSize(void) {return sizeX*scalarSize*components;}
66 int GetSwapCode(uint32_t tag);
69 void DeleteData(void);
72 bool ReadFileHeader(std::ifstream *fp);
73 bool ReadFileData(std::ifstream *fp);
75 bool WriteFileHeader(std::ofstream *fp);
76 bool WriteFileData(std::ofstream *fp);
78 uint8_t ReadInt8 (std::ifstream *fp) throw( std::ios::failure );
79 uint16_t ReadInt16(std::ifstream *fp) throw( std::ios::failure );
80 uint32_t ReadInt32(std::ifstream *fp) throw( std::ios::failure );
81 void WriteInt8 (std::ofstream *fp,uint8_t value);
82 void WriteInt16(std::ofstream *fp,uint16_t value);
83 void WriteInt32(std::ofstream *fp,uint32_t value);
96 static const unsigned int HEADER_SIZE;
99 const unsigned int TestFile::HEADER_SIZE = 20;
101 TestFile::TestFile(void)
116 TestFile::~TestFile(void)
121 void TestFile::SetData(const uint8_t *newData)
126 memcpy(data,newData,GetDataSize());
129 void TestFile::Load(const std::string &filename)
135 void TestFile::Write(const std::string &filename)
141 int TestFile::GetSwapCode(uint32_t tag)
146 switch(tag&0x000000FF)
168 void TestFile::NewData(void)
171 if( GetDataSize() == 0 )
173 data = new uint8_t[GetDataSize()];
176 void TestFile::DeleteData(void)
183 void TestFile::ReadFile(void)
186 std::ifstream fp(fileName.c_str(),std::ios::in | std::ios::binary);
196 readable=ReadFileHeader(&fp);
199 std::cout << "Problems when reading Header part" << std::endl;
204 readable=ReadFileData(&fp);
207 std::cout << "Problems when reading datas" << std::endl;
222 bool TestFile::ReadFileHeader(std::ifstream *fp)
224 uint32_t tag = ReadInt32(fp);
225 swapCode = GetSwapCode(tag);
228 std::cout << "TestFile: Bad tag - Must be 'gdcm'" << std::endl;
232 sizeX = ReadInt32(fp); // Size X
233 sizeY = ReadInt32(fp); // Size Y
234 sizeZ = ReadInt32(fp); // Size Z
235 scalarSize = ReadInt16(fp)/8; // bits per scalar
236 components = ReadInt16(fp); // Number of components
241 bool TestFile::ReadFileData(std::ifstream *fp)
251 fp->read((char *)data,GetDataSize());
256 void TestFile::WriteFile(void)
258 std::ofstream fp(fileName.c_str(),std::ios::out | std::ios::binary);
266 WriteFileHeader(&fp);
272 bool TestFile::WriteFileHeader(std::ofstream *fp)
274 WriteInt8(fp,'g'); // Bitmap tag - must be 'g'
275 WriteInt8(fp,'d'); // Bitmap tag - must be 'd'
276 WriteInt8(fp,'c'); // Bitmap tag - must be 'c'
277 WriteInt8(fp,'m'); // Bitmap tag - must be 'm'
278 WriteInt32(fp,sizeX); // Size X
279 WriteInt32(fp,sizeY); // Size Y
280 WriteInt32(fp,sizeZ); // Size Z
281 WriteInt16(fp,scalarSize*8); // bits per scalar
282 WriteInt16(fp,components); // number of components
287 bool TestFile::WriteFileData(std::ofstream *fp)
289 fp->write((char *)data,GetDataSize());
294 uint8_t TestFile::ReadInt8 (std::ifstream *fp)
295 throw( std::ios::failure )
298 fp->read ((char*)&g, (size_t)1);
300 throw std::ios::failure( "TestFile::ReadInt8() - file error." );
302 throw std::ios::failure( "TestFile::ReadInt8() - EOF." );
306 uint16_t TestFile::ReadInt16(std::ifstream *fp)
307 throw( std::ios::failure )
310 fp->read ((char*)&g, (size_t)2);
312 throw std::ios::failure( "TestFile::ReadInt16() - file error." );
314 throw std::ios::failure( "TestFile::ReadInt16() - EOF." );
316 #if defined(GDCM_WORDS_BIGENDIAN)
317 g = ( g << 8 | g >> 8 );
322 uint32_t TestFile::ReadInt32(std::ifstream *fp)
323 throw( std::ios::failure )
326 fp->read ((char*)&g, (size_t)4);
328 throw std::ios::failure( "TestFile::ReadInt32() - file error." );
330 throw std::ios::failure( "TestFile::ReadInt32() - EOF." );
332 #if defined(GDCM_WORDS_BIGENDIAN)
333 g = ( (g<<24) | ((g<<8) & 0x00ff0000) |
334 ( (g>>8) & 0x0000ff00) | (g>>24) );
339 void TestFile::WriteInt8 (std::ofstream *fp,uint8_t value)
341 fp->write((char*)&value, (size_t)1);
344 void TestFile::WriteInt16(std::ofstream *fp,uint16_t value)
346 #if defined(GDCM_WORDS_BIGENDIAN)
347 value = ( value << 8 | value >> 8 );
349 fp->write((char*)&value, (size_t)2);
352 void TestFile::WriteInt32(std::ofstream *fp,uint32_t value)
354 #if defined(GDCM_WORDS_BIGENDIAN)
355 value = ( (value<<24) | ((value<<8) & 0x00ff0000) |
356 ( (value>>8) & 0x0000ff00) | (value>>24) );
358 fp->write((char*)&value, (size_t)4);
361 int InternalTest(std::string const &filename,
362 std::string const &referenceFileName )
364 std::cout << " Testing: " << filename << std::endl;
369 gdcm::FileHelper *tested = new gdcm::FileHelper( filename );
370 if( !tested->GetFile()->IsReadable() )
372 std::cout << " Failed" << std::endl
373 << " Image not gdcm compatible:"
374 << filename << std::endl;
380 ////// Check for existence of reference baseline dicom file:
383 TestFile *reference = new TestFile();
384 std::ifstream refFile(referenceFileName.c_str(),
385 std::ios::binary|std::ios::in);
388 std::cout << " Failed" << std::endl
389 << " Image not found:"
390 << referenceFileName << std::endl;
391 reference->SetXSize(tested->GetFile()->GetXSize());
392 reference->SetYSize(tested->GetFile()->GetYSize());
393 reference->SetZSize(tested->GetFile()->GetZSize());
394 reference->SetScalarSize(tested->GetFile()->GetPixelSize());
395 reference->SetNumberOfComponents(tested->GetFile()->GetNumberOfScalarComponents());
396 reference->SetData(tested->GetImageData());
397 reference->Write(referenceFileName);
402 reference->Load(referenceFileName);
403 if(!reference->IsReadable())
405 std::cout << " Failed" << std::endl
406 << " Image not Testing compatible:"
407 << filename << std::endl;
414 std::string PixelType = tested->GetFile()->GetPixelType();
416 int testedDataSize = tested->GetImageDataSize();
417 uint8_t *testedImageData = tested->GetImageData();
419 int referenceDataSize = reference->GetDataSize();
420 uint8_t *referenceImageData = reference->GetData();
422 // Test the image size
423 if (tested->GetFile()->GetXSize() != reference->GetXSize() ||
424 tested->GetFile()->GetYSize() != reference->GetYSize() ||
425 tested->GetFile()->GetZSize() != reference->GetZSize())
427 std::cout << "Failed" << std::endl
429 << "X: " << tested->GetFile()->GetXSize() << " # "
430 << reference->GetXSize() << " | "
431 << "Y: " << tested->GetFile()->GetYSize() << " # "
432 << reference->GetYSize() << " | "
433 << "Z: " << tested->GetFile()->GetZSize() << " # "
434 << reference->GetZSize() << std::endl;
440 // Test the pixel size
441 if (tested->GetFile()->GetPixelSize() != reference->GetScalarSize() ||
442 tested->GetFile()->GetNumberOfScalarComponents() != reference->GetNumberOfComponents())
444 std::cout << "Failed" << std::endl
445 << " Pixel size differs: " << std::endl
446 << " Scalar size: " << tested->GetFile()->GetPixelSize() << " # "
447 << reference->GetScalarSize() << std::endl
448 << " Number of scalar: " << tested->GetFile()->GetNumberOfScalarComponents() << " # "
449 << reference->GetNumberOfComponents() << std::endl;
455 // Test the data size
456 if (testedDataSize != referenceDataSize)
458 std::cout << " Failed" << std::endl
461 <<") areas lengths differ: "
462 << testedDataSize << " # " << referenceDataSize
465 << tested->GetFile()->GetXSize() << ","
466 << tested->GetFile()->GetYSize() << ","
467 << tested->GetFile()->GetZSize() << ")"
474 // Test the data content
475 if (int res = memcmp(testedImageData, referenceImageData,
476 testedDataSize) != 0 )
479 std::cout << " Failed" << std::endl
482 << ") differ (as expanded in memory)."
489 //////////////// Clean up:
493 std::cout << "OK." << std::endl;
498 int TestAllReadCompareDicom(int argc, char *argv[])
502 // The test is specified a specific filename, use it instead of looping
504 const std::string input = argv[1];
505 const std::string reference = argv[2];
506 return InternalTest( input, reference );
508 else if ( argc > 3 || argc == 2 )
510 std::cerr << " Usage: " << argv[0]
511 << " (no arguments needed)." << std::endl;
512 std::cerr << "or Usage: " << argv[0]
513 << " filename.dcm reference.dcm" << std::endl;
518 std::cout << " Description (Test::TestAllReadCompareDicom): "
520 std::cout << " For all images in gdcmData (and not blacklisted in "
521 "Test/CMakeLists.txt)"
523 std::cout << " apply the following to each filename.xxx: "
525 std::cout << " step 1: parse the image (as gdcmFile) and call"
528 std::cout << " step 2: find in GDCM_DATA_ROOT/BaselineDicom/filename.dcm"
530 << " (with format DICOM V3, explicit Value"
533 std::cout << " step 3a: when image NOT found on step 2, write "
535 << " GDCM_DATA_ROOT/BaselineDicom/filename.dcm"
537 << " (with format DICOM V3, explicit Value"
540 std::cout << " step 3b: when image found on step 2, and when IsReadable()"
542 << " compare it (in memory with memcmp) with the"
544 << " image we are testing (the one of step 1). "
545 << std::endl << std::endl;
549 while( gdcmDataImages[i] != 0 )
551 ////// Check for existence of reference baseline directory
553 std::string baseLineDir = GDCM_DATA_ROOT;
554 baseLineDir += "/BaselineDicom/";
556 if( !gdcm::DirList::IsDirectory(baseLineDir) )
558 std::cerr << " The reference baseline directory " << std::endl
560 << baseLineDir << std::endl
561 << " couldn't be opened."
566 ////// Step 1 (see above description):
567 std::string filename = GDCM_DATA_ROOT;
569 filename += gdcmDataImages[i];
571 std::string referenceFileName = baseLineDir + gdcmDataImages[i++];
572 std::string::size_type slash_pos = referenceFileName.rfind( "." );
573 if( slash_pos != std::string::npos )
575 referenceFileName.replace( slash_pos + 1, 3, "tst" );
578 if( InternalTest( filename, referenceFileName ) != 0 )