itkImageToSpatialObjectMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkImageToSpatialObjectMetric_h
#define __itkImageToSpatialObjectMetric_h

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

namespace itk
{
template< typename TFixedImage, typename TMovingSpatialObject >
class 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);

  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  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 &) {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  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.hxx"
#endif

#endif