itkFiniteDifferenceGradientSimilarityMeasure.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 itkFiniteDifferenceGradientSimilarityMeasure_h
#define itkFiniteDifferenceGradientSimilarityMeasure_h

#include "itkSimilarityMeasure.h"


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

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

  itkTypeMacro(FiniteDifferenceGradientSimilarityMeasure, SimilarityMeasure);

  typedef Array<double> ScalesType;

  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::TransformType              TransformType;
  typedef typename Superclass::TransformParametersType    TransformParametersType;
  typedef typename Superclass::MeasureType                MeasureType;
  
  virtual void GetCostFunctionDerivative( const TransformParametersType & parameters, DerivativeType  & derivative ) const;

  void SetTransform( TransformType * transform );

  itkSetMacro( DerivativeStepLength, double );

  itkGetMacro( DerivativeStepLength, double );

  itkSetMacro( DerivativeStepLengthScales, ScalesType );

  itkGetConstReferenceMacro(DerivativeStepLengthScales, ScalesType);

  itkSetMacro(UseDerivativeScaleArray, bool);
  itkGetMacro(UseDerivativeScaleArray, bool);
  
protected:
  
  FiniteDifferenceGradientSimilarityMeasure();
  virtual ~FiniteDifferenceGradientSimilarityMeasure() {};
  void PrintSelf(std::ostream& os, Indent indent) const;

private:
  
  FiniteDifferenceGradientSimilarityMeasure(const Self&); // purposefully not implemented
  void operator=(const Self&);                            // purposefully not implemented

  bool m_UseDerivativeScaleArray;
  
  double m_DerivativeStepLength;

  ScalesType m_DerivativeStepLengthScales;

};

} // end namespace itk

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

#endif