elxSplineKernelTransform.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 elxSplineKernelTransform_h
#define elxSplineKernelTransform_h
 
#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkKernelTransform2.h"
#include "itkElasticBodySplineKernelTransform2.h"
#include "itkElasticBodyReciprocalSplineKernelTransform2.h"
#include "itkThinPlateSplineKernelTransform2.h"
#include "itkThinPlateR2LogRSplineKernelTransform2.h"
#include "itkVolumeSplineKernelTransform2.h"
 
namespace elastix
{

 
template <typename TElastix>
class ITK_TEMPLATE_EXPORT SplineKernelTransform
  : public itk::AdvancedCombinationTransform<typename elx::TransformBase<TElastix>::CoordinateType,
                                             elx::TransformBase<TElastix>::FixedImageDimension>
  , public elx::TransformBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SplineKernelTransform);

  using Self = SplineKernelTransform;
  using Superclass1 = itk::AdvancedCombinationTransform<typename elx::TransformBase<TElastix>::CoordinateType,
                                                        elx::TransformBase<TElastix>::FixedImageDimension>;
  using Superclass2 = elx::TransformBase<TElastix>;

  using KernelTransformType = itk::KernelTransform2<typename elx::TransformBase<TElastix>::CoordinateType,
                                                    elx::TransformBase<TElastix>::FixedImageDimension>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SplineKernelTransform);

  elxClassNameMacro("SplineKernelTransform");

  itkStaticConstMacro(SpaceDimension, unsigned int, Superclass2::FixedImageDimension);

  using typename Superclass1::ScalarType;
  using typename Superclass1::ParametersType;
  using typename Superclass1::NumberOfParametersType;
  using typename Superclass1::JacobianType;
  using typename Superclass1::InputVectorType;
  using typename Superclass1::OutputVectorType;
  using typename Superclass1::InputCovariantVectorType;
  using typename Superclass1::OutputCovariantVectorType;
  using typename Superclass1::InputVnlVectorType;
  using typename Superclass1::OutputVnlVectorType;
  using typename Superclass1::InputPointType;
  using typename Superclass1::OutputPointType;

  using typename Superclass2::ElastixType;
  using typename Superclass2::ParameterMapType;
  using typename Superclass2::RegistrationType;
  using typename Superclass2::CoordinateType;
  using typename Superclass2::FixedImageType;
  using typename Superclass2::MovingImageType;
  using ITKBaseType = typename Superclass2::ITKBaseType;
  using CombinationTransformType = typename Superclass2::CombinationTransformType;

  using KernelTransformPointer = typename KernelTransformType::Pointer;
  using PointSetType = typename KernelTransformType::PointSetType;
  using PointSetPointer = typename PointSetType::Pointer;

  int
  BeforeAll() override;

  void
  BeforeRegistration() override;

  void
  ReadFromFile() override;
 
protected:
  SplineKernelTransform();
  ~SplineKernelTransform() override = default;
 
  using TPKernelTransformType = itk::ThinPlateSplineKernelTransform2<CoordinateType, Self::SpaceDimension>;
  using TPRKernelTransformType = itk::ThinPlateR2LogRSplineKernelTransform2<CoordinateType, Self::SpaceDimension>;
  using VKernelTransformType = itk::VolumeSplineKernelTransform2<CoordinateType, Self::SpaceDimension>;
  using EBKernelTransformType = itk::ElasticBodySplineKernelTransform2<CoordinateType, Self::SpaceDimension>;
  using EBRKernelTransformType = itk::ElasticBodyReciprocalSplineKernelTransform2<CoordinateType, Self::SpaceDimension>;

  virtual bool
  SetKernelType(const std::string & kernelType);

  virtual void
  DetermineSourceLandmarks();

  virtual bool
  DetermineTargetLandmarks();

  void
  ReadLandmarkFile(const std::string & filename, PointSetPointer & landmarkPointSet, const bool landmarksInFixedImage);

  KernelTransformPointer m_KernelTransform;
 
private:
  elxOverrideGetSelfMacro;

  ParameterMapType
  CreateDerivedTransformParameterMap() const override;
 
  std::string m_SplineKernelType;
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxSplineKernelTransform.hxx"
#endif
 
#endif // end #ifndef elxSplineKernelTransform_h