tools/clitkGateSimulation2DicomGenericFilter.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 clitkGateSimulation2DicomGenericFilter_txx
  19 #define clitkGateSimulation2DicomGenericFilter_txx
  20
  21 /* =================================================
  22  * @file   clitkGateSimulation2DicomGenericFilter.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 GateSimulation2DicomGenericFilter<args_info_type>::GateSimulation2DicomGenericFilter()
  49 {
  50   m_Verbose=false;
  51   m_InputFileName="";
  52 }
  53
  54
  55 //-----------------------------------------------------------
  56 // Update
  57 //-----------------------------------------------------------
  58 template<class args_info_type>
  59 void GateSimulation2DicomGenericFilter<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 GateSimulation2DicomGenericFilter<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 GateSimulation2DicomGenericFilter<args_info_type>::UpdateWithDimAndPixelType()
 126 {
 127
 128   // ImageTypes
 129   typedef itk::Image<PixelType, Dimension> InputImageType;
 130   typedef itk::Image<PixelType, Dimension> 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   if (m_ArgsInfo.preserve_flag) {
 157 #if GDCM_MAJOR_VERSION >= 2
 158     gdcmIO->LoadPrivateTagsOn();
 159     gdcmIO->KeepOriginalUIDOn();
 160 #endif
 161   }
 162   reader->SetImageIO( gdcmIO );
 163   reader->SetFileNames( filenames_in );
 164   try {
 165     reader->Update();
 166   } catch (itk::ExceptionObject &excp) {
 167     std::cerr << "Error: Exception thrown while reading the DICOM series!!" << std::endl;
 168     std::cerr << excp << std::endl;
 169   }
 170
 171   // Read the input (MHD file)
 172   typedef typename InputImageType::RegionType RegionType;
 173   typedef typename RegionType::SizeType SizeType;
 174   typedef itk::ImageFileReader<InputImageType> InputReaderType;
 175   typename InputReaderType::Pointer volumeReader = InputReaderType::New();
 176   volumeReader->SetFileName( m_InputFileName);
 177   volumeReader->Update();
 178
 179   typename InputImageType::Pointer input = volumeReader->GetOutput();
 180   if ((!m_ArgsInfo.useSizeAsReference_flag && (input->GetSpacing() != reader->GetOutput()->GetSpacing())) ||
 181       (m_ArgsInfo.useSizeAsReference_flag && (input->GetLargestPossibleRegion().GetSize() != reader->GetOutput()->GetLargestPossibleRegion().GetSize()))) {
 182
 183     // resampling is carried out on the fly if resolution or size between
 184     // the input mhd and input dicom series is different
 185
 186     // Filter
 187     typedef clitk::ResampleImageWithOptionsFilter<InputImageType, InputImageType> ResampleImageFilterType;
 188     typename ResampleImageFilterType::Pointer filter = ResampleImageFilterType::New();
 189     filter->SetInput(input);
 190     filter->SetVerboseOptions(m_Verbose);
 191     filter->SetGaussianFilteringEnabled(false);
 192     filter->SetDefaultPixelValue(0);
 193
 194     if (!m_ArgsInfo.useSizeAsReference_flag) {
 195       filter->SetOutputSpacing(input->GetSpacing());
 196       if (m_Verbose) {
 197         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;
 198         std::cout << "MHD -> " << input->GetSpacing() << std::endl;
 199         std::cout << "dicom -> " << reader->GetOutput()->GetSpacing() << std::endl;
 200       }
 201     }
 202     else {
 203       const SizeType& dicom_size = reader->GetOutput()->GetLargestPossibleRegion().GetSize();
 204       SizeType output_size;
 205       for (unsigned int i = 0; i < Dimension; i++)
 206         output_size[i] = dicom_size[i];
 207       filter->SetOutputSize(output_size);
 208       if (m_Verbose) {
 209           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;
 210           std::cout << "MHD -> " << input->GetLargestPossibleRegion().GetSize() << std::endl;
 211           std::cout << "dicom -> " << reader->GetOutput()->GetLargestPossibleRegion().GetSize() << std::endl;
 212       }
 213     }
 214
 215     try {
 216       filter->Update();
 217       input = filter->GetOutput();
 218     } catch( itk::ExceptionObject & excp ) {
 219     std::cerr << "Error: Exception thrown while resampling!!" << std::endl;
 220     std::cerr << excp << std::endl;
 221     }
 222   }
 223     std::cout << "RESAMPING FILTER DONE" << std::endl;
 224
 225   //    In some cases, due to resampling approximation issues,
 226   //    the number of slices in the MHD file may be different (smaller)
 227   //    from the number of files in the template dicom directory.
 228   //    To avoid ITK generating an exception, we reduce the number
 229   //    of DCM files to be considered, and a warning is printed
 230   //    in verbose mode
 231   const RegionType volumeRegion = input->GetLargestPossibleRegion();
 232   const SizeType& volumeSize = volumeRegion.GetSize();
 233   if (m_Verbose) {
 234     std::cout << volumeRegion << volumeSize << std::endl;
 235   }
 236     std::cout << Dimension << volumeSize[2] << numberOfFilenames << std::endl;
 237   if (Dimension == 3 && volumeSize[2] < numberOfFilenames) {
 238     if (m_Verbose)
 239       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;
 240
 241     filenames_in.resize(volumeSize[2]);
 242     filenames_out.resize(filenames_in.size());
 243     numberOfFilenames =  filenames_in.size();
 244   }
 245
 246   // Modify the meta dictionary
 247   typedef itk::MetaDataDictionary   DictionaryType;
 248   const std::vector<DictionaryType*>* dictionary = reader->GetMetaDataDictionaryArray();
 249
 250   // Get keys
 251   unsigned int numberOfKeysGiven=m_ArgsInfo.key_given;
 252     if (m_ArgsInfo.verbose_flag)
 253       DD(numberOfKeysGiven);
 254
 255   std::string seriesUID;
 256   std::string frameOfReferenceUID;
 257   std::string studyUID;
 258
 259   // one pass through the keys given on the cmd-line, to check what will be recreated
 260   std::string seriesUIDkey = "0020|000e";
 261   std::string seriesNumberKey = "0020|0011";
 262   std::string seriesDescriptionKey = "0008|103e";
 263   std::string frameOfReferenceUIDKey = "0020|0052";
 264   std::string studyUIDKey = "0020|000d";
 265   std::string studyIDKey = "0020|0010";
 266   std::string studyDescriptionKey = "0008|1030";
 267   bool seriesUIDGiven = false;
 268   bool seriesNumberGiven = false;
 269   bool seriesDescriptionGiven = false;
 270   bool studyUIDGiven = false;
 271   bool studyIDGiven = false;
 272   bool studyDescriptionGiven = false;
 273   for (unsigned int i = 0; i < numberOfKeysGiven; i++) {
 274     std::string entryId( m_ArgsInfo.key_arg[i] );
 275     if (m_ArgsInfo.verbose_flag)
 276       DD(entryId);
 277
 278     seriesUIDGiven |= (entryId ==  seriesUIDkey || entryId ==  frameOfReferenceUIDKey);
 279     seriesNumberGiven |= (entryId == seriesNumberKey);
 280     seriesDescriptionGiven |= (entryId == seriesDescriptionKey);
 281     studyUIDGiven |= (entryId == studyUIDKey);
 282     studyIDGiven |= (entryId == studyIDKey);
 283     studyDescriptionGiven |= (entryId == studyDescriptionKey);
 284   }
 285
 286   // force the creation of a new series if a new study was specified
 287   if (!studyUIDGiven && m_ArgsInfo.newStudyUID_flag) {
 288     m_ArgsInfo.newSeriesUID_flag = true;
 289 #if GDCM_MAJOR_VERSION >= 2
 290     gdcm::UIDGenerator suid;
 291     studyUID = suid.Generate();
 292 #else
 293     studyUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 294 #endif
 295   }
 296
 297   if (!seriesUIDGiven && m_ArgsInfo.newSeriesUID_flag) {
 298 #if GDCM_MAJOR_VERSION >= 2
 299     gdcm::UIDGenerator suid;
 300     seriesUID = suid.Generate();
 301     gdcm::UIDGenerator fuid;
 302     frameOfReferenceUID = fuid.Generate();
 303 #else
 304     seriesUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 305     frameOfReferenceUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 306 #endif
 307   }
 308
 309   if (m_ArgsInfo.verbose_flag) {
 310     DD(seriesUID);
 311     DD(frameOfReferenceUID);
 312     DD(studyUID);
 313   }
 314
 315   // check if file UIDs will be be preserved
 316   bool useInputFileUID = true;
 317   if (m_ArgsInfo.newSeriesUID_flag || m_ArgsInfo.newStudyUID_flag || seriesUIDGiven || studyUIDGiven) {
 318     useInputFileUID = false;
 319   }
 320   else {
 321 #if GDCM_MAJOR_VERSION < 2
 322     gdcmIO->SetKeepOriginalUID(true);
 323 #endif
 324     namesGenerator->SetOutputDirectory( m_ArgsInfo.outputDir_arg  );
 325   }
 326
 327   filenames_out.resize(numberOfFilenames);
 328
 329   time_t t;
 330   t = time(&t);
 331   struct tm* instanceDateTimeTm = localtime(&t);
 332   char datetime[16];
 333   strftime(datetime, 16, "%Y%m%d", instanceDateTimeTm);
 334   std::ostringstream instanceDate;
 335   instanceDate << datetime;
 336   std::ostringstream instanceTime;
 337   strftime(datetime, 16, "%H%M%S", instanceDateTimeTm);
 338   instanceTime << datetime;
 339
 340   // update output dicom keys/tags
 341   for(unsigned int fni = 0; fni<numberOfFilenames; fni++) {
 342     for (unsigned int i = 0; i < numberOfKeysGiven; i++) {
 343       std::string entryId(m_ArgsInfo.key_arg[i]  );
 344       std::string value( m_ArgsInfo.tag_arg[i] );
 345
 346       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), entryId, value );
 347     }
 348
 349     // series UID
 350     if (!seriesUIDGiven) {
 351       if (m_ArgsInfo.newSeriesUID_flag) {
 352         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), seriesUIDkey, seriesUID );
 353         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), frameOfReferenceUIDKey, frameOfReferenceUID );
 354       }
 355     }
 356
 357     // study UID
 358     if (!studyUIDGiven) {
 359       if (m_ArgsInfo.newStudyUID_flag)
 360         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), studyUIDKey, studyUID );
 361     }
 362
 363     // study description
 364     if (studyUIDGiven || m_ArgsInfo.newStudyUID_flag) {
 365       if (!studyIDGiven)
 366         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), studyIDKey,itksys::SystemTools::GetFilenameName( m_ArgsInfo.outputDir_arg ));
 367       if (!studyDescriptionGiven)
 368         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), studyDescriptionKey,itksys::SystemTools::GetFilenameName( m_ArgsInfo.outputDir_arg ));
 369
 370       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0020", instanceDate.str() );
 371       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0030", instanceTime.str() );
 372     }
 373
 374     // series description/number
 375     if (seriesUIDGiven || m_ArgsInfo.newSeriesUID_flag) {
 376       if (!seriesDescriptionGiven)
 377         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), seriesDescriptionKey, itksys::SystemTools::GetFilenameName(m_ArgsInfo.outputDir_arg) );
 378       if (!seriesNumberGiven)
 379         itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), seriesNumberKey, itksys::SystemTools::GetFilenameName(m_ArgsInfo.outputDir_arg) );
 380
 381       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0012", instanceDate.str() );
 382       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0013", instanceTime.str() );
 383     }
 384
 385     // file UIDs are recreated for new studies or series
 386     if (!useInputFileUID)
 387     {
 388       if (m_ArgsInfo.verbose_flag)
 389         std::cout << "Recreating file UIDs" << std::endl;
 390
 391       std::string fileUID;
 392 #if GDCM_MAJOR_VERSION >= 2
 393       gdcm::UIDGenerator fid;
 394       fileUID = fid.Generate();
 395 #else
 396       fileUID = gdcm::Util::CreateUniqueUID( gdcmIO->GetUIDPrefix());
 397 #endif
 398       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0008|0018", fileUID );
 399       itk::EncapsulateMetaData<std::string>( *((*dictionary)[fni]), "0002|0003", fileUID );
 400
 401       filenames_out[fni] = itksys::SystemTools::CollapseFullPath(fileUID.c_str(), m_ArgsInfo.outputDir_arg) + std::string(".dcm");
 402     }
 403   }
 404
 405   // Output directory and filenames
 406   itksys::SystemTools::MakeDirectory( m_ArgsInfo.outputDir_arg ); // create if it doesn't exist
 407   typedef itk::ImageFileWriter<OutputImageType>  SeriesWriterType;
 408   typename SeriesWriterType::Pointer seriesWriter = SeriesWriterType::New();
 409
 410   seriesWriter->SetInput( input );
 411   seriesWriter->SetImageIO( gdcmIO );
 412
 413   seriesWriter->SetFileName( filenames_out[0] );
 414   seriesWriter->SetMetaDataDictionary( *((*dictionary)[0]) );
 415
 416   // Write
 417   try {
 418     if (m_ArgsInfo.verbose_flag)
 419       std::cout << seriesWriter << std::endl;
 420     seriesWriter->Update();
 421   } catch( itk::ExceptionObject & excp ) {
 422     std::cerr << "Error: Exception thrown while writing the series!!" << std::endl;
 423     std::cerr << excp << std::endl;
 424   }
 425
 426 }
 427
 428 }//end clitk
 429
 430 #endif //#define clitkGateSimulation2DicomGenericFilter_txx