itkLandmarkBasedTransformInitializer.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 itkLandmarkBasedTransformInitializer_h
#define itkLandmarkBasedTransformInitializer_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkVersorRigid3DTransform.h"
#include "itkRigid2DTransform.h"
#include "itkAffineTransform.h"
#include "itkBSplineTransform.h"
#include "itkPoint.h"
#include "itkPointSet.h"
#include "itkBSplineScatteredDataPointSetToImageFilter.h"
#include "itkVectorIndexSelectionCastImageFilter.h"
#include <vector>

namespace itk
{
template< typename TTransform,
          typename TFixedImage = itk::ImageBase<TTransform::InputSpaceDimension > ,
          typename TMovingImage = itk::ImageBase<TTransform::OutputSpaceDimension> >
class ITK_TEMPLATE_EXPORT LandmarkBasedTransformInitializer:
  public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LandmarkBasedTransformInitializer);

  using Self = LandmarkBasedTransformInitializer;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro(LandmarkBasedTransformInitializer, Object);

  using TransformType = TTransform;
  using TransformPointer = typename TransformType::Pointer;

  static constexpr unsigned int InputSpaceDimension = TransformType::InputSpaceDimension;
  static constexpr unsigned int OutputSpaceDimension = TransformType::OutputSpaceDimension;

  itkSetObjectMacro(Transform,   TransformType);

  using FixedImageType = TFixedImage;
  using MovingImageType = TMovingImage;

  itkSetConstObjectMacro(ReferenceImage,   FixedImageType);

  itkSetMacro(BSplineNumberOfControlPoints, unsigned int);

  using FixedImagePointer = typename FixedImageType::ConstPointer;
  using MovingImagePointer = typename MovingImageType::ConstPointer;

  static constexpr unsigned int ImageDimension = FixedImageType::ImageDimension;

  using InputPointType = typename TransformType::InputPointType;
  using OutputVectorType = typename TransformType::OutputVectorType;

  using LandmarkPointType = Point< double, ImageDimension >;
  using LandmarkPointContainer = std::vector< LandmarkPointType >;
  using PointsContainerConstIterator = typename LandmarkPointContainer::const_iterator;

  using ParametersType = typename TransformType::ParametersType;
  using ParametersValueType = typename ParametersType::ValueType;
  using LandmarkWeightType = std::vector< double >;
  using LandmarkWeightConstIterator = LandmarkWeightType::const_iterator;

  void SetFixedLandmarks(const LandmarkPointContainer & fixedLandmarks)
  {
    this->m_FixedLandmarks = fixedLandmarks;
  }

  void SetMovingLandmarks(const LandmarkPointContainer & movingLandmarks)
  {
    this->m_MovingLandmarks = movingLandmarks;
  }

  void SetLandmarkWeight(LandmarkWeightType & landmarkWeight)
  {
    this->m_LandmarkWeight= landmarkWeight;
  }

  using VersorRigid3DTransformType = VersorRigid3DTransform< ParametersValueType >;
  using Rigid2DTransformType = Rigid2DTransform< ParametersValueType >;
  using AffineTransformType = AffineTransform< ParametersValueType, FixedImageType::ImageDimension >;

  constexpr static unsigned int SplineOrder  = 3;
  using BSplineTransformType = BSplineTransform< ParametersValueType,
                            FixedImageType::ImageDimension,
                            SplineOrder>;

  virtual void InitializeTransform();

protected:
  LandmarkBasedTransformInitializer();
  ~LandmarkBasedTransformInitializer() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const override;

private:

  template <typename TTransform2>
  void InternalInitializeTransform(TTransform2 *);

  void InternalInitializeTransform(VersorRigid3DTransformType *);

  void InternalInitializeTransform(Rigid2DTransformType *);

  void InternalInitializeTransform(AffineTransformType *);

  void InternalInitializeTransform(BSplineTransformType *);

  FixedImagePointer      m_ReferenceImage;
  TransformPointer       m_Transform;
  LandmarkPointContainer m_FixedLandmarks;
  LandmarkPointContainer m_MovingLandmarks;
  LandmarkWeightType     m_LandmarkWeight;
  unsigned int           m_BSplineNumberOfControlPoints{4};

}; //class LandmarkBasedTransformInitializer
}  // namespace itk

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

#endif /* itkLandmarkBasedTransformInitializer_h */