itkDistancePreservingRigidityPenaltyTerm.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 itkDistancePreservingRigidityPenaltyTerm_h
#define itkDistancePreservingRigidityPenaltyTerm_h
 
#include "itkTransformPenaltyTerm.h"

#include "itkAdvancedBSplineDeformableTransform.h"
#include "itkAdvancedCombinationTransform.h"

#include "itkNeighborhood.h"
#include "itkImageRegionIterator.h"
#include "itkNeighborhoodOperatorImageFilter.h"
#include "itkNeighborhoodIterator.h"
 
#include "itkImageRegionIterator.h"
#include "itkMultiResolutionPyramidImageFilter.h"
 
namespace itk
{
 
template <typename TFixedImage, typename TScalarType>
class ITK_TEMPLATE_EXPORT DistancePreservingRigidityPenaltyTerm : public TransformPenaltyTerm<TFixedImage, TScalarType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(DistancePreservingRigidityPenaltyTerm);

  using Self = DistancePreservingRigidityPenaltyTerm;
  using Superclass = TransformPenaltyTerm<TFixedImage, TScalarType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DistancePreservingRigidityPenaltyTerm);

  using typename Superclass::CoordinateRepresentationType;
  using typename Superclass::MovingImageType;
  using typename Superclass::MovingImagePixelType;
  using typename Superclass::MovingImagePointer;
  using typename Superclass::MovingImageConstPointer;
  using typename Superclass::FixedImageType;
  using typename Superclass::FixedImagePointer;
  using typename Superclass::FixedImageConstPointer;
  using typename Superclass::FixedImageRegionType;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;
  using typename Superclass::TransformJacobianType;
  using typename Superclass::InterpolatorType;
  using typename Superclass::InterpolatorPointer;
  using typename Superclass::RealType;
  using typename Superclass::GradientPixelType;
  using typename Superclass::GradientImageType;
  using typename Superclass::GradientImagePointer;
  using typename Superclass::FixedImageMaskType;
  using typename Superclass::FixedImageMaskPointer;
  using typename Superclass::MovingImageMaskType;
  using typename Superclass::MovingImageMaskPointer;
  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::DerivativeValueType;
  using typename Superclass::ParametersType;
  using typename Superclass::FixedImagePixelType;
  using typename Superclass::ImageSampleContainerType;
  using typename Superclass::ImageSampleContainerPointer;
  using typename Superclass::ScalarType;

  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::InternalMatrixType;

  itkStaticConstMacro(FixedImageDimension, unsigned int, FixedImageType::ImageDimension);
  itkStaticConstMacro(MovingImageDimension, unsigned int, FixedImageType::ImageDimension);
  itkStaticConstMacro(ImageDimension, unsigned int, FixedImageType::ImageDimension);

  void
  Initialize() override;

  using BSplineTransformType = AdvancedBSplineDeformableTransform<ScalarType, FixedImageDimension, 3>;
  using BSplineTransformPointer = typename BSplineTransformType::Pointer;
  using GridSpacingType = typename BSplineTransformType::SpacingType;
  using CoefficientImageType = typename BSplineTransformType::ImageType;
  using CoefficientImagePointer = typename CoefficientImageType::Pointer;
  using CoefficientImageSpacingType = typename CoefficientImageType::SpacingType;
  using CombinationTransformType = AdvancedCombinationTransform<ScalarType, FixedImageDimension>;

  MeasureType
  GetValue(const ParametersType & parameters) const override;

  void
  GetDerivative(const ParametersType & parameters, DerivativeType & derivative) const override;

  void
  GetValueAndDerivative(const ParametersType & parameters,
                        MeasureType &          value,
                        DerivativeType &       derivative) const override;

  itkSetObjectMacro(BSplineTransform, BSplineTransformType);

  using BSplineKnotImageType = Image<signed short, Self::MovingImageDimension>;
  using BSplineKnotImagePointer = typename BSplineKnotImageType::Pointer;
  using BSplineKnotImageRegionType = typename BSplineKnotImageType::RegionType;

  using PenaltyGridImageType = Image<signed short, Self::MovingImageDimension>;
  using PenaltyGridImagePointer = typename PenaltyGridImageType::Pointer;
  using PenaltyGridImageRegionType = typename PenaltyGridImageType::RegionType;

  using SegmentedImageType = Image<signed short, Self::MovingImageDimension>;
  using SegmentedImagePointer = typename SegmentedImageType::Pointer;
  using SegmentedImageRegionType = typename SegmentedImageType::RegionType;

  itkSetObjectMacro(SegmentedImage, SegmentedImageType);

  itkGetModifiableObjectMacro(SegmentedImage, SegmentedImageType);

  itkSetObjectMacro(SampledSegmentedImage, SegmentedImageType);

  itkGetModifiableObjectMacro(SampledSegmentedImage, SegmentedImageType);
 
  itkGetConstMacro(NumberOfRigidGrids, unsigned int);
 
protected:
  DistancePreservingRigidityPenaltyTerm();

  ~DistancePreservingRigidityPenaltyTerm() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  BSplineTransformPointer m_BSplineTransform{};
 
  mutable MeasureType m_RigidityPenaltyTermValue{};
 
  BSplineKnotImagePointer m_BSplineKnotImage{};
  PenaltyGridImagePointer m_PenaltyGridImage{};
  SegmentedImagePointer   m_SegmentedImage{};
  SegmentedImagePointer   m_SampledSegmentedImage{};
 
  unsigned int m_NumberOfRigidGrids{};
};
 
// end class DistancePreservingRigidityPenaltyTerm
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkDistancePreservingRigidityPenaltyTerm.hxx"
#endif
 
#endif // #ifndef itkDistancePreservingRigidityPenaltyTerm_h