File: antsMotionCorrDiffusionDirection.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 (650 lines) | stat: -rw-r--r-- 19,923 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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#include "antsUtilities.h"
#include "antsAllocImage.h"
#include "ReadWriteData.h"
#include "antsCommandLineParser.h"
#include "itkCSVNumericObjectFileWriter.h"
#include "itkCSVArray2DFileReader.h"
#include "itkImageRegistrationMethodv4.h"
#include "itkSyNImageRegistrationMethod.h"
#include "itkDisplacementFieldTransform.h"
#include "itkANTSNeighborhoodCorrelationImageToImageMetricv4.h"
#include "itkMeanSquaresImageToImageMetricv4.h"
#include "itkCorrelationImageToImageMetricv4.h"
#include "itkImageToImageMetricv4.h"
#include "itkMattesMutualInformationImageToImageMetricv4.h"
#include "itkImageToHistogramFilter.h"
#include "itkHistogramMatchingImageFilter.h"
#include "itkIntensityWindowingImageFilter.h"

#include "itkAffineTransform.h"
#include "itkBSplineTransform.h"
#include "itkBSplineSmoothingOnUpdateDisplacementFieldTransform.h"
#include "itkCompositeTransform.h"
#include "itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h"
#include "itkIdentityTransform.h"
#include "itkEuler2DTransform.h"
#include "itkEuler3DTransform.h"
#include "itkTransform.h"
#include "itkExtractImageFilter.h"

#include "itkBSplineTransformParametersAdaptor.h"
#include "itkBSplineSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor.h"
#include "itkGaussianSmoothingOnUpdateDisplacementFieldTransformParametersAdaptor.h"
#include "itkTimeVaryingVelocityFieldTransformParametersAdaptor.h"

#include "itkGradientDescentOptimizerv4.h"
#include "itkConjugateGradientLineSearchOptimizerv4.h"
#include "itkQuasiNewtonOptimizerv4.h"

#include "itkHistogramMatchingImageFilter.h"
#include "itkMinimumMaximumImageCalculator.h"
#include "itkImageFileReader.h"
#include "itkImageFileWriter.h"
#include "itkMacro.h"
#include "itkRegistrationParameterScalesFromPhysicalShift.h"
#include "itkResampleImageFilter.h"
#include "itkShrinkImageFilter.h"
#include "itkTimeProbe.h"
#include "itkTransformFileReader.h"
#include "itkTransformFileWriter.h"
#include "itkSimilarity2DTransform.h"
#include "itkSimilarity3DTransform.h"

#include <sstream>

namespace ants
{

template <typename T>
inline std::string
ants_moco_to_string(const T & t)
{
  std::stringstream ss;
  ss << t;
  return ss.str();
}

template <typename T>
struct ants_moco_index_cmp
{
  ants_moco_index_cmp(const T _arr)
    : arr(_arr)
  {}

  bool
  operator()(const size_t a, const size_t b) const
  {
    return arr[a] < arr[b];
  }

  const T arr;
};


// Transform traits to generalize the rigid transform
//
template <unsigned int ImageDimension>
class RigidTransformTraits
{
  // Don't worry about the fact that the default option is the
  // affine Transform, that one will not actually be instantiated.
public:
  using TransformType = itk::AffineTransform<double, ImageDimension>;
};

template <>
class RigidTransformTraits<2>
{
public:
  using TransformType = itk::Euler2DTransform<double>;
};

template <>
class RigidTransformTraits<3>
{
public:
  // typedef itk::VersorRigid3DTransform<double> TransformType;
  // typedef itk::QuaternionRigidTransform<double>  TransformType;
  using TransformType = itk::Euler3DTransform<double>;
};

template <unsigned int ImageDimension>
class SimilarityTransformTraits
{
  // Don't worry about the fact that the default option is the
  // affine Transform, that one will not actually be instantiated.
public:
  using TransformType = itk::AffineTransform<double, ImageDimension>;
};

template <>
class SimilarityTransformTraits<2>
{
public:
  using TransformType = itk::Similarity2DTransform<double>;
};

template <>
class SimilarityTransformTraits<3>
{
public:
  using TransformType = itk::Similarity3DTransform<double>;
};


int
ants_motion_directions(itk::ants::CommandLineParser * parser)
{

  constexpr unsigned int ImageDimension = 3;

  using RealType = double;
  using FixedImageType = itk::Image<RealType, ImageDimension>;
  using ImageReaderType = itk::ImageFileReader<FixedImageType>;
  using vMatrix = vnl_matrix<RealType>;
  vMatrix param_values;
  using CompositeTransformType = itk::CompositeTransform<RealType, ImageDimension>;

  std::vector<CompositeTransformType::Pointer> CompositeTransformVector;

  using RigidTransformType = itk::Euler3DTransform<RealType>;
  using AffineTransformType = itk::AffineTransform<RealType, ImageDimension>;

  using ParserType = itk::ants::CommandLineParser;
  using OptionType = ParserType::OptionType;

  using ParameterValueType = double;
  using MocoReaderType = itk::CSVArray2DFileReader<ParameterValueType>;
  using MocoDataArrayType = MocoReaderType::Array2DDataObjectType;
  using DirectionArrayType = itk::Array2D<ParameterValueType>;

  std::string outputName = "";
  std::string mocoName = "";
  std::string physicalName = "";


  OptionType::Pointer outputOption = parser->GetOption("output");
  if (outputOption && outputOption->GetNumberOfFunctions())
  {
    outputName = outputOption->GetFunction(0)->GetName();
    std::cout << "Output: " << outputName << std::endl;
  }
  else
  {
    std::cerr << "Output option not specified." << std::endl;
    return EXIT_FAILURE;
  }

  OptionType::Pointer mocoOption = parser->GetOption("moco");
  if (mocoOption && mocoOption->GetNumberOfFunctions())
  {
    mocoName = mocoOption->GetFunction(0)->GetName();
    std::cout << "Moco file: " << mocoName << std::endl;
  }
  else
  {
    std::cerr << "Motion parameter file not specified" << std::endl;
    return EXIT_FAILURE;
  }

  OptionType::Pointer physicalOption = parser->GetOption("physical");
  if (physicalOption && physicalOption->GetNumberOfFunctions())
  {
    physicalName = physicalOption->GetFunction(0)->GetName();
    std::cout << "Physical space image: " << physicalName << std::endl;
  }
  else
  {
    std::cerr << "Physical space image not specified" << std::endl;
    return EXIT_FAILURE;
  }


  OptionType::Pointer schemeOption = parser->GetOption("scheme");
  OptionType::Pointer bvecOption = parser->GetOption("bvec");

  if (bvecOption->GetNumberOfFunctions() && schemeOption->GetNumberOfFunctions())
  {
    std::cerr << "Must use either scheme or bvec input, not both" << std::endl;
    return EXIT_FAILURE;
  }

  DirectionArrayType directionArray;

  if (schemeOption && schemeOption->GetNumberOfFunctions())
  {
    std::string schemeName = schemeOption->GetFunction(0)->GetName();
    // std::cout << "Scheme file: " << schemeName << std::endl;

    std::cout << "Scheme input format still a work in progress" << std::endl;
    return EXIT_FAILURE;

    MocoReaderType::Pointer schemeReader = MocoReaderType::New();
    schemeReader->SetFileName(schemeName.c_str());
    schemeReader->SetFieldDelimiterCharacter(' ');
    schemeReader->HasColumnHeadersOff();
    schemeReader->HasRowHeadersOff();
    schemeReader->Parse();

    // Manually skip first 2 lines of data array
    MocoDataArrayType::MatrixType schemeMatrix = schemeReader->GetOutput()->GetMatrix();
    // std::cout << "scheme data array size = " << schemeMatrix.rows() << " x " << schemeMatrix.cols() << std::endl;

    directionArray.SetSize(schemeMatrix.rows() - 2, schemeMatrix.cols());

    for (unsigned int i = 2; i < schemeMatrix.rows(); i++)
    {
      for (unsigned int j = 0; j < 3; j++)
      {
        directionArray(i - 2, j) = schemeMatrix(i - 2, j);
      }
    }
  }

  bool transposeArray = true;
  if (bvecOption && bvecOption->GetNumberOfFunctions())
  {
    std::string bvecName = bvecOption->GetFunction(0)->GetName();
    // std::cout << "bvec file: " << bvecName << std::endl;

    MocoReaderType::Pointer bvecReader = MocoReaderType::New();
    bvecReader->SetFileName(bvecName.c_str());
    bvecReader->SetFieldDelimiterCharacter(' ');
    bvecReader->HasColumnHeadersOff();
    bvecReader->HasRowHeadersOff();
    bvecReader->Update();
    MocoDataArrayType::MatrixType bvecMatrix = bvecReader->GetOutput()->GetMatrix();

    // std::cout << "BVEC data array size = " << bvecMatrix.rows() << " x " << bvecMatrix.cols() << std::endl;
    if (bvecMatrix.cols() == 3)
    {
      transposeArray = false;
      std::cout << "Column based format" << std::endl;
    }

    // Transpose the array
    if (transposeArray)
    {
      directionArray.SetSize(bvecMatrix.cols(), bvecMatrix.rows());
    }
    else
    {
      directionArray.SetSize(bvecMatrix.rows(), bvecMatrix.cols());
    }

    if (transposeArray)
    {
      for (unsigned int i = 0; i < bvecMatrix.cols(); i++)
      {
        for (unsigned int j = 0; j < bvecMatrix.rows(); j++)
        {
          directionArray(i, j) = bvecMatrix(j, i);
        }
      }
    }
    else
    {
      for (unsigned int i = 0; i < bvecMatrix.cols(); i++)
      {
        for (unsigned int j = 0; j < bvecMatrix.rows(); j++)
        {
          directionArray(j, i) = bvecMatrix(j, i);
        }
      }
    }
  }

  std::cout << "Read direction data of size: " << directionArray.rows() << " x " << directionArray.cols() << std::endl;

  // itkImageFileReader will set direction to identity if the image being read has more dimensions than the class
  // template eg if you pass a 4D image file name to a ReaderType whose dimension is 3
  //
  // Therefore check reference image is 3D, and fail if not
  //
  itk::ImageIOBase::Pointer imageIO =
    itk::ImageIOFactory::CreateImageIO(physicalName.c_str(), itk::IOFileModeEnum::ReadMode);
  imageIO->SetFileName(physicalName.c_str());
  try
  {
    imageIO->ReadImageInformation();
  }
  catch (...)
  {
    std::cout << "Can't read reference image " << physicalName << std::endl;
    return EXIT_FAILURE;
  }
  if (imageIO->GetNumberOfDimensions() != ImageDimension)
  {
    std::cout << "Reference image must be 3D " << std::endl;
    return EXIT_FAILURE;
  }

  ImageReaderType::Pointer imageReader = ImageReaderType::New();
  imageReader->SetFileName(physicalName.c_str());
  imageReader->Update();

  DirectionArrayType outputDirectionArray;
  outputDirectionArray.SetSize(directionArray.rows(), directionArray.cols());

  MocoReaderType::Pointer mocoReader = MocoReaderType::New();
  mocoReader->SetFileName(mocoName.c_str());
  mocoReader->SetFieldDelimiterCharacter(',');
  mocoReader->HasColumnHeadersOn();
  mocoReader->HasRowHeadersOff();
  mocoReader->Update();

  MocoDataArrayType::Pointer mocoDataArray = mocoReader->GetOutput();
  std::cout << "Read motion correction data of size: " << mocoDataArray->GetMatrix().rows() << " x "
            << mocoDataArray->GetMatrix().cols() << std::endl;

  // [-0.231374, -0.0543334, 0.677384]

  unsigned int nTransformParams = mocoDataArray->GetMatrix().cols() - 2;
  // std::cout << "# Transform parameters = " << nTransformParams << std::endl;

  AffineTransformType::Pointer toPhysical = AffineTransformType::New();
  toPhysical->SetIdentity();
  AffineTransformType::Pointer toIndex = AffineTransformType::New();
  toIndex->SetIdentity();

  AffineTransformType::MatrixType toPhysicalMatrix = toPhysical->GetMatrix();
  for (unsigned int i = 0; i < ImageDimension; i++)
  {
    for (unsigned int j = 0; j < ImageDimension; j++)
    {
      toPhysicalMatrix(i, j) = imageReader->GetOutput()->GetDirection()(i, j);
    }
  }
  toPhysical->SetMatrix(toPhysicalMatrix);
  toPhysical->GetInverse(toIndex);

  for (unsigned int i = 0; i < directionArray.rows(); i++)
  {

    AffineTransformType::Pointer        affineTransform = AffineTransformType::New();
    AffineTransformType::Pointer        directionTransform = AffineTransformType::New();
    AffineTransformType::ParametersType params;

    if (nTransformParams == 6)
    {
      RigidTransformType::Pointer        rigid = RigidTransformType::New();
      RigidTransformType::ParametersType rParams;

      rParams.SetSize(nTransformParams);
      for (unsigned int t = 0; t < nTransformParams; t++)
      {
        rParams[t] = mocoDataArray->GetMatrix()(i, t + 2);
      }
      rigid->SetParameters(rParams);
      affineTransform->SetMatrix(rigid->GetMatrix());
      affineTransform->SetTranslation(rigid->GetTranslation());
    }
    else if (nTransformParams == 12)
    {
      params.SetSize(nTransformParams);
      for (unsigned int t = 0; t < nTransformParams; t++)
      {
        params[t] = mocoDataArray->GetMatrix()(i, t + 2);
      }
      affineTransform->SetParameters(params);
      affineTransform->GetInverse(directionTransform);
    }
    else
    {
      // Not rigid (6 params) or affine (12), something is wrong
      return EXIT_FAILURE;
    }

    // std::cout << affineTransform->GetTranslation() << std::endl;

    AffineTransformType::InputVectorType  dir;
    AffineTransformType::OutputVectorType rotatedDir;


    for (unsigned int j = 0; j < directionArray.cols(); j++)
    {
      dir[j] = directionArray(i, j);
    }
    if (dir.GetNorm() > 0)
    {
      dir.Normalize();
      rotatedDir = toPhysical->TransformVector(dir);
      rotatedDir = affineTransform->TransformVector(rotatedDir);
      rotatedDir.Normalize();
      rotatedDir = toIndex->TransformVector(rotatedDir);

      // rotatedDir = affineTransform->TransformVector( dir );
      // rotatedDir.Normalize();
    }
    else
    {
      for (unsigned int j = 0; j < directionArray.cols(); j++)
      {
        rotatedDir[j] = dir[j];
      }
    }

    for (unsigned int j = 0; j < directionArray.cols(); j++)
    {
      outputDirectionArray(i, j) = rotatedDir[j];
    }

    std::cout << dir << " -> " << rotatedDir << std::endl;
  }


  // Write new directions to output file
  if (outputName.find(".bvec") != std::string::npos)
  {
    // std::cout << "Writing bvec file " << outputName << std::endl;
    std::ofstream outfile(outputName.c_str());


    if (transposeArray)
    {
      for (unsigned int i = 0; i < outputDirectionArray.cols(); i++)
      {
        for (unsigned int j = 0; j < outputDirectionArray.rows(); j++)
        {
          outfile << outputDirectionArray(j, i) << " ";
        }
        outfile << std::endl;
      }
    }
    else
    {
      for (unsigned int i = 0; i < outputDirectionArray.rows(); i++)
      {
        for (unsigned int j = 0; j < outputDirectionArray.cols(); j++)
        {
          outfile << outputDirectionArray(i, j) << " ";
        }
        outfile << std::endl;
      }
    }


    outfile.close();
  }
  else
  {
    std::cout << "WARNING - only bvec output currently supported" << std::endl;
  }

  return EXIT_SUCCESS;
}

void
antsMotionCorrDiffusionDirectionInitializeCommandLineOptions(itk::ants::CommandLineParser * parser)
{
  using OptionType = itk::ants::CommandLineParser::OptionType;

  {
    std::string description = std::string("Camino scheme file specificy acquisition parameters.");

    OptionType::Pointer option = OptionType::New();
    option->SetLongName("scheme");
    option->SetShortName('s');
    option->SetDescription(description);
    option->SetUsageOption(0, "dwi.scheme");
    parser->AddOption(option);
  }

  {
    std::string         description = std::string("bvec image specifying diffusion directions.");
    OptionType::Pointer option = OptionType::New();
    option->SetLongName("bvec");
    option->SetShortName('b');
    option->SetDescription(description);
    option->SetUsageOption(0, "dwi.bvec");
    parser->AddOption(option);
  }

  {
    std::string         description = std::string("3D image in dwi space");
    OptionType::Pointer option = OptionType::New();
    option->SetLongName("physical");
    option->SetShortName('p');
    option->SetDescription(description);
    option->SetUsageOption(0, "ref.nii.gz");
    parser->AddOption(option);
  }

  {
    std::string         description = std::string("motion correction parameters from antsMotionCorr.");
    OptionType::Pointer option = OptionType::New();
    option->SetLongName("moco");
    option->SetShortName('m');
    option->SetDescription(description);
    option->SetUsageOption(0, "MOCOparams.csv");
    parser->AddOption(option);
  }

  {
    std::string description = std::string("Specify the output file for corrected directions.");

    OptionType::Pointer option = OptionType::New();
    option->SetLongName("output");
    option->SetShortName('o');
    option->SetDescription(description);
    option->SetUsageOption(0, "corrected.scheme");
    parser->AddOption(option);
  }

  {
    std::string description = std::string("Print the help menu (short version).");

    OptionType::Pointer option = OptionType::New();
    option->SetShortName('h');
    option->SetDescription(description);
    option->AddFunction(std::string("0"));
    parser->AddOption(option);
  }

  {
    std::string description = std::string("Print the help menu.");

    OptionType::Pointer option = OptionType::New();
    option->SetLongName("help");
    option->SetDescription(description);
    option->AddFunction(std::string("0"));
    parser->AddOption(option);
  }
}

// entry point for the library; parameter 'args' is equivalent to 'argv' in (argc,argv) of commandline parameters to
// 'main()'
int
antsMotionCorrDiffusionDirection(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(), "antsMotionCorrDiffusionDirection");

  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 );

  itk::ants::CommandLineParser::Pointer parser = itk::ants::CommandLineParser::New();

  parser->SetCommand(argv[0]);

  std::string commandDescription = std::string("antsMotionCorrDiffusionDirection");
  parser->SetCommandDescription(commandDescription);
  antsMotionCorrDiffusionDirectionInitializeCommandLineOptions(parser);

  parser->Parse(argc, argv);

  if (argc < 2 || parser->Convert<bool>(parser->GetOption("help")->GetFunction()->GetName()))
  {
    parser->PrintMenu(std::cout, 5, false);
    if (argc < 2)
    {
      return EXIT_FAILURE;
    }
    return EXIT_SUCCESS;
  }
  else if (parser->Convert<bool>(parser->GetOption('h')->GetFunction()->GetName()))
  {
    parser->PrintMenu(std::cout, 5, true);
    return EXIT_SUCCESS;
  }

  std::cout << std::endl << "Running " << argv[0] << "  for 3-dimensional images." << std::endl << std::endl;

  return ants_motion_directions(parser);
}

} // namespace ants