itkJacobianGradientSimilarityMeasure.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkJacobianGradientSimilarityMeasure_h
#define itkJacobianGradientSimilarityMeasure_h

#include "itkSimilarityMeasure.h"


namespace itk
{
template < typename TFixedImage, typename TMovingImage > 
class ITK_EXPORT JacobianGradientSimilarityMeasure : 
    public SimilarityMeasure< TFixedImage, TMovingImage>
{
public:

  typedef JacobianGradientSimilarityMeasure              Self;
  typedef SimilarityMeasure<TFixedImage, TMovingImage >  Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkTypeMacro(JacobianGradientSimilarityMeasure, SimilarityMeasure);

  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImageConstPointer     FixedImageConstPointer;
  typedef typename Superclass::GradientImageType          GradientImageType;
  typedef typename Superclass::GradientPixelType          GradientPixelType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;
  typedef typename Superclass::RealType                   RealType;
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::TransformParametersType    TransformParametersType;
  typedef typename Superclass::TransformJacobianType      TransformJacobianType;
  
  void GetCostFunctionDerivative( const TransformParametersType & parameters, DerivativeType  & derivative ) const;

protected:
  
  JacobianGradientSimilarityMeasure();
  virtual ~JacobianGradientSimilarityMeasure() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

  virtual void ResetDerivativeComputations() {};
  
  virtual void ComputeDerivativeValue(
      DerivativeType  & derivative,               // The array of derivatives, one per parameter
      const GradientPixelType & gradientPixel,    // The gradient at the moving image pixel
      const TransformJacobianType & jacobianType, // The jacobian at that moving image pixel    
      unsigned int imageDimensions,               // The number of dimensions (ie. 2D or 3D)
      unsigned int parameterNumber,               // Which parameter are we operating on?
      RealType fixedValue,                        // The fixed image value
      RealType movingValue) { }                   // The moving image value
  
  virtual void FinalizeDerivative(DerivativeType  & derivative) {};
  
private:
  
  JacobianGradientSimilarityMeasure(const Self&); // purposefully not implemented
  void operator=(const Self&);                    // purposefully not implemented

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkJacobianGradientSimilarityMeasure.txx"
#endif

#endif