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< class TFixedImage, class TScalarType >
class DistancePreservingRigidityPenaltyTerm :
  public TransformPenaltyTerm< TFixedImage, TScalarType >
{
public:
 
  typedef DistancePreservingRigidityPenaltyTerm            Self;
  typedef TransformPenaltyTerm< TFixedImage, TScalarType > Superclass;
  typedef SmartPointer< Self >                             Pointer;
  typedef SmartPointer< const Self >                       ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( DistancePreservingRigidityPenaltyTerm, TransformPenaltyTerm );
 
  typedef typename Superclass::CoordinateRepresentationType CoordinateRepresentationType;
  typedef typename Superclass::MovingImageType              MovingImageType;
  typedef typename Superclass::MovingImagePixelType         MovingImagePixelType;
  typedef typename Superclass::MovingImagePointer           MovingImagePointer;
  typedef typename Superclass::MovingImageConstPointer      MovingImageConstPointer;
  typedef typename Superclass::FixedImageType               FixedImageType;
  typedef typename Superclass::FixedImagePointer            FixedImagePointer;
  typedef typename Superclass::FixedImageConstPointer       FixedImageConstPointer;
  typedef typename Superclass::FixedImageRegionType         FixedImageRegionType;
  typedef typename Superclass::TransformType                TransformType;
  typedef typename Superclass::TransformPointer             TransformPointer;
  typedef typename Superclass::InputPointType               InputPointType;
  typedef typename Superclass::OutputPointType              OutputPointType;
  typedef typename Superclass::TransformParametersType      TransformParametersType;
  typedef typename Superclass::TransformJacobianType        TransformJacobianType;
  typedef typename Superclass::InterpolatorType             InterpolatorType;
  typedef typename Superclass::InterpolatorPointer          InterpolatorPointer;
  typedef typename Superclass::RealType                     RealType;
  typedef typename Superclass::GradientPixelType            GradientPixelType;
  typedef typename Superclass::GradientImageType            GradientImageType;
  typedef typename Superclass::GradientImagePointer         GradientImagePointer;
  typedef typename Superclass::GradientImageFilterType      GradientImageFilterType;
  typedef typename Superclass::GradientImageFilterPointer   GradientImageFilterPointer;
  typedef typename Superclass::FixedImageMaskType           FixedImageMaskType;
  typedef typename Superclass::FixedImageMaskPointer        FixedImageMaskPointer;
  typedef typename Superclass::MovingImageMaskType          MovingImageMaskType;
  typedef typename Superclass::MovingImageMaskPointer       MovingImageMaskPointer;
  typedef typename Superclass::MeasureType                  MeasureType;
  typedef typename Superclass::DerivativeType               DerivativeType;
  typedef typename Superclass::DerivativeValueType          DerivativeValueType;
  typedef typename Superclass::ParametersType               ParametersType;
  typedef typename Superclass::FixedImagePixelType          FixedImagePixelType;
  typedef typename Superclass::ImageSampleContainerType     ImageSampleContainerType;
  typedef typename Superclass::ImageSampleContainerPointer  ImageSampleContainerPointer;
  typedef typename Superclass::ScalarType                   ScalarType;
 
  typedef typename Superclass::SpatialJacobianType           SpatialJacobianType;
  typedef typename Superclass::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;
  typedef typename Superclass::SpatialHessianType            SpatialHessianType;
  typedef typename Superclass::JacobianOfSpatialHessianType  JacobianOfSpatialHessianType;
  typedef typename Superclass::InternalMatrixType            InternalMatrixType;
 
  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::ImageDimension );
  itkStaticConstMacro( MovingImageDimension, unsigned int, FixedImageType::ImageDimension );
  itkStaticConstMacro( ImageDimension, unsigned int, FixedImageType::ImageDimension );
 
  void Initialize( void ) override;
 
  typedef AdvancedBSplineDeformableTransform< ScalarType, FixedImageDimension, 3 > BSplineTransformType;
  typedef typename BSplineTransformType::Pointer                                   BSplineTransformPointer;
  typedef typename BSplineTransformType::SpacingType                               GridSpacingType;
  typedef typename BSplineTransformType::ImageType                                 CoefficientImageType;
  typedef typename CoefficientImageType::Pointer                                   CoefficientImagePointer;
  typedef typename CoefficientImageType::SpacingType                               CoefficientImageSpacingType;
  typedef AdvancedCombinationTransform< ScalarType, FixedImageDimension >          CombinationTransformType;
 
  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 );
 
  typedef Image< signed short, itkGetStaticConstMacro( MovingImageDimension ) > BSplineKnotImageType;
  typedef typename BSplineKnotImageType::Pointer                                BSplineKnotImagePointer;
  typedef typename BSplineKnotImageType::RegionType                             BSplineKnotImageRegionType;
 
  typedef Image< signed short, itkGetStaticConstMacro( MovingImageDimension ) > PenaltyGridImageType;
  typedef typename PenaltyGridImageType::Pointer                                PenaltyGridImagePointer;
  typedef typename PenaltyGridImageType::RegionType                             PenaltyGridImageRegionType;
 
  typedef Image< signed short, itkGetStaticConstMacro( MovingImageDimension ) > SegmentedImageType;
  typedef typename SegmentedImageType::Pointer                                  SegmentedImagePointer;
  typedef typename SegmentedImageType::RegionType                               SegmentedImageRegionType;
 
  itkSetObjectMacro( SegmentedImage, SegmentedImageType );
 
  itkGetModifiableObjectMacro( SegmentedImage, SegmentedImageType );
 
  itkSetObjectMacro( SampledSegmentedImage, SegmentedImageType );
 
  itkGetModifiableObjectMacro( SampledSegmentedImage, SegmentedImageType );
 
  itkGetMacro( NumberOfRigidGrids, unsigned int );
 
protected:
 
  DistancePreservingRigidityPenaltyTerm();
 
  ~DistancePreservingRigidityPenaltyTerm() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
private:
 
  DistancePreservingRigidityPenaltyTerm( const Self & ); // purposely not implemented
 
  void operator=( const Self & );                        // purposely not implemented
 
  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