itkSingleImageCostFunction.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSingleImageCostFunction.h,v $
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef itkSingleImageCostFunction_h
#define itkSingleImageCostFunction_h

#include "itkNumericTraits.h"
#include "itkExceptionObject.h"
#include "itkContinuousIndex.h"
#include "itkSingleValuedCostFunction.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkCentralDifferenceImageFunction.h"
#include "itkPhysicalCentralDifferenceImageFunction.h"

namespace itk
{

template <class TImage>
class ITK_EXPORT SingleImageCostFunction :
    public SingleValuedCostFunction
{
public:
  typedef SingleImageCostFunction      Self;
  typedef SingleValuedCostFunction     Superclass;
  typedef SmartPointer<Self>           Pointer;
  typedef SmartPointer<const Self>     ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro( SingleImageCostFunction, SingleValuedCostFunction );

  typedef typename Superclass::MeasureType          MeasureType;

  typedef typename Superclass::DerivativeType       DerivativeType;

  typedef typename Superclass::ParametersType       ParametersType;

  typedef TImage                           ImageType;
  typedef typename TImage::PixelType       ImagePixelType;
  typedef typename ImageType::ConstPointer ImageConstPointer;

  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);

  typedef Superclass::ParametersValueType CoordRepType;

  typedef Index< ImageDimension >               IndexType;
  typedef Point< CoordRepType, ImageDimension > PointType;
  typedef ContinuousIndex< CoordRepType, ImageDimension >
    ContinuousIndexType;

  typedef InterpolateImageFunction< ImageType, CoordRepType >
    InterpolatorType;
  typedef LinearInterpolateImageFunction< ImageType, CoordRepType >
    DefaultInterpolatorType;

  typedef PhysicalCentralDifferenceImageFunction< ImageType, CoordRepType >
    GradientImageFunctionType;

  itkSetObjectMacro( Interpolator, InterpolatorType );
  itkGetConstObjectMacro( Interpolator, InterpolatorType );

  itkSetConstObjectMacro( Image, ImageType );
  itkGetConstObjectMacro( Image, ImageType );

  virtual void Initialize(void) throw ( ExceptionObject );

  unsigned int GetNumberOfParameters(void) const ITK_OVERRIDE
  { return ImageDimension; }

  virtual MeasureType GetValue( const ParametersType & parameters ) const ITK_OVERRIDE;

  virtual void GetDerivative( const ParametersType & parameters,
                              DerivativeType & derivative ) const ITK_OVERRIDE;

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

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(SingleImageCostFunction);

  ImageConstPointer                           m_Image;
  typename InterpolatorType::Pointer          m_Interpolator;
  typename GradientImageFunctionType::Pointer m_GradientImageFunction;

};

} // end namespace itk

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

#endif