File: AverageImages.cxx

package info (click to toggle)
ants 2.5.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,672 kB
  • sloc: cpp: 85,685; sh: 15,850; perl: 863; xml: 115; python: 111; makefile: 68
file content (436 lines) | stat: -rw-r--r-- 14,164 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/*=========================================================================

  Program:   Advanced Normalization Tools

  Copyright (c) ConsortiumOfANTS. All rights reserved.
  See accompanying COPYING.txt or
 https://github.com/stnava/ANTs/blob/master/ANTSCopyright.txt for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

// We divide the 2nd input image by its mean and add it to the first
// input image with weight 1/n.
// The output overwrites the 1st img with the sum.

// Note: could easily add variance computation
// http://people.revoledu.com/kardi/tutorial/RecursiveStatistic/Time-Variance.htm

#include "antsUtilities.h"

#include "itkArray.h"
#include "itkVariableLengthVector.h"
#include "itkImage.h"
#include "itkImageRegionConstIterator.h"
#include "itkImageFileReader.h"
#include "itkImageFileWriter.h"
#include "itkImageRegionIteratorWithIndex.h"
#include "itkOptimalSharpeningImageFilter.h"
#include "itkLaplacianSharpeningImageFilter.h"
#include "itkResampleImageFilter.h"
#include <algorithm>

namespace ants
{
template <unsigned int ImageDimension, unsigned int NVectorComponents>
int
AverageImages1(unsigned int argc, char * argv[])
{
  using PixelType = float;
  using ImageType = itk::Image<PixelType, ImageDimension>;
  using Iterator = itk::ImageRegionIteratorWithIndex<ImageType>;
  using ImageFileReader = itk::ImageFileReader<ImageType>;
  using writertype = itk::ImageFileWriter<ImageType>;


  const int normalizei = std::stoi(argv[3]);

  if ((normalizei < 0) || (normalizei > 2))
  {
    std::cerr << "ERROR:  Normalize option must be 0 or 1 or 2, " << normalizei << " given" << std::endl;
    return EXIT_FAILURE;
  }

  const float numberofimages = static_cast<float>(argc) - 4.0f;

  typename ImageType::SizeType maxSize;
  maxSize.Fill(0);
  unsigned int bigimage = 0;
  for (unsigned int j = 4; j < argc; j++)
  {
    const std::string                  fn = std::string(argv[j]);
    typename itk::ImageIOBase::Pointer imageIO =
      itk::ImageIOFactory::CreateImageIO(fn.c_str(), itk::IOFileModeEnum::ReadMode);
    if (imageIO.IsNull())
    {
      std::cerr << " Cannot read input file: " << fn.c_str() << std::endl;
      return EXIT_FAILURE;
    }
    imageIO->SetFileName(fn.c_str());
    imageIO->ReadImageInformation();

    for (unsigned int i = 0; i < ImageType::ImageDimension; i++)
    {
      itk::SizeValueType currentDimensionSize = imageIO->GetDimensions(i);

      if (currentDimensionSize > maxSize[i])
      {
        maxSize[i] = currentDimensionSize;
        bigimage = j;
      }
    }
  }
  std::cout << " bigimage " << bigimage << " maxSize " << maxSize << std::endl;

  typename ImageFileReader::Pointer reader = ImageFileReader::New();
  reader->SetFileName(argv[bigimage]);
  reader->Update();
  typename ImageType::Pointer averageimage = reader->GetOutput();
  std::cout << " Setting physical space of output average image based on largest image " << std::endl;
  unsigned int vectorlength = reader->GetImageIO()->GetNumberOfComponents();
  std::cout << " Averaging " << numberofimages << " images with dim = " << ImageDimension << " vector components "
            << vectorlength << std::endl;
  PixelType meanval = 0;
  averageimage->FillBuffer(meanval); // Reset all images to a mean of zero on the accumulator buffer.
  for (unsigned int j = 4; j < argc; j++)
  {
    std::cout << " reading " << std::string(argv[j]) << std::endl;
    typename ImageFileReader::Pointer rdr = ImageFileReader::New();
    rdr->SetFileName(argv[j]);
    rdr->Update();
    using ResamplerType = itk::ResampleImageFilter<ImageType, ImageType, float>;
    typename ResamplerType::Pointer resampler = ResamplerType::New();
    // default to identity resampler->SetTransform( transform );
    // default to linearinterp resampler->SetInterpolator( interpolator );
    resampler->SetInput(rdr->GetOutput());
    resampler->SetOutputParametersFromImage(averageimage);
    resampler->Update();

    typename ImageType::Pointer image2 = resampler->GetOutput();
    Iterator                    vfIter2(image2, image2->GetLargestPossibleRegion());
    unsigned long               ct = 0;
    if (normalizei > 0)
    {
      meanval = 0;
      for (vfIter2.GoToBegin(); !vfIter2.IsAtEnd(); ++vfIter2)
      {
        const PixelType & localp = image2->GetPixel(vfIter2.GetIndex());
        meanval = meanval + localp;
        ct++;
      }
      if (ct > 0)
      {
        meanval = meanval / (float)ct;
      }
      if (meanval <= 0)
      {
        meanval = (1);
      }
    }
    for (vfIter2.GoToBegin(); !vfIter2.IsAtEnd(); ++vfIter2)
    {
      PixelType val = vfIter2.Get();
      if (normalizei > 0)
      {
        val /= meanval;
      }
      val = val / (float)numberofimages;
      const PixelType & oldval = averageimage->GetPixel(vfIter2.GetIndex());
      averageimage->SetPixel(vfIter2.GetIndex(), val + oldval);
    }
  }

  //  typedef itk::OptimalSharpeningImageFilter<ImageType,ImageType > sharpeningFilter;
  using sharpeningFilter = itk::LaplacianSharpeningImageFilter<ImageType, ImageType>;
  typename sharpeningFilter::Pointer shFilter = sharpeningFilter::New();
  if ((normalizei == 1) && (argc > 3) && (vectorlength == 1))
  {
    std::cout << " applying Laplacian sharpening " << std::endl;
    shFilter->SetInput(averageimage);
    //    shFilter->SetSValue(0.5);
    averageimage = shFilter->GetOutput();
  }

  std::cout << " writing output " << std::endl;
  {
    typename writertype::Pointer writer = writertype::New();
    writer->SetFileName(argv[2]);
    writer->SetInput(averageimage);
    writer->Update();
  }

  return EXIT_SUCCESS;
}

template <unsigned int ImageDimension, unsigned int NVectorComponents>
int
AverageImages(unsigned int argc, char * argv[])
{
  using PixelType = itk::Vector<float, NVectorComponents>;
  using ImageType = itk::Image<PixelType, ImageDimension>;
  using Iterator = itk::ImageRegionIteratorWithIndex<ImageType>;
  using ImageFileReader = itk::ImageFileReader<ImageType>;
  using writertype = itk::ImageFileWriter<ImageType>;

  //  bool  normalizei = std::stoi(argv[3]);
  float                       numberofimages = static_cast<float>(argc) - 4.0f;
  typename ImageType::Pointer averageimage = nullptr;
  typename ImageType::Pointer image2 = nullptr;

  typename ImageType::SizeType size;
  size.Fill(0);
  typename ImageType::SizeType maxSize;
  maxSize.Fill(0);

  unsigned int bigimage = 4;
  for (unsigned int j = 4; j < argc; j++)
  {
    std::string fn = std::string(argv[j]);
    std::cout << " fn " << fn << " " << ImageDimension << " " << NVectorComponents << std::endl;
    typename itk::ImageIOBase::Pointer imageIO =
      itk::ImageIOFactory::CreateImageIO(fn.c_str(), itk::IOFileModeEnum::ReadMode);
    if (imageIO.IsNull())
    {
      std::cerr << " Cannot read input file: " << fn.c_str() << std::endl;
      return EXIT_FAILURE;
    }
    imageIO->SetFileName(fn.c_str());
    imageIO->ReadImageInformation();

    for (unsigned int i = 0; i < imageIO->GetNumberOfDimensions(); i++)
    {
      size[i] = imageIO->GetDimensions(i);
    }

    for (unsigned int i = 0; i < imageIO->GetNumberOfDimensions(); i++)
    {
      if (size[i] > maxSize[i])
      {
        maxSize[i] = size[i];
        bigimage = j;
        std::cout << " bigimage " << j << " size " << size << std::endl;
      }
    }
  }

  std::cout << " largest image " << size << std::endl;
  typename ImageFileReader::Pointer reader = ImageFileReader::New();
  reader->SetFileName(argv[bigimage]);
  reader->Update();
  averageimage = reader->GetOutput();
  unsigned int vectorlength = reader->GetImageIO()->GetNumberOfComponents();
  std::cout << " Averaging " << numberofimages << " images with dim = " << ImageDimension << " vector components "
            << vectorlength << std::endl;
  typename ImageType::IndexType zindex;
  zindex.Fill(0);
  PixelType meanval = reader->GetOutput()->GetPixel(zindex);
  meanval.Fill(0);
  averageimage->FillBuffer(meanval);
  for (unsigned int j = 4; j < argc; j++)
  {
    std::cout << " reading " << std::string(argv[j]) << " for average " << std::endl;
    typename ImageFileReader::Pointer rdr = ImageFileReader::New();
    rdr->SetFileName(argv[j]);
    rdr->Update();
    image2 = rdr->GetOutput();
    Iterator vfIter2(image2, image2->GetLargestPossibleRegion());
    for (vfIter2.GoToBegin(); !vfIter2.IsAtEnd(); ++vfIter2)
    {
      PixelType val = vfIter2.Get();
      double    valnorm = val.GetNorm();
      if (!std::isnan(valnorm) && !std::isinf(valnorm))
      {
        val = val / (float)numberofimages;
        PixelType oldval = averageimage->GetPixel(vfIter2.GetIndex());
        averageimage->SetPixel(vfIter2.GetIndex(), val + oldval);
      }
    }
  }

  {
    typename writertype::Pointer writer = writertype::New();
    writer->SetFileName(argv[2]);
    writer->SetInput(averageimage);
    writer->Update();
  }
  return EXIT_SUCCESS;
}

// entry point for the library; parameter 'args' is equivalent to 'argv' in (argc,argv) of commandline parameters to
// 'main()'
int
AverageImages(std::vector<std::string> args, std::ostream * /*out_stream = nullptr */)
{
  // put the arguments coming in as 'args' into standard (argc,argv) format;
  // 'args' doesn't have the command name as first, argument, so add it manually;
  // 'args' may have adjacent arguments concatenated into one argument,
  // which the parser should handle
  args.insert(args.begin(), "AverageImages");
  int     argc = args.size();
  char ** argv = new char *[args.size() + 1];
  for (unsigned int i = 0; i < args.size(); ++i)
  {
    // allocate space for the string plus a null character
    argv[i] = new char[args[i].length() + 1];
    std::strncpy(argv[i], args[i].c_str(), args[i].length());
    // place the null character in the end
    argv[i][args[i].length()] = '\0';
  }
  argv[argc] = nullptr;
  // class to automatically cleanup argv upon destruction
  class Cleanup_argv
  {
  public:
    Cleanup_argv(char ** argv_, int argc_plus_one_)
      : argv(argv_)
      , argc_plus_one(argc_plus_one_)
    {}

    ~Cleanup_argv()
    {
      for (unsigned int i = 0; i < argc_plus_one; ++i)
      {
        delete[] argv[i];
      }
      delete[] argv;
    }

  private:
    char **      argv;
    unsigned int argc_plus_one;
  };
  Cleanup_argv cleanup_argv(argv, argc + 1);

  // antscout->set_stream( out_stream );

  if (argc < 5)
  {
    std::cout << "\n" << std::endl;
    std::cout << "Usage: \n" << std::endl;
    std::cout << argv[0] << " ImageDimension Outputfname.nii.gz Normalize <images> \n" << std::endl;
    std::cout << " Compulsory arguments: \n" << std::endl;
    std::cout << " ImageDimension: 2 or 3 (for 2 or 3 dimensional input).\n " << std::endl;
    std::cout << " Outputfname.nii.gz: the name of the resulting image.\n" << std::endl;
    std::cout << " Normalize: 0 - no normalization (this is the only option for multi-component images)\n"
              << "            1 - input images are divided by their mean before averaging; Laplacian sharpening is "
                 "applied to the average\n"
              << "            2 - input images are divided by their mean before averaging; no sharpening\n"
              << std::endl;
    std::cout << " Images are resampled into the space of the largest input image.\n Normalization options only apply "
                 "to single-component input.\n" << std::endl;
    std::cout << " Example Usage:\n" << std::endl;
    std::cout << argv[0] << " 3 average.nii.gz  1  *.nii.gz \n" << std::endl;
    std::cout << " \n" << std::endl;
    if (argc >= 2 && (std::string(argv[1]) == std::string("--help") || std::string(argv[1]) == std::string("-h")))
    {
      return EXIT_SUCCESS;
    }
    return EXIT_FAILURE;
  }

  const int                 dim = std::stoi(argv[1]);
  itk::ImageIOBase::Pointer imageIO = itk::ImageIOFactory::CreateImageIO(argv[4], itk::IOFileModeEnum::ReadMode);
  if (imageIO.IsNull())
    {
      std::cerr << " Cannot read input file: " << argv[4] << std::endl;
      return EXIT_FAILURE;
    }
  imageIO->SetFileName(argv[4]);
  imageIO->ReadImageInformation();
  unsigned int ncomponents = imageIO->GetNumberOfComponents();

  // Get the image dimension
  switch (dim)
  {
    case 2:
    {
      switch (ncomponents)
      {
        case 2:
        {
          return AverageImages<2, 2>(argc, argv);
        }
        break;
        default:
        {
          return AverageImages1<2, 1>(argc, argv);
        }
        break;
      }
    }
    break;
    case 3:
    {
      switch (ncomponents)
      {
        case 7:
        {
          return AverageImages<3, 7>(argc, argv);
        }
        break;
        case 6:
        {
          return AverageImages<3, 6>(argc, argv);
        }
        break;
        case 3:
        {
          return AverageImages<3, 3>(argc, argv);
        }
        break;
        case 2:
        {
          return AverageImages<3, 2>(argc, argv);
        }
        break;
        default:
        {
          return AverageImages1<3, 1>(argc, argv);
        }
        break;
      }
    }
    break;
    case 4:
    {
      switch (ncomponents)
      {
        case 7:
        {
          return AverageImages<4, 7>(argc, argv);
        }
        break;
        case 6:
        {
          return AverageImages<4, 6>(argc, argv);
        }
        break;
        case 4:
        {
          return AverageImages<4, 4>(argc, argv);
        }
        break;
        case 3:
        {
          return AverageImages<4, 3>(argc, argv);
        }
        break;
        default:
        {
          return AverageImages1<4, 1>(argc, argv);
        }
        break;
      }
    }
    break;
    default:
      std::cout << " You passed ImageDimension: " << dim << " . Please use only image domains of 2, 3 or 4  "
                << std::endl;
      return EXIT_FAILURE;
  }
  return EXIT_SUCCESS;
}
} // namespace ants