File: elxOpenCLResampler.h

package info (click to toggle)
elastix 5.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,480 kB
  • sloc: cpp: 68,403; lisp: 4,118; python: 1,013; xml: 182; sh: 177; makefile: 33
file content (187 lines) | stat: -rw-r--r-- 7,106 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
/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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.
 *
 *=========================================================================*/
#ifndef elxOpenCLResampler_h
#define elxOpenCLResampler_h

#include "elxIncludes.h" // include first to avoid MSVS warning
#include "elxOpenCLSupportedImageTypes.h"

#include "itkGPUResampleImageFilter.h"
#include "itkGPUAdvancedCombinationTransformCopier.h"
#include "itkGPUInterpolatorCopier.h"

namespace elastix
{

/**
 * \class OpenCLResampler
 * \brief A resampler based on the itk::GPUResampleImageFilter.
 * The parameters used in this class are:
 * \parameter Resampler: Select this resampler as follows:\n
 *    <tt>(Resampler "OpenCLResampler")</tt>
 * \parameter Resampler: Enable the OpenCL resampler as follows:\n
 *    <tt>(OpenCLResamplerUseOpenCL "true")</tt>
 *
 * \author Denis P. Shamonin and Marius Staring. Division of Image Processing,
 * Department of Radiology, Leiden, The Netherlands
 *
 * \note This work was funded by the Netherlands Organisation for
 * Scientific Research (NWO NRG-2010.02 and NWO 639.021.124).
 *
 * \ingroup Resamplers
 */

template <class TElastix>
class OpenCLResampler
  : public itk::ResampleImageFilter<typename ResamplerBase<TElastix>::InputImageType,
                                    typename ResamplerBase<TElastix>::OutputImageType,
                                    typename ResamplerBase<TElastix>::CoordRepType>
  , public ResamplerBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(OpenCLResampler);

  /** Standard ITK-stuff. */
  using Self = OpenCLResampler;

  using Superclass1 = itk::ResampleImageFilter<typename ResamplerBase<TElastix>::InputImageType,
                                               typename ResamplerBase<TElastix>::OutputImageType,
                                               typename ResamplerBase<TElastix>::CoordRepType>;
  using Superclass2 = ResamplerBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkTypeMacro(OpenCLResampler, ResampleImageFilter);

  /** Name of this class.
   * Use this name in the parameter file to select this specific resampler. \n
   * example: <tt>(Resampler "OpenCLResampler")</tt>\n
   */
  elxClassNameMacro("OpenCLResampler");

  /** Typedefs inherited from the superclass. */
  using typename Superclass1::InterpolatorType;
  using typename Superclass1::TransformType;

  using typename Superclass1::InputImageType;
  using InputImagePixelType = typename InputImageType::PixelType;

  using typename Superclass1::OutputImageType;
  using OutputImagePixelType = typename OutputImageType::PixelType;
  using OutputImageRegionType = typename OutputImageType::RegionType;

  /** GPU Typedefs for GPU image and GPU resampler. */
  using GPUInputImageType = itk::GPUImage<InputImagePixelType, InputImageType::ImageDimension>;
  using GPUInputImagePointer = typename GPUInputImageType::Pointer;
  using GPUOutputImageType = itk::GPUImage<OutputImagePixelType, OutputImageType::ImageDimension>;
  using GPUInterpolatorPrecisionType = float;

  using GPUResamplerType =
    itk::GPUResampleImageFilter<GPUInputImageType, GPUOutputImageType, GPUInterpolatorPrecisionType>;
  using GPUResamplerPointer = typename GPUResamplerType::Pointer;

  using typename Superclass2::ParameterMapType;

  /** Set the transform. */
  void
  SetTransform(const TransformType * _arg) override;

  /** Set the interpolator. */
  void
  SetInterpolator(InterpolatorType * _arg) override;

  /** Do some things before registration. */
  void
  BeforeRegistration() override;

  /** Function to read parameters from a file. */
  void
  ReadFromFile() override;

protected:
  /** The constructor. */
  OpenCLResampler();
  /** The destructor. */
  ~OpenCLResampler() override = default;

  /** This method performs all configuration for GPU resampler. */
  void
  BeforeGenerateData();

  /** Executes GPU resampler. */
  void
  GenerateData() override;

  /** Transform copier */
  using InterpolatorPrecisionType = typename ResamplerBase<TElastix>::CoordRepType;
  using AdvancedCombinationTransformType =
    typename itk::AdvancedCombinationTransform<InterpolatorPrecisionType, OutputImageType::ImageDimension>;
  using TransformCopierType = typename itk::GPUAdvancedCombinationTransformCopier<OpenCLImageTypes,
                                                                                  OpenCLImageDimentions,
                                                                                  AdvancedCombinationTransformType,
                                                                                  float>;
  using TransformCopierPointer = typename TransformCopierType::Pointer;
  using GPUTransformPointer = typename TransformCopierType::GPUComboTransformPointer;

  /** Interpolator copier */
  using InterpolatorInputImageType = typename InterpolatorType::InputImageType;
  using InterpolatorCoordRepType = typename InterpolatorType::CoordRepType;
  using InterpolateImageFunctionType =
    itk::InterpolateImageFunction<InterpolatorInputImageType, InterpolatorCoordRepType>;
  using InterpolateCopierType =
    typename itk::GPUInterpolatorCopier<OpenCLImageTypes, OpenCLImageDimentions, InterpolateImageFunctionType, float>;
  using InterpolateCopierPointer = typename InterpolateCopierType::Pointer;
  using GPUExplicitInterpolatorPointer = typename InterpolateCopierType::GPUExplicitInterpolatorPointer;

private:
  elxOverrideGetSelfMacro;

  /** Creates a map of the parameters specific for this (derived) resampler type. */
  ParameterMapType
  CreateDerivedTransformParameterMap() const override;

  /** Helper method to report switching to CPU mode. */
  void
  SwitchingToCPUAndReport(const bool configError);

  /** Helper method to report to elastix log. */
  void
  ReportToLog();

  TransformCopierPointer   m_TransformCopier;
  InterpolateCopierPointer m_InterpolatorCopier;
  GPUResamplerPointer      m_GPUResampler;
  bool                     m_GPUResamplerReady;
  bool                     m_GPUResamplerCreated;
  bool                     m_ContextCreated;
  bool                     m_UseOpenCL;
};

// end class OpenCLResampler

} // end namespace elastix

#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxOpenCLResampler.hxx"
#endif

#endif // end #ifndef elxOpenCLResampler_h