itkGPUDemonsRegistrationFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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.
 *
 *=========================================================================*/
#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< class TFixedImage, class TMovingImage, class TDisplacementField,
          class TParentImageFilter = itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
          >
class ITK_EXPORT GPUDemonsRegistrationFilter :
  public GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage,
                                             TDisplacementField, TParentImageFilter >
{
public:
  typedef GPUDemonsRegistrationFilter Self;
  typedef GPUPDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField,
                                              TParentImageFilter > GPUSuperclass;
  typedef TParentImageFilter
  CPUSuperclass;
  typedef SmartPointer< Self >
  Pointer;
  typedef SmartPointer< const Self >
  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(GPUDemonsRegistrationFilter,
               GPUPDEDeformableRegistrationFilter);

  typedef typename GPUSuperclass::TimeStepType TimeStepType;

  typedef typename GPUSuperclass::FixedImageType    FixedImageType;
  typedef typename GPUSuperclass::FixedImagePointer FixedImagePointer;

  typedef typename GPUSuperclass::MovingImageType    MovingImageType;
  typedef typename GPUSuperclass::MovingImagePointer MovingImagePointer;

  typedef typename GPUSuperclass::DisplacementFieldType
  DisplacementFieldType;
  typedef typename GPUSuperclass::DisplacementFieldPointer
  DisplacementFieldPointer;

  typedef typename GPUSuperclass::FiniteDifferenceFunctionType
  FiniteDifferenceFunctionType;

  typedef GPUDemonsRegistrationFunction< FixedImageType, MovingImageType,
                                         DisplacementFieldType >  GPUDemonsRegistrationFunctionType;

  virtual double GetMetric() const;

  itkSetMacro(UseMovingImageGradient, bool);
  itkGetConstMacro(UseMovingImageGradient, bool);
  itkBooleanMacro(UseMovingImageGradient);

  virtual void SetIntensityDifferenceThreshold(double);

  virtual double GetIntensityDifferenceThreshold() const;

protected:
  GPUDemonsRegistrationFilter();
  ~GPUDemonsRegistrationFilter() {
  }
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void InitializeIteration();

  virtual void ApplyUpdate(const TimeStepType& dt);

private:
  GPUDemonsRegistrationFilter(const Self &); //purposely not implemented
  void operator=(const Self &);              //purposely not implemented

  bool m_UseMovingImageGradient;
};

class GPUDemonsRegistrationFilterFactory : public itk::ObjectFactoryBase
{
public:
  typedef GPUDemonsRegistrationFilterFactory Self;
  typedef ObjectFactoryBase                  GPUSuperclass;
  typedef SmartPointer<Self>                 Pointer;
  typedef SmartPointer<const Self>           ConstPointer;

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

  itkFactorylessNewMacro(Self);

  itkTypeMacro(GPUDemonsRegistrationFilterFactory, itk::ObjectFactoryBase);

  static void RegisterOneFactory(void)
  {
    GPUDemonsRegistrationFilterFactory::Pointer factory = GPUDemonsRegistrationFilterFactory::New();

    ObjectFactoryBase::RegisterFactory(factory);
  }

private:
  GPUDemonsRegistrationFilterFactory(const Self&); //purposely not implemented
  void operator=(const Self&);                     //purposely not implemented

#define OverrideDemonsRegistrationFilterTypeMacro(ipt,opt,dm) \
    { \
    typedef GPUImage<ipt,dm>                 InputImageType; \
    typedef GPUImage<opt,dm>                 OutputImageType; \
    typedef Vector< float, dm >              VectorPixelType; \
    typedef GPUImage<  VectorPixelType, dm > DisplacementFieldType; \
    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() ); \
    }

  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