itkNormalizedCorrelationTwoImageToOneImageMetric.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 itkNormalizedCorrelationTwoImageToOneImageMetric_h
#define itkNormalizedCorrelationTwoImageToOneImageMetric_h

#include "itkTwoImageToOneImageMetric.h"
#include "itkCovariantVector.h"
#include "itkPoint.h"


namespace itk
{
template < typename TFixedImage, typename TMovingImage >
class NormalizedCorrelationTwoImageToOneImageMetric :
    public TwoImageToOneImageMetric< TFixedImage, TMovingImage >
{
public:
  typedef NormalizedCorrelationTwoImageToOneImageMetric        Self;
  typedef TwoImageToOneImageMetric<TFixedImage, TMovingImage > Superclass;

  typedef SmartPointer<Self>                                   Pointer;
  typedef SmartPointer<const Self>                             ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(NormalizedCorrelationTwoImageToOneImageMetric, Object);


  typedef typename Superclass::RealType                 RealType;
  typedef typename Superclass::TransformType            TransformType;
  typedef typename Superclass::TransformPointer         TransformPointer;
  typedef typename Superclass::TransformParametersType  TransformParametersType;
  typedef typename Superclass::TransformJacobianType    TransformJacobianType;
  typedef typename Superclass::GradientPixelType        GradientPixelType;

  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;

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

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

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

  bool    m_SubtractMean;
};

} // end namespace itk

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

#endif