itkTwoImageToOneImageMetric.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 itkTwoImageToOneImageMetric_h
#define itkTwoImageToOneImageMetric_h

#include "itkImageBase.h"
#include "itkTransform.h"
#include "itkInterpolateImageFunction.h"
#include "itkSingleValuedCostFunction.h"
#include "itkExceptionObject.h"
#include "itkGradientRecursiveGaussianImageFilter.h"
#include "itkSpatialObject.h"

namespace itk
{

template <typename TFixedImage,  typename TMovingImage>
class TwoImageToOneImageMetric : public SingleValuedCostFunction
{
public:
  typedef TwoImageToOneImageMetric Self;
  typedef SingleValuedCostFunction Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  typedef Superclass::ParametersValueType CoordinateRepresentationType;

  itkTypeMacro(TwoImageToOneImageMetric, SingleValuedCostFunction);

  typedef TMovingImage                               MovingImageType;
  typedef typename TMovingImage::PixelType           MovingImagePixelType;
  typedef typename MovingImageType::ConstPointer     MovingImageConstPointer;

  typedef TFixedImage                                FixedImageType;
  typedef typename FixedImageType::ConstPointer      FixedImageConstPointer;
  typedef typename FixedImageType::RegionType        FixedImageRegionType;

  itkStaticConstMacro(MovingImageDimension, unsigned int,
                      TMovingImage::ImageDimension);
  itkStaticConstMacro(FixedImageDimension, unsigned int,
                      TFixedImage::ImageDimension);

  typedef Transform<CoordinateRepresentationType,
                    itkGetStaticConstMacro(MovingImageDimension),
                    itkGetStaticConstMacro(FixedImageDimension)> 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 InterpolateImageFunction<
    MovingImageType,
    CoordinateRepresentationType > InterpolatorType;


  typedef typename NumericTraits<MovingImagePixelType>::RealType RealType;
  typedef CovariantVector<RealType,
                          itkGetStaticConstMacro(MovingImageDimension)> GradientPixelType;
  typedef Image<GradientPixelType,
                itkGetStaticConstMacro(MovingImageDimension)> GradientImageType;
  typedef SmartPointer<GradientImageType>                               GradientImagePointer;
  typedef GradientRecursiveGaussianImageFilter< MovingImageType,
                                                GradientImageType >
                                                     GradientImageFilterType;
  typedef typename GradientImageFilterType::Pointer  GradientImageFilterPointer;
  typedef typename InterpolatorType::Pointer         InterpolatorPointer;

  typedef SpatialObject< itkGetStaticConstMacro(FixedImageDimension)
                         >       FixedImageMaskType;
  typedef typename  FixedImageMaskType::Pointer      FixedImageMaskPointer;

  typedef SpatialObject< itkGetStaticConstMacro(MovingImageDimension)
                         >      MovingImageMaskType;
  typedef typename  MovingImageMaskType::Pointer     MovingImageMaskPointer;


  typedef Superclass::MeasureType                    MeasureType;

  typedef Superclass::DerivativeType                 DerivativeType;

  typedef Superclass::ParametersType                 ParametersType;

  itkSetConstObjectMacro( FixedImage1, FixedImageType );

  itkSetConstObjectMacro( FixedImage2, FixedImageType );

  itkGetConstObjectMacro( FixedImage1, FixedImageType );

  itkGetConstObjectMacro( FixedImage2, FixedImageType );

  itkSetConstObjectMacro( MovingImage, MovingImageType );

  itkGetConstObjectMacro( MovingImage, MovingImageType );

  itkSetObjectMacro( Transform, TransformType );

  itkGetConstObjectMacro( Transform, TransformType );

  itkSetObjectMacro( Interpolator1, InterpolatorType );

  itkSetObjectMacro( Interpolator2, InterpolatorType );

  itkGetConstObjectMacro( Interpolator1, InterpolatorType );

  itkGetConstObjectMacro( Interpolator2, InterpolatorType );

  itkGetConstReferenceMacro( NumberOfPixelsCounted, unsigned long );

  itkSetMacro( FixedImageRegion1, FixedImageRegionType );

  itkSetMacro( FixedImageRegion2, FixedImageRegionType );

  itkGetConstReferenceMacro( FixedImageRegion1, FixedImageRegionType );

  itkGetConstReferenceMacro( FixedImageRegion2, FixedImageRegionType );

  itkSetObjectMacro( MovingImageMask, MovingImageMaskType );
  itkGetConstObjectMacro( MovingImageMask, MovingImageMaskType );

  itkSetObjectMacro( FixedImageMask1, FixedImageMaskType );
  itkSetObjectMacro( FixedImageMask2, FixedImageMaskType );
  itkGetConstObjectMacro( FixedImageMask1, FixedImageMaskType );
  itkGetConstObjectMacro( FixedImageMask2, FixedImageMaskType );

  itkSetMacro( ComputeGradient, bool);
  itkGetConstReferenceMacro( ComputeGradient, bool);
  itkBooleanMacro(ComputeGradient);

  itkGetConstObjectMacro( GradientImage, GradientImageType );

  void SetTransformParameters( const ParametersType & parameters ) const;

  unsigned int GetNumberOfParameters() const
  {
    return m_Transform->GetNumberOfParameters();
  }

  virtual void Initialize();

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

  mutable unsigned long       m_NumberOfPixelsCounted;

  FixedImageConstPointer      m_FixedImage1;
  FixedImageConstPointer      m_FixedImage2;
  MovingImageConstPointer     m_MovingImage;

  mutable TransformPointer    m_Transform;
  InterpolatorPointer         m_Interpolator1;
  InterpolatorPointer         m_Interpolator2;

  bool                        m_ComputeGradient;
  GradientImagePointer        m_GradientImage;

  mutable FixedImageMaskPointer   m_FixedImageMask1;
  mutable FixedImageMaskPointer   m_FixedImageMask2;
  mutable MovingImageMaskPointer  m_MovingImageMask;

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

  FixedImageRegionType        m_FixedImageRegion1;
  FixedImageRegionType        m_FixedImageRegion2;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkTwoImageToOneImageMetric.hxx"
#endif

#endif