itkGPUDemonsRegistrationFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkGPUDemonsRegistrationFilter_h
#define itkGPUDemonsRegistrationFilter_h
 
#include "itkOpenCLUtil.h"
#include "itkDemonsRegistrationFilter.h"
#include "itkGPUPDEDeformableRegistrationFilter.h"
#include "itkGPUDemonsRegistrationFunction.h"
#include "itkVersion.h"
#include "itkObjectFactoryBase.h"
 
namespace itk
{
template <typename TFixedImage,
          typename TMovingImage,
          typename TDisplacementField,
          typename TParentImageFilter = itk::DemonsRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>>
class ITK_TEMPLATE_EXPORT GPUDemonsRegistrationFilter
  : public GPUPDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUDemonsRegistrationFilter);

  using Self = GPUDemonsRegistrationFilter;
  using GPUSuperclass =
    GPUPDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField, TParentImageFilter>;
  using CPUSuperclass = TParentImageFilter;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GPUDemonsRegistrationFilter);

  using TimeStepType = typename GPUSuperclass::TimeStepType;

  using FixedImageType = typename GPUSuperclass::FixedImageType;
  using FixedImagePointer = typename GPUSuperclass::FixedImagePointer;

  using MovingImageType = typename GPUSuperclass::MovingImageType;
  using MovingImagePointer = typename GPUSuperclass::MovingImagePointer;

  using DisplacementFieldType = typename GPUSuperclass::DisplacementFieldType;
  using DisplacementFieldPointer = typename GPUSuperclass::DisplacementFieldPointer;

  using FiniteDifferenceFunctionType = typename GPUSuperclass::FiniteDifferenceFunctionType;

  using GPUDemonsRegistrationFunctionType =
    GPUDemonsRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>;

  double
  GetMetric() const override;

  void
  SetIntensityDifferenceThreshold(double) override;
 
  double
  GetIntensityDifferenceThreshold() const override;
 
protected:
  GPUDemonsRegistrationFilter();
  ~GPUDemonsRegistrationFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  InitializeIteration() override;

  void
  ApplyUpdate(const TimeStepType & dt) override;
 
private:
  bool m_UseMovingImageGradient{};
};

class GPUDemonsRegistrationFilterFactory : public itk::ObjectFactoryBase
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUDemonsRegistrationFilterFactory);
 
  using Self = GPUDemonsRegistrationFilterFactory;
  using GPUSuperclass = ObjectFactoryBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  const char *
  GetITKSourceVersion() const override
  {
    return ITK_SOURCE_VERSION;
  }
  const char *
  GetDescription() const override
  {
    return "A Factory for GPUDemonsRegistrationFilter";
  }


  itkFactorylessNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GPUDemonsRegistrationFilterFactory);

  static void
  RegisterOneFactory()
  {
    auto factory = GPUDemonsRegistrationFilterFactory::New();
 
    ObjectFactoryBase::RegisterFactory(factory);
  }
 
private:
#define OverrideDemonsRegistrationFilterTypeMacro(ipt, opt, dm)                                           \
  {                                                                                                       \
    using InputImageType = GPUImage<ipt, dm>;                                                             \
    using OutputImageType = GPUImage<opt, dm>;                                                            \
    using VectorPixelType = Vector<float, dm>;                                                            \
    using DisplacementFieldType = GPUImage<VectorPixelType, dm>;                                          \
    this->RegisterOverride(                                                                               \
      typeid(DemonsRegistrationFilter<InputImageType, OutputImageType, DisplacementFieldType>).name(),    \
      typeid(GPUDemonsRegistrationFilter<InputImageType, OutputImageType, DisplacementFieldType>).name(), \
      "GPU Demons Registration Filter Override",                                                          \
      true,                                                                                               \
      CreateObjectFunction<                                                                               \
        GPUDemonsRegistrationFilter<InputImageType, OutputImageType, DisplacementFieldType>>::New());     \
  }                                                                                                       \
  ITK_MACROEND_NOOP_STATEMENT
 
  GPUDemonsRegistrationFilterFactory()
  {
    if (IsGPUAvailable())
    {
      OverrideDemonsRegistrationFilterTypeMacro(unsigned char, unsigned char, 1);
      OverrideDemonsRegistrationFilterTypeMacro(char, char, 1);
      OverrideDemonsRegistrationFilterTypeMacro(float, float, 1);
      OverrideDemonsRegistrationFilterTypeMacro(int, int, 1);
      OverrideDemonsRegistrationFilterTypeMacro(unsigned int, unsigned int, 1);
      OverrideDemonsRegistrationFilterTypeMacro(double, double, 1);
 
      OverrideDemonsRegistrationFilterTypeMacro(unsigned char, unsigned char, 2);
      OverrideDemonsRegistrationFilterTypeMacro(char, char, 2);
      OverrideDemonsRegistrationFilterTypeMacro(float, float, 2);
      OverrideDemonsRegistrationFilterTypeMacro(int, int, 2);
      OverrideDemonsRegistrationFilterTypeMacro(unsigned int, unsigned int, 2);
      OverrideDemonsRegistrationFilterTypeMacro(double, double, 2);
 
      OverrideDemonsRegistrationFilterTypeMacro(unsigned char, unsigned char, 3);
      OverrideDemonsRegistrationFilterTypeMacro(char, char, 3);
      OverrideDemonsRegistrationFilterTypeMacro(float, float, 3);
      OverrideDemonsRegistrationFilterTypeMacro(int, int, 3);
      OverrideDemonsRegistrationFilterTypeMacro(unsigned int, unsigned int, 3);
      OverrideDemonsRegistrationFilterTypeMacro(double, double, 3);
    }
  }
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUDemonsRegistrationFilter.hxx"
#endif
 
#endif