itkImageToImageMetricWithConstraint.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 itkImageToImageMetricWithConstraint_h
#define itkImageToImageMetricWithConstraint_h

#include <itkImageToImageMetric.h>
#include <itkConstraint.h>
#include "itkMetricDerivativeBridge.h"

namespace itk
{
template < typename TFixedImage, typename TMovingImage > 
class ITK_EXPORT ImageToImageMetricWithConstraint : 
    public ImageToImageMetric< TFixedImage, TMovingImage>
{
public:

  typedef ImageToImageMetricWithConstraint                  Self;
  typedef ImageToImageMetric<TFixedImage, TMovingImage >    Superclass;
  typedef SmartPointer<Self>                                Pointer;
  typedef SmartPointer<const Self>                          ConstPointer;

  typedef itk::Constraint                                   ConstraintType;
  typedef typename ConstraintType::Pointer                  ConstraintPointer;

  typedef MetricDerivativeBridge<TFixedImage, TMovingImage> MetricDerivativeBridgeType;
  typedef typename MetricDerivativeBridgeType::Pointer      MetricDerivativePointer;
  
  typedef typename Superclass::MeasureType                  MeasureType;
  typedef typename Superclass::DerivativeType               DerivativeType;
  typedef typename Superclass::ParametersType               TransformParametersType;
  
  itkTypeMacro(ImageToImageMetricWithConstraint, ImageToImageMetric);

  itkSetObjectMacro(DerivativeBridge, MetricDerivativeBridgeType);
  itkGetObjectMacro(DerivativeBridge, MetricDerivativeBridgeType);

  itkSetObjectMacro( Constraint, ConstraintType );
  itkGetObjectMacro( Constraint, ConstraintType );

  itkSetMacro( WeightingFactor, double );
  itkGetMacro( WeightingFactor, double );

  itkSetMacro( UseConstraintGradient, bool );
  itkGetConstMacro( UseConstraintGradient, bool );

  itkSetMacro( PrintOutMetricEvaluation, bool );
  itkGetMacro( PrintOutMetricEvaluation, bool );

  virtual MeasureType GetValue( const TransformParametersType & parameters ) const;

  virtual void GetConstraintDerivative( const TransformParametersType & parameters, DerivativeType  & derivative ) const;
  
  virtual void GetDerivative( const TransformParametersType & parameters, DerivativeType  & derivative ) const;

  virtual void GetValueAndDerivative( const TransformParametersType & parameters, MeasureType& Value, DerivativeType& derivative ) const;

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

  virtual MeasureType GetSimilarity( const TransformParametersType & parameters ) const = 0;
  
  virtual void GetCostFunctionDerivative( const TransformParametersType & parameters, DerivativeType  & derivative ) const = 0;

  MetricDerivativePointer m_DerivativeBridge;
  
  ConstraintPointer m_Constraint;

  double m_WeightingFactor;

  bool m_UseConstraintGradient;
  
  bool m_PrintOutMetricEvaluation;
  
};

} // end namespace itk

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

#endif