itkMeanReciprocalSquareDifferenceImageToImageMetric.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 __itkMeanReciprocalSquareDifferenceImageToImageMetric_h
#define __itkMeanReciprocalSquareDifferenceImageToImageMetric_h

#include "itkImageToImageMetric.h"
#include "itkPoint.h"

namespace itk
{
template< class TFixedImage, class TMovingImage >
class ITK_EXPORT MeanReciprocalSquareDifferenceImageToImageMetric:
  public ImageToImageMetric< TFixedImage, TMovingImage >
{
public:

  typedef MeanReciprocalSquareDifferenceImageToImageMetric Self;
  typedef ImageToImageMetric< TFixedImage, TMovingImage >  Superclass;
  typedef SmartPointer< Self >                             Pointer;
  typedef SmartPointer< const Self >                       ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(MeanReciprocalSquareDifferenceImageToImageMetric, ImageToImageMetric);

  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;

  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(Lambda, double);
  itkSetMacro(Lambda, double);

  itkGetConstMacro(Delta, double);
  itkSetMacro(Delta, double);

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

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

  double m_Lambda;
  double m_Delta;
};
} // end namespace itk

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

#endif