itkTransformPenaltyTerm.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 __itkTransformPenaltyTerm_h
#define __itkTransformPenaltyTerm_h
 
#include "itkAdvancedImageToImageMetric.h"
 
// Needed for checking for B-spline for faster implementation
#include "itkAdvancedBSplineDeformableTransform.h"
#include "itkAdvancedCombinationTransform.h"
 
namespace itk
{
template< class TFixedImage, class TScalarType = double >
class TransformPenaltyTerm :
  public AdvancedImageToImageMetric< TFixedImage, TFixedImage >
{
public:
 
  typedef TransformPenaltyTerm        Self;
  typedef AdvancedImageToImageMetric<
    TFixedImage, TFixedImage >        Superclass;
  typedef SmartPointer< Self >        Pointer;
  typedef SmartPointer< const Self >  ConstPointer;
 
  itkTypeMacro( TransformPenaltyTerm, AdvancedImageToImageMetric );
 
  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;
  // these not: use advanced transform below
  //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::ThreaderType                ThreaderType;
  typedef typename Superclass::ThreadInfoType              ThreadInfoType;
 
  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 TScalarType ScalarType; // \todo: not really meaningful name.
 
  typedef typename Superclass::AdvancedTransformType            TransformType;
  typedef typename TransformType::SpatialJacobianType           SpatialJacobianType;
  typedef typename TransformType::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;
  typedef typename TransformType::SpatialHessianType            SpatialHessianType;
  typedef typename TransformType::JacobianOfSpatialHessianType  JacobianOfSpatialHessianType;
  typedef typename TransformType::InternalMatrixType            InternalMatrixType;
 
  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::ImageDimension );
 
protected:
 
  typedef typename Superclass::FixedImageIndexType            FixedImageIndexType;
  typedef typename Superclass::FixedImageIndexValueType       FixedImageIndexValueType;
  typedef typename Superclass::MovingImageIndexType           MovingImageIndexType;
  typedef typename Superclass::FixedImagePointType            FixedImagePointType;
  typedef typename Superclass::MovingImagePointType           MovingImagePointType;
  typedef typename Superclass::MovingImageContinuousIndexType MovingImageContinuousIndexType;
  typedef typename Superclass::NonZeroJacobianIndicesType     NonZeroJacobianIndicesType;
 
  TransformPenaltyTerm(){}
 
  ~TransformPenaltyTerm() override {}
 
  virtual bool CheckForBSplineTransform2( BSplineOrder3TransformPointer & bspline ) const;
 
private:
 
  TransformPenaltyTerm( const Self & );  // purposely not implemented
  void operator=( const Self & );        // purposely not implemented
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkTransformPenaltyTerm.hxx"
#endif
 
#endif // #ifndef __itkTransformPenaltyTerm_h