tools/clitkWriteDicomSeriesGenericFilter.txx

   1 /*=========================================================================
   2   Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv
   3
   4   Authors belong to:
   5   - University of LYON              http://www.universite-lyon.fr/
   6   - Léon Bérard cancer center       http://www.centreleonberard.fr
   7   - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr
   8
   9   This software is distributed WITHOUT ANY WARRANTY; without even
  10   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11   PURPOSE.  See the copyright notices for more information.
  12
  13   It is distributed under dual licence
  14
  15   - BSD        See included LICENSE.txt file
  16   - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  17 ===========================================================================**/
  18 #ifndef clitkWriteDicomSeriesGenericFilter_txx
  19 #define clitkWriteDicomSeriesGenericFilter_txx
  20
  21 /* =================================================
  22  * @file   clitkWriteDicomSeriesGenericFilter.txx
  23  * @author
  24  * @date
  25  *
  26  * @brief
  27  *
  28  ===================================================*/
  29
  30 // clitk
  31 #include "clitkResampleImageWithOptionsFilter.h"
  32 #if GDCM_MAJOR_VERSION >= 2
  33 #include "gdcmUIDGenerator.h"
  34 #else
  35 #include "gdcmFile.h"
  36 #include "gdcmUtil.h"
  37 #endif
  38
  39
  40 namespace clitk
  41 {
  42
  43
  44 //-----------------------------------------------------------
  45 // Constructor
  46 //-----------------------------------------------------------
  47 template<class args_info_type>
  48 WriteDicomSeriesGenericFilter<args_info_type>::WriteDicomSeriesGenericFilter()
  49 {
  50   m_Verbose=false;
  51   m_InputFileName="";
  52 }
  53
  54
  55 //-----------------------------------------------------------
  56 // Update
  57 //-----------------------------------------------------------
  58 template<class args_info_type>
  59 void WriteDicomSeriesGenericFilter<args_info_type>::Update()
  60 {
  61   // Read the Dimension and PixelType
  62   int Dimension;
  63   std::string PixelType;
  64   ReadImageDimensionAndPixelType(m_InputFileName, Dimension, PixelType);
  65
  66
  67   // Call UpdateWithDim
  68   if(Dimension==2) UpdateWithDim<2>(PixelType);
  69   else if(Dimension==3) UpdateWithDim<3>(PixelType);
  70   // else if (Dimension==4)UpdateWithDim<4>(PixelType);
  71   else {
  72     std::cout<<"Error, Only for 2 or 3  Dimensions!!!"<<std::endl ;
  73     return;
  74   }
  75 }
  76
  77 //-------------------------------------------------------------------
  78 // Update with the number of dimensions
  79 //-------------------------------------------------------------------
  80 template<class args_info_type>
  81 template<unsigned int Dimension>
  82 void
  83 WriteDicomSeriesGenericFilter<args_info_type>::UpdateWithDim(std::string PixelType)
  84 {
  85   if (m_Verbose) std::cout << "Image was detected to be "<<Dimension<<"D and "<< PixelType<<"..."<<std::endl;
  86
  87   if(PixelType == "short") {
  88     if (m_Verbose) std::cout << "Launching filter in "<< Dimension <<"D and signed short..." << std::endl;
  89     UpdateWithDimAndPixelType<Dimension, signed short>();
  90   }
  91   else if(PixelType == "unsigned_short"){
  92     if (m_Verbose) std::cout  << "Launching filter in "<< Dimension <<"D and unsigned_short..." << std::endl;
  93     UpdateWithDimAndPixelType<Dimension, unsigned short>();
  94   }
  95
  96   else if (PixelType == "unsigned_char") {
  97     if (m_Verbose) std::cout  << "Launching filter in "<< Dimension <<"D and unsigned_char..." << std::endl;
  98     UpdateWithDimAndPixelType<Dimension, unsigned char>();
  99   }
 100
 101   //     else if (PixelType == "char"){
 102   //       if (m_Verbose) std::cout  << "Launching filter in "<< Dimension <<"D and signed_char..." << std::endl;
 103   //       UpdateWithDimAndPixelType<Dimension, signed char>();
 104   //     }
 105   else if (PixelType == "double") {
 106     if (m_Verbose) std::cout  << "Launching filter in "<< Dimension <<"D and double..." << std::endl;
 107     UpdateWithDimAndPixelType<Dimension, double>();
 108   }
 109   else {
 110     if (m_Verbose) std::cout  << "Launching filter in "<< Dimension <<"D and float..." << std::endl;
 111     UpdateWithDimAndPixelType<Dimension, float>();
 112   }
 113 }
 114
 115 //-------------------------------------------------------------------
 116 // Update with the number of dimensions and the pixeltype read from
 117 // the dicom files. The MHD files may be resampled to match the
 118 // dicom spacing (and number of slices). Rounding errors in resampling
 119 // are handled by removing files when generating the output dicom
 120 // series.
 121 //-------------------------------------------------------------------
 122 template<class args_info_type>
 123 template <unsigned int Dimension, class  PixelType>
 124 void
 125 WriteDicomSeriesGenericFilter<args_info_type>::UpdateWithDimAndPixelType()
 126 {
 127
 128   // ImageTypes
 129   typedef itk::Image<PixelType, Dimension> InputImageType;
 130   typedef itk::Image<PixelType, 2> OutputImageType;
 131
 132   // Read the dicom directory
 133   typedef itk::ImageSeriesReader< InputImageType >     ReaderType;
 134   typedef itk::GDCMImageIO ImageIOType;
 135   typedef itk::GDCMSeriesFileNames NamesGeneratorType;
 136
 137   ImageIOType::Pointer gdcmIO = ImageIOType::New();
 138   NamesGeneratorType::Pointer namesGenerator = NamesGeneratorType::New();
 139   namesGenerator->SetInputDirectory( m_ArgsInfo.inputDir_arg );
 140   namesGenerator->SetOutputDirectory( m_ArgsInfo.outputDir_arg  );
 141   typename   ReaderType::FileNamesContainer filenames_in = namesGenerator->GetInputFileNames();
 142   typename   ReaderType::FileNamesContainer filenames_out = namesGenerator->GetOutputFileNames();
 143
 144   // Output the dicom files
 145   unsigned int numberOfFilenames =  filenames_in.size();
 146   if (m_Verbose) {
 147     std::cout << numberOfFilenames <<" were read in the directory "<<m_ArgsInfo.inputDir_arg<<"..."<<std::endl<<std::endl;
 148     for(unsigned int fni = 0; fni<numberOfFilenames; fni++) {
 149       std::cout << "filename # " << fni << " = ";
 150       std::cout << filenames_in[fni] << std::endl;
 151     }
 152   }
 153
 154   // Read the series
 155   typename ReaderType::Pointer reader = ReaderType::New();
 156   reader->SetImageIO( gdcmIO );
 157   reader->SetFileNames( filenames_in );
 158   try {
 159     reader->Update();
 160   } catch (itk::ExceptionObject &excp) {
 161     std::cerr << "Error: Exception thrown while reading the DICOM series!!" << std::endl;
 162     std::cerr << excp << std::endl;
 163   }
 164
 165   // Read the input (MHD file)
 166   typedef typename InputImageType::RegionType RegionType;
 167   typedef typename RegionType::SizeType SizeType;
 168   typedef itk::ImageFileReader<InputImageType> InputReaderType;
 169   typename InputReaderType::Pointer volumeReader = InputReaderType::New();
 170   volumeReader->SetFileName( m_InputFileName);
 171   volumeReader->Update();
 172
 173   typename InputImageType::Pointer input = volumeReader->GetOutput();
 174   if ((!m_ArgsInfo.useSizeAsReference_flag && (input->GetSpacing() != reader->GetOutput()->GetSpacing())) ||
 175       (m_ArgsInfo.useSizeAsReference_flag && (input->GetLargestPossibleRegion().GetSize() != reader->GetOutput()->GetLargestPossibleRegion().GetSize()))) {
 176
 177     // resampling is carried out on the fly if resolution or size between
 178     // the input mhd and input dicom series is different
 179
 180     // Filter
 181     typedef clitk::ResampleImageWithOptionsFilter<InputImageType, InputImageType> ResampleImageFilterType;
 182     typename ResampleImageFilterType::Pointer filter = ResampleImageFilterType::New();
 183     filter->SetInput(input);
 184     filter->SetVerboseOptions(m_Verbose);
 185     filter->SetGaussianFilteringEnabled(false);
 186     filter->SetDefaultPixelValue(0);
 187
 188     if (!m_ArgsInfo.useSizeAsReference_flag) {
 189       filter->SetOutputSpacing(reader->GetOutput()->GetSpacing());
 190       if (m_Verbose) {
 191         std::cout << "Warning: The image spacing differs between the MHD file and the input dicom series. Performing resampling with default options using spacing as reference (for advanced options, use clitkResampleImage)." << std::endl;
 192         std::cout << "MHD -> " << input->GetSpacing() << std::endl;
 193         std::cout << "dicom -> " << reader->GetOutput()->GetSpacing() << std::endl;
 194       }
 195     }
 196     else {
 197       const SizeType& dicom_size = reader->GetOutput()->GetLargestPossibleRegion().GetSize();
 198       SizeType output_size;
 199       for (unsigned int i = 0; i < Dimension; i++)
 200         output_size[i] = dicom_size[i];
 201       filter->SetOutputSize(output_size);
 202       if (m_Verbose) {
 203           std::cout << "Warning: The image size differs between the MHD file and the input dicom series. Performing resampling with default options using size as reference (for advanced options, use clitkResampleImage)." << std::endl;
 204           std::cout << "MHD -> " << input->GetLargestPossibleRegion().GetSize() << std::endl;
 205           std::cout << "dicom -> " << reader->GetOutput()->GetLargestPossibleRegion().GetSize() << std::endl;
 206       }
 207     }
 208
 209     try {
 210       filter->Update();
 211       input = filter->GetOutput();
 212     } catch( itk::ExceptionObject & excp ) {
 213     std::cerr << "Error: Exception thrown while resampling!!" << std::endl;
 214     std::cerr << excp << std::endl;
 215     }
 216   }
 217
 218   //    In some cases, due to resampling approximation issues,
 219   //    the number of slices in the MHD file may be different (smaller)
 220   //    from the number of files in the template dicom directory.
 221   //    To avoid ITK generating an exception, we reduce the number
 222   //    of DCM files to be considered, and a warning is printed
 223   //    in verbose mode
 224   const RegionType volumeRegion = input->GetLargestPossibleRegion();
 225   const SizeType& volumeSize = volumeRegion.GetSize();
 226   if (m_Verbose) {
 227     std::cout << volumeRegion << volumeSize << std::endl;
 228   }
 229   if (Dimension == 3 && volumeSize[2] < numberOfFilenames) {
 230     if (m_Verbose)
 231       std::cout << "Warning: The number of files in " << m_ArgsInfo.inputDir_arg << " (" << filenames_in.size() << " files) is greater than the number of slices in MHD (" << volumeSize[2] << " slices). Using only " << volumeSize[2] << " files." << std::endl;
 232
 233     filenames_in.resize(volumeSize[2]);
 234     filenames_out.resize(filenames_in.size());
 235     numberOfFilenames =  filenames_in.size();
 236   }
 237
 238   // Modify the meta dictionary
 239   typedef itk::MetaDataDictionary   DictionaryType;
 240   const std::vector<DictionaryType*>* dictionary = reader->GetMetaDataDictionaryArray();
 241
 242   // Get keys
 243   unsigned int numberOfKeysGiven=m_ArgsInfo.key_given;
 244
 245   std::string seriesUID;
 246   std::string frameOfReferenceUID;
 247   std::string studyUID;
 248
 249   // one pass through the keys given on the cmd-line, to check what will be recreated
 250   std::string seriesUIDkey = "0020|000e";
 251   std::string frameOfReferenceUIDKey = "0020|0052";
 252   std::string studyUIDKey = "0020|000d";
 253   bool seriesUIDGiven = false;
 254   bool studyUIDGiven = false;
 255   for (unsigned int i = 0; i < numberOfKeysGiven; i++) {
 256     std::string entryId( m_ArgsInfo.key_arg[i] );
 257
 258     seriesUIDGiven = (entryId ==  seriesUIDkey || entryId ==  frameOfReferenceUIDKey);
 259     if (seriesUIDGiven)
 260     {
 261       if (entryId ==  seriesUIDkey)
 262         seriesUID = m_ArgsInfo.tag_arg[i];
 263       else
 264         frameOfReferenceUID = m_ArgsInfo.tag_arg[i];
 265     }
 266     else if (m_ArgsInfo.newSeriesUID_flag) {
 267 #if GDCM_MAJOR_VERSION >= 2
 268       gdcm::UIDGenerator suid;
 269       seriesUID = suid.Generate();
 270       gdcm::UIDGenerator fuid;
 271       frameOfReferenceUID = fuid.Generate();
 272 #else
 273       seriesUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 274       frameOfReferenceUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 275 #endif
 276     }
 277
 278     studyUIDGiven = (entryId == studyUIDKey);
 279     if (studyUIDGiven)
 280       studyUID = m_ArgsInfo.tag_arg[i];
 281     else if (m_ArgsInfo.newStudyUID_flag) {
 282 #if GDCM_MAJOR_VERSION >= 2
 283       gdcm::UIDGenerator suid;
 284       studyUID = suid.Generate();
 285 #else
 286       studyUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 287 #endif
 288     }
 289   }
 290
 291   if (m_ArgsInfo.verbose_flag) {
 292     DD(seriesUID);
 293     DD(frameOfReferenceUID);
 294     DD(studyUID);
 295   }
 296
 297   // check if file UIDs will be be preserved
 298   bool useInputFileUID = true;
 299   if (m_ArgsInfo.newSeriesUID_flag || m_ArgsInfo.newStudyUID_flag || seriesUIDGiven || studyUIDGiven)
 300       useInputFileUID = false;
 301   else {
 302     namesGenerator->SetOutputDirectory( m_ArgsInfo.outputDir_arg  );
 303     filenames_out = namesGenerator->GetOutputFileNames();
 304 #if GDCM_MAJOR_VERSION < 2
 305     gdcmIO->SetKeepOriginalUID(true);
 306 #endif
 307   }
 308
 309   filenames_out.resize(numberOfFilenames);
 310
 311   // update output dicom keys/tags
 312   for(unsigned int fni = 0; fni<numberOfFilenames; fni++) {
 313     for (unsigned int i = 0; i < numberOfKeysGiven; i++) {
 314       std::string entryId(m_ArgsInfo.key_arg[i]  );
 315       std::string value( m_ArgsInfo.tag_arg[i] );
 316
 317       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), entryId, value );
 318     }
 319
 320     //
 321     if (!seriesUIDGiven) {
 322       if (m_ArgsInfo.newSeriesUID_flag) {
 323         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), seriesUIDkey, seriesUID );
 324         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), frameOfReferenceUIDKey, frameOfReferenceUID );
 325       }
 326     }
 327
 328     if (!studyUIDGiven) {
 329       if (m_ArgsInfo.newStudyUID_flag)
 330         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), studyUIDKey, studyUID );
 331     }
 332
 333     // file UIDs are recreated for new studies or series
 334     if (!useInputFileUID)
 335     {
 336       std::string fileUID;
 337 #if GDCM_MAJOR_VERSION >= 2
 338       gdcm::UIDGenerator fid;
 339       fileUID = fid.Generate();
 340 #else
 341       fileUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 342 #endif
 343       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0018", fileUID );
 344       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0002|0003", fileUID );
 345       filenames_out[fni] = itksys::SystemTools::CollapseFullPath(fileUID.c_str(), m_ArgsInfo.outputDir_arg) + std::string(".dcm");
 346     }
 347   }
 348
 349   // Output directory and filenames
 350   itksys::SystemTools::MakeDirectory( m_ArgsInfo.outputDir_arg ); // create if it doesn't exist
 351   typedef itk::ImageSeriesWriter<InputImageType, OutputImageType >  SeriesWriterType;
 352   typename SeriesWriterType::Pointer seriesWriter = SeriesWriterType::New();
 353
 354   seriesWriter->SetInput( input );
 355   seriesWriter->SetImageIO( gdcmIO );
 356
 357   seriesWriter->SetFileNames( filenames_out );
 358   seriesWriter->SetMetaDataDictionaryArray( dictionary );
 359
 360   // Write
 361   try {
 362     seriesWriter->Update();
 363   } catch( itk::ExceptionObject & excp ) {
 364     std::cerr << "Error: Exception thrown while writing the series!!" << std::endl;
 365     std::cerr << excp << std::endl;
 366   }
 367
 368 }
 369
 370 /*
 371 //-------------------------------------------------------------------
 372 // Update with the number of dimensions and the pixeltype
 373 //-------------------------------------------------------------------
 374 template<class args_info_type>
 375 template <unsigned int Dimension, class  PixelType>
 376 void
 377 WriteDicomSeriesGenericFilter<args_info_type>::UpdateWithDimAndPixelType()
 378 {
 379
 380   // ImageTypes
 381   typedef itk::Image<PixelType, Dimension> InputImageType;
 382   typedef itk::Image<PixelType, 2> OutputImageType;
 383
 384   // Read the input (volumetric)
 385   typedef itk::ImageFileReader<InputImageType> InputReaderType;
 386   typename InputReaderType::Pointer volumeReader = InputReaderType::New();
 387   volumeReader->SetFileName( m_InputFileName);
 388   volumeReader->Update();
 389   typename InputImageType::Pointer input= volumeReader->GetOutput();
 390
 391   // Read the dicom directory
 392   typedef itk::ImageSeriesReader< InputImageType >     ReaderType;
 393   typedef itk::GDCMImageIO ImageIOType;
 394   typedef itk::GDCMSeriesFileNames NamesGeneratorType;
 395
 396   ImageIOType::Pointer gdcmIO = ImageIOType::New();
 397   NamesGeneratorType::Pointer namesGenerator = NamesGeneratorType::New();
 398   namesGenerator->SetInputDirectory( m_ArgsInfo.inputDir_arg );
 399   namesGenerator->SetOutputDirectory( m_ArgsInfo.outputDir_arg  );
 400   typename   ReaderType::FileNamesContainer filenames_in = namesGenerator->GetInputFileNames();
 401   typename   ReaderType::FileNamesContainer filenames_out = namesGenerator->GetOutputFileNames();
 402
 403   // Output the dicom files
 404   unsigned int numberOfFilenames =  filenames_in.size();
 405   if (m_Verbose) {
 406     std::cout << numberOfFilenames <<" were read in the directory "<<m_ArgsInfo.inputDir_arg<<"..."<<std::endl<<std::endl;
 407     for(unsigned int fni = 0; fni<numberOfFilenames; fni++) {
 408       std::cout << "filename # " << fni << " = ";
 409       std::cout << filenames_in[fni] << std::endl;
 410     }
 411   }
 412
 413   // RP: 16/03/2011
 414   //    In some cases, due to resampling approximation issues,
 415   //    the number of slices in the MHD file may be different
 416   //    from the number of slices in the template DCM directory.
 417   //    To avoid ITK generating an exception, we reduce the number
 418   //    of DCM files to be considered, provided the --force
 419   //    option is set.
 420   typedef typename InputImageType::RegionType RegionType;
 421   typedef typename RegionType::SizeType SizeType;
 422   const RegionType volumeRegion = input->GetLargestPossibleRegion();
 423   const SizeType& volumeSize = volumeRegion.GetSize();
 424   if (m_ArgsInfo.force_given && Dimension == 3 && volumeSize[2] < numberOfFilenames)
 425   {
 426     std::cout << "Warning: Number of files in " << m_ArgsInfo.inputDir_arg << " is greater than the number of slices in MHD. Using only " << volumeSize[2] << " files." << std::endl;
 427     filenames_in.resize(volumeSize[2]);
 428     filenames_out.resize(filenames_in.size());
 429     numberOfFilenames =  filenames_in.size();
 430   }
 431
 432   // Read the series
 433   typename ReaderType::Pointer reader = ReaderType::New();
 434   reader->SetImageIO( gdcmIO );
 435   reader->SetFileNames( filenames_in );
 436   try {
 437     reader->Update();
 438   } catch (itk::ExceptionObject &excp) {
 439     std::cerr << "Error: Exception thrown while reading the DICOM series!!" << std::endl;
 440     std::cerr << excp << std::endl;
 441   }
 442
 443
 444   // Modify the meta dictionary
 445   typedef itk::MetaDataDictionary   DictionaryType;
 446   const std::vector<DictionaryType*>* dictionary = reader->GetMetaDataDictionaryArray();
 447
 448   // Get keys
 449   unsigned int numberOfKeysGiven=0;
 450   if(m_ArgsInfo.midP_flag && m_ArgsInfo.key_given)
 451     std::cerr<<"Error: both keys and midP option are given"<<std::endl;
 452   else if (m_ArgsInfo.midP_flag)
 453     numberOfKeysGiven=1;
 454   else
 455     numberOfKeysGiven=m_ArgsInfo.key_given;
 456
 457   for (unsigned int i = 0; i < numberOfKeysGiven; i++) {
 458     std::string entryId(m_ArgsInfo.key_arg[i]  );
 459     std::string value( m_ArgsInfo.tag_arg[i] );
 460     for(unsigned int fni = 0; fni<numberOfFilenames; fni++)
 461       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), entryId, value );
 462   }
 463
 464   // Output directory and filenames
 465   itksys::SystemTools::MakeDirectory( m_ArgsInfo.outputDir_arg ); // create if it doesn't exist
 466   typedef itk::ImageSeriesWriter<InputImageType, OutputImageType >  SeriesWriterType;
 467   typename SeriesWriterType::Pointer seriesWriter = SeriesWriterType::New();
 468
 469   seriesWriter->SetInput( volumeReader->GetOutput() );
 470   seriesWriter->SetImageIO( gdcmIO );
 471
 472   seriesWriter->SetFileNames( filenames_out );
 473   seriesWriter->SetMetaDataDictionaryArray( dictionary );
 474
 475   // Write
 476   try {
 477     seriesWriter->Update();
 478   } catch( itk::ExceptionObject & excp ) {
 479     std::cerr << "Error: Exception thrown while writing the series!!" << std::endl;
 480     std::cerr << excp << std::endl;
 481   }
 482
 483 }
 484 */
 485
 486 }//end clitk
 487
 488 #endif //#define clitkWriteDicomSeriesGenericFilter_txx