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:
  ITK_DISALLOW_COPY_AND_ASSIGN(TwoImageToOneImageMetric);

  using Self = TwoImageToOneImageMetric;
  using Superclass = SingleValuedCostFunction;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using CoordinateRepresentationType = Superclass::ParametersValueType;

  itkTypeMacro(TwoImageToOneImageMetric, SingleValuedCostFunction);

  using MovingImageType = TMovingImage;
  using MovingImagePixelType = typename TMovingImage::PixelType;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;

  using FixedImageType = TFixedImage;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;
  using FixedImageRegionType = typename FixedImageType::RegionType;

  static constexpr unsigned int MovingImageDimension = TMovingImage::ImageDimension;
  static constexpr unsigned int FixedImageDimension = TFixedImage::ImageDimension;

  using TransformType = Transform<CoordinateRepresentationType,
                    itkGetStaticConstMacro(MovingImageDimension),
                    itkGetStaticConstMacro(FixedImageDimension)>;

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

  using InterpolatorType = InterpolateImageFunction<
    MovingImageType,
    CoordinateRepresentationType >;


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

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

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


  using MeasureType = Superclass::MeasureType;

  using DerivativeType = Superclass::DerivativeType;

  using ParametersType = Superclass::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 override
  {
    return m_Transform->GetNumberOfParameters();
  }

  virtual void Initialize();

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

  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:
  FixedImageRegionType        m_FixedImageRegion1;
  FixedImageRegionType        m_FixedImageRegion2;
};

} // end namespace itk

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

#endif