elxOpenCLResampler.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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
{

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

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(OpenCLResampler);

  elxClassNameMacro("OpenCLResampler");

  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;

  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;

  void
  SetTransform(const TransformType * _arg) override;

  void
  SetInterpolator(InterpolatorType * _arg) override;

  void
  BeforeRegistration() override;

  void
  ReadFromFile() override;
 
protected:
  OpenCLResampler();
  ~OpenCLResampler() override = default;

  void
  BeforeGenerateData();

  void
  GenerateData() override;

  using InterpolatorPrecisionType = typename ResamplerBase<TElastix>::CoordinateType;
  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;

  using InterpolatorInputImageType = typename InterpolatorType::InputImageType;
  using InterpolatorCoordinateType = typename InterpolatorType::CoordinateType;
  using InterpolateImageFunctionType =
    itk::InterpolateImageFunction<InterpolatorInputImageType, InterpolatorCoordinateType>;
  using InterpolateCopierType =
    typename itk::GPUInterpolatorCopier<OpenCLImageTypes, OpenCLImageDimentions, InterpolateImageFunctionType, float>;
  using InterpolateCopierPointer = typename InterpolateCopierType::Pointer;
  using GPUExplicitInterpolatorPointer = typename InterpolateCopierType::GPUExplicitInterpolatorPointer;
 
private:
  elxOverrideGetSelfMacro;

  ParameterMapType
  CreateDerivedTransformParameterMap() const override;

  void
  SwitchingToCPUAndReport(const bool configError);

  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