itkTransformRigidityPenaltyTerm.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 __itkTransformRigidityPenaltyTerm_h
#define __itkTransformRigidityPenaltyTerm_h
 
#include "itkTransformPenaltyTerm.h"
 
#include "itkAdvancedBSplineDeformableTransform.h"
#include "itkAdvancedCombinationTransform.h"
 
#include "itkNeighborhood.h"
#include "itkImageRegionIterator.h"
#include "itkNeighborhoodOperatorImageFilter.h"
#include "itkNeighborhoodIterator.h"
 
#include "itkGrayscaleDilateImageFilter.h"
#include "itkBinaryBallStructuringElement.h"
#include "itkImageRegionIterator.h"
 
namespace itk
{
template< class TFixedImage, class TScalarType >
class TransformRigidityPenaltyTerm :
  public TransformPenaltyTerm< TFixedImage, TScalarType >
{
public:
 
  typedef TransformRigidityPenaltyTerm Self;
  typedef TransformPenaltyTerm<
    TFixedImage, TScalarType >            Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( TransformRigidityPenaltyTerm, 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::CombinationTransformType       CombinationTransformType;
  typedef typename Superclass::BSplineOrder1TransformType     BSplineOrder1TransformType;
  typedef typename Superclass::BSplineOrder1TransformPointer  BSplineOrder1TransformPointer;
  typedef typename Superclass::BSplineOrder2TransformType     BSplineOrder2TransformType;
  typedef typename Superclass::BSplineOrder2TransformPointer  BSplineOrder2TransformPointer;
  typedef typename Superclass::BSplineOrder3TransformType     BSplineOrder3TransformType;
  typedef typename Superclass::BSplineOrder3TransformPointer  BSplineOrder3TransformPointer;
 
  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 BSplineOrder3TransformType                 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 Neighborhood< ScalarType,
    itkGetStaticConstMacro( FixedImageDimension ) >     NeighborhoodType;
  typedef typename NeighborhoodType::SizeType           NeighborhoodSizeType;
  typedef ImageRegionIterator< CoefficientImageType >   CoefficientImageIteratorType;
  typedef NeighborhoodOperatorImageFilter<
    CoefficientImageType, CoefficientImageType >        NOIFType;
  typedef NeighborhoodIterator< CoefficientImageType >  NeighborhoodIteratorType;
  typedef typename NeighborhoodIteratorType::RadiusType RadiusType;
 
  typedef CoefficientImageType                     RigidityImageType;
  typedef typename RigidityImageType::Pointer      RigidityImagePointer;
  typedef typename RigidityImageType::PixelType    RigidityPixelType;
  typedef typename RigidityImageType::RegionType   RigidityImageRegionType;
  typedef typename RigidityImageType::IndexType    RigidityImageIndexType;
  typedef typename RigidityImageType::PointType    RigidityImagePointType;
  typedef ImageRegionIterator< RigidityImageType > RigidityImageIteratorType;
  typedef BinaryBallStructuringElement<
    RigidityPixelType,
    itkGetStaticConstMacro( FixedImageDimension ) >     StructuringElementType;
  typedef typename StructuringElementType::RadiusType SERadiusType;
  typedef GrayscaleDilateImageFilter<
    RigidityImageType, RigidityImageType,
    StructuringElementType >                            DilateFilterType;
  typedef typename DilateFilterType::Pointer DilateFilterPointer;
 
  void CheckUseAndCalculationBooleans( void );
 
  MeasureType GetValue(
    const ParametersType & parameters ) const override;
 
  void GetDerivative(
    const ParametersType & parameters,
    DerivativeType & derivative ) const override;
 
  void BeforeThreadedGetValueAndDerivative(
    const TransformParametersType & parameters ) const override;
 
  void GetValueAndDerivative(
    const ParametersType & parameters,
    MeasureType & value,
    DerivativeType & derivative ) const override;
 
  itkSetObjectMacro( BSplineTransform, BSplineTransformType );
 
  //itkSetObjectMacro( RigidityCoefficientImage, RigidityImageType );
 
  itkSetClampMacro( LinearityConditionWeight, ScalarType,
    0.0, NumericTraits< ScalarType >::max() );
  itkGetMacro( LinearityConditionWeight, ScalarType );
 
  itkSetClampMacro( OrthonormalityConditionWeight, ScalarType,
    0.0, NumericTraits< ScalarType >::max() );
  itkGetMacro( OrthonormalityConditionWeight, ScalarType );
 
  itkSetClampMacro( PropernessConditionWeight, ScalarType,
    0.0, NumericTraits< ScalarType >::max() );
  itkGetMacro( PropernessConditionWeight, ScalarType );
 
  itkSetMacro( UseLinearityCondition, bool );
 
  itkSetMacro( UseOrthonormalityCondition, bool );
 
  itkSetMacro( UsePropernessCondition, bool );
 
  itkSetMacro( CalculateLinearityCondition, bool );
 
  itkSetMacro( CalculateOrthonormalityCondition, bool );
 
  itkSetMacro( CalculatePropernessCondition, bool );
 
  itkGetConstReferenceMacro( LinearityConditionValue, MeasureType );
 
  itkGetConstReferenceMacro( OrthonormalityConditionValue, MeasureType );
 
  itkGetConstReferenceMacro( PropernessConditionValue, MeasureType );
 
  itkGetConstReferenceMacro( LinearityConditionGradientMagnitude, MeasureType );
 
  itkGetConstReferenceMacro( OrthonormalityConditionGradientMagnitude, MeasureType );
 
  itkGetConstReferenceMacro( PropernessConditionGradientMagnitude, MeasureType );
 
  //itkGetConstReferenceMacro( RigidityPenaltyTermValue, MeasureType );
 
  itkSetMacro( DilateRigidityImages, bool );
 
  itkSetClampMacro( DilationRadiusMultiplier, CoordinateRepresentationType,
    0.1, NumericTraits< CoordinateRepresentationType >::max() );
 
  itkSetObjectMacro( FixedRigidityImage, RigidityImageType );
 
  itkSetObjectMacro( MovingRigidityImage, RigidityImageType );
 
  itkSetMacro( UseFixedRigidityImage, bool );
 
  itkSetMacro( UseMovingRigidityImage, bool );
 
  void FillRigidityCoefficientImage( const ParametersType & parameters ) const;
 
protected:
 
  TransformRigidityPenaltyTerm();
  ~TransformRigidityPenaltyTerm() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
private:
 
  TransformRigidityPenaltyTerm( const Self & ); // purposely not implemented
  void operator=( const Self & );            // purposely not implemented
 
  virtual void DilateRigidityImages( void );
 
  void Create1DOperator( NeighborhoodType & F, const std::string & whichF,
    const unsigned int WhichDimension, const CoefficientImageSpacingType & spacing ) const;
 
  void CreateNDOperator( NeighborhoodType & F, const std::string & whichF,
    const CoefficientImageSpacingType & spacing ) const;
 
  CoefficientImagePointer FilterSeparable( const CoefficientImageType *,
    const std::vector< NeighborhoodType > & Operators ) const;
 
  BSplineTransformPointer m_BSplineTransform;
  ScalarType              m_LinearityConditionWeight;
  ScalarType              m_OrthonormalityConditionWeight;
  ScalarType              m_PropernessConditionWeight;
 
  mutable MeasureType m_RigidityPenaltyTermValue;
  mutable MeasureType m_LinearityConditionValue;
  mutable MeasureType m_OrthonormalityConditionValue;
  mutable MeasureType m_PropernessConditionValue;
  mutable MeasureType m_LinearityConditionGradientMagnitude;
  mutable MeasureType m_OrthonormalityConditionGradientMagnitude;
  mutable MeasureType m_PropernessConditionGradientMagnitude;
 
  bool m_UseLinearityCondition;
  bool m_UseOrthonormalityCondition;
  bool m_UsePropernessCondition;
  bool m_CalculateLinearityCondition;
  bool m_CalculateOrthonormalityCondition;
  bool m_CalculatePropernessCondition;
 
  CoordinateRepresentationType       m_DilationRadiusMultiplier;
  bool                               m_DilateRigidityImages;
  mutable bool                       m_RigidityCoefficientImageIsFilled;
  RigidityImagePointer               m_FixedRigidityImage;
  RigidityImagePointer               m_MovingRigidityImage;
  RigidityImagePointer               m_RigidityCoefficientImage;
  std::vector< DilateFilterPointer > m_FixedRigidityImageDilation;
  std::vector< DilateFilterPointer > m_MovingRigidityImageDilation;
  RigidityImagePointer               m_FixedRigidityImageDilated;
  RigidityImagePointer               m_MovingRigidityImageDilated;
  bool                               m_UseFixedRigidityImage;
  bool                               m_UseMovingRigidityImage;
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkTransformRigidityPenaltyTerm.hxx"
#endif
 
#endif // #ifndef __itkTransformRigidityPenaltyTerm_h