frePointSupportedImageToImageMetric.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.0.7.2
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: frePointSupportedImageToImageMetric.h,v $
  Language:  C++
 
 
 
  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef __frePointSupportedImageToImageMetric_h
#define __frePointSupportedImageToImageMetric_h

#include "itkImageToImageMetric.h"
#include "itkPoint.h"
#include "itkImageBase.h"
#include "itkPointSet.h"


namespace itk
{
template < class TFixedImage, class TMovingImage, class TFixedPointSet, class TMovingPointSet>
class ITK_EXPORT PointSupportedImageToImageMetric :
            public ImageToImageMetric< TFixedImage, TMovingImage>
{
public:

    typedef PointSupportedImageToImageMetric    Self;
    typedef ImageToImageMetric<TFixedImage, TMovingImage >  Superclass;

    typedef SmartPointer<Self>         Pointer;
    typedef SmartPointer<const Self>   ConstPointer;

    itkNewMacro(Self);

    itkTypeMacro(PointSupportedImageToImageMetric, ImageToImageMetric);


    typedef typename Superclass::RealType                 RealType;
    typedef typename Superclass::TransformType            TransformType;
    typedef typename Superclass::TransformPointer         TransformPointer;
    typedef typename Superclass::TransformParametersType  TransformParametersType;
    typedef typename Superclass::TransformJacobianType    TransformJacobianType;
    typedef typename Superclass::InputPointType     InputPointType;
    typedef typename Superclass::OutputPointType    OutputPointType;

    typedef typename Superclass::MeasureType              MeasureType;
    typedef typename Superclass::DerivativeType           DerivativeType;
    typedef typename Superclass::FixedImageType           FixedImageType;
    typedef typename Superclass::MovingImageType          MovingImageType;
    typedef typename Superclass::FixedImageConstPointer   FixedImageConstPointer;
    typedef typename Superclass::MovingImageConstPointer  MovingImageConstPointer;

    typedef typename Superclass::InterpolatorType                                       InterpolatorType;
    typedef typename Superclass::InterpolatorPointer                    InterpolatorPointer;

    typedef ImageToImageMetric<TFixedImage, TMovingImage> ImageMetricType;
    typedef typename ImageMetricType::Pointer             ImageMetricPointer;

    typedef TFixedPointSet FixedPointSetType;
    typedef typename FixedPointSetType::ConstPointer              FixedPointSetConstPointer;

    typedef TMovingPointSet MovingPointSetType;
    typedef typename MovingPointSetType::ConstPointer             MovingPointSetConstPointer;

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

    MeasureType GetValue( const TransformParametersType & parameters ) const;

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

    itkGetConstMacro( Alpha, MeasureType );
    itkSetMacro( Alpha, MeasureType );

    itkGetConstMacro( LastImageMetricValue, MeasureType );
    itkGetConstMacro( LastPointMetricValue, MeasureType );

    itkGetConstMacro( LastImageDerivative, DerivativeType );
    itkGetConstMacro( LastPointDerivative, DerivativeType );

    itkSetConstObjectMacro( FixedPointSet, FixedPointSetType );

    itkGetConstObjectMacro( FixedPointSet, FixedPointSetType );

    itkSetConstObjectMacro( MovingPointSet, MovingPointSetType );

    itkGetConstObjectMacro( MovingPointSet, MovingPointSetType );

    itkSetObjectMacro( ImageMetric, ImageMetricType );

    itkGetObjectMacro( ImageMetric, ImageMetricType );

    virtual void Initialize(void) throw ( ExceptionObject );

protected:
    PointSupportedImageToImageMetric();
    virtual ~PointSupportedImageToImageMetric()
    {};

    MeasureType m_Alpha;

    mutable MeasureType m_LastImageMetricValue;
    mutable MeasureType m_LastPointMetricValue;

    mutable DerivativeType m_LastImageDerivative;
    mutable DerivativeType m_LastPointDerivative;

    MovingPointSetConstPointer m_MovingPointSet;
    FixedPointSetConstPointer m_FixedPointSet;

    ImageMetricPointer m_ImageMetric;

    void GetPointDerivative( const TransformParametersType & parameters,
                        DerivativeType & derivative ) const;

    MeasureType GetPointValue( const TransformParametersType & parameters ) const;

    void GetPointValueAndDerivative( const TransformParametersType & parameters,
                                MeasureType& Value, DerivativeType& Derivative ) const;

private:
    PointSupportedImageToImageMetric(const Self&); //purposely not implemented
    void operator=(const Self&); //purposely not implemented

};

} // end namespace FREE

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

#endif

---