itkImageToSpatialObjectMetric.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageToSpatialObjectMetric.h,v $
  Language:  C++
  Date:      $Date: 2009-01-24 20:02:56 $
  Version:   $Revision: 1.11 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/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 __itkImageToSpatialObjectMetric_h
#define __itkImageToSpatialObjectMetric_h

#include "itkSingleValuedCostFunction.h"
#include "itkMinimumMaximumImageCalculator.h"
#include "itkLinearInterpolateImageFunction.h"
#include "vnl/vnl_vector_fixed.h"

namespace itk
{
  
template < class TFixedImage, class TMovingSpatialObject> 
class ITK_EXPORT ImageToSpatialObjectMetric 
  : public SingleValuedCostFunction
{
public:
  typedef ImageToSpatialObjectMetric  Self;
  typedef SingleValuedCostFunction    Superclass;
  typedef SmartPointer<Self>          Pointer;
  typedef SmartPointer<const Self>    ConstPointer;

  typedef TFixedImage          FixedImageType;

  typedef TMovingSpatialObject  MovingSpatialObjectType;

  typedef Superclass::ParametersValueType CoordinateRepresentationType;

  itkStaticConstMacro(ImageDimension, unsigned int,
                      FixedImageType::ImageDimension);

  itkStaticConstMacro(ObjectDimension, unsigned int,
                      MovingSpatialObjectType::ObjectDimension);

  typedef Transform<CoordinateRepresentationType, 
                    itkGetStaticConstMacro(ObjectDimension),
                    itkGetStaticConstMacro(ImageDimension) > TransformType;

  typedef typename TransformType::Pointer            TransformPointer;
  typedef typename TransformType::InputPointType     InputPointType;
  typedef typename TransformType::OutputPointType    OutputPointType;
  typedef typename TransformType::ParametersType     TransformParametersType;
  typedef typename TransformType::JacobianType       TransformJacobianType;

  typedef LinearInterpolateImageFunction<
    TFixedImage,
    CoordinateRepresentationType > InterpolatorType;

  typedef typename InterpolatorType::Pointer         InterpolatorPointer;

  typedef vnl_vector_fixed<double,
                           itkGetStaticConstMacro(ObjectDimension)> VectorType;

  typedef Superclass::MeasureType          MeasureType;

  typedef Superclass::DerivativeType   DerivativeType; 

  typedef typename FixedImageType::Pointer    FixedImagePointer;

  typedef typename MovingSpatialObjectType::Pointer  
  MovingSpatialObjectPointer;

  typedef typename FixedImageType::ConstPointer   FixedImageConstPointer;

  typedef typename MovingSpatialObjectType::ConstPointer MovingSpatialObjectConstPointer;

  typedef Superclass::ParametersType         ParametersType;

  itkTypeMacro(ImageToSpatialObjectMetric, Object);

  itkSetConstObjectMacro( FixedImage, FixedImageType );

  itkGetConstObjectMacro( FixedImage, FixedImageType );

  itkSetConstObjectMacro( MovingSpatialObject, MovingSpatialObjectType );

  itkGetConstObjectMacro( MovingSpatialObject, MovingSpatialObjectType );

  itkSetObjectMacro( Interpolator, InterpolatorType );

  itkGetObjectMacro( Interpolator, InterpolatorType );

  virtual void GetDerivative( const ParametersType & parameters,
                              DerivativeType & derivative ) const = 0;

  virtual MeasureType    GetValue( const ParametersType & parameters ) const =0;

  virtual void GetValueAndDerivative( const ParametersType & parameters,
                                      MeasureType & Value, 
                                      DerivativeType  & Derivative ) const =0;

  virtual void Initialize(void) throw (ExceptionObject);

  itkGetConstReferenceMacro( LastTransformParameters, ParametersType );

  itkSetObjectMacro( Transform, TransformType );

protected:

  ImageToSpatialObjectMetric();
  virtual ~ImageToSpatialObjectMetric() {};
  ImageToSpatialObjectMetric(const Self&) {}
  void operator=(const Self&) {}
  void PrintSelf(std::ostream& os, Indent indent) const;

  MeasureType                 m_MatchMeasure;
  DerivativeType              m_MatchMeasureDerivatives;
  mutable TransformPointer    m_Transform;
  InterpolatorPointer         m_Interpolator;

  MovingSpatialObjectConstPointer   m_MovingSpatialObject;
  FixedImageConstPointer            m_FixedImage;
  ParametersType                    m_LastTransformParameters;

};

} // end namespace itk

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

#endif