elxMetricBase.h

Go to the documentation of this file.

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

  This file is part of the elastix software.

  Copyright (c) University Medical Center Utrecht. All rights reserved.
  See src/CopyrightElastix.txt or http://elastix.isi.uu.nl/legal.php 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 __elxMetricBase_h
#define __elxMetricBase_h

#include "elxMacro.h"

#include "elxBaseComponentSE.h"
#include "itkAdvancedImageToImageMetric.h"
#include "itkImageFullSampler.h"
#include "itkPointSet.h"

#include "elxTimer.h"


namespace elastix
{
using namespace itk;

template <class TElastix>
class MetricBase : public BaseComponentSE<TElastix>
{
public:

  typedef MetricBase                  Self;
  typedef BaseComponentSE<TElastix>   Superclass;

  itkTypeMacro( MetricBase, BaseComponentSE );

  typedef typename Superclass::ElastixType            ElastixType;
  typedef typename Superclass::ElastixPointer         ElastixPointer;
  typedef typename Superclass::ConfigurationType      ConfigurationType;
  typedef typename Superclass::ConfigurationPointer   ConfigurationPointer;
  typedef typename Superclass::RegistrationType       RegistrationType;
  typedef typename Superclass::RegistrationPointer    RegistrationPointer;

  typedef typename ElastixType::FixedImageType        FixedImageType;
  typedef typename FixedImageType::PointType          FixedPointType;
  typedef typename FixedPointType::ValueType          FixedPointValueType;
  typedef typename ElastixType::MovingImageType       MovingImageType;
  typedef typename MovingImageType::PointType         MovingPointType;
  typedef typename MovingPointType::ValueType         MovingPointValueType;

  typedef SingleValuedCostFunction                    ITKBaseType;
  typedef AdvancedImageToImageMetric<
    FixedImageType, MovingImageType >                 AdvancedMetricType;

  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::ImageDimension );
  itkStaticConstMacro( MovingImageDimension, unsigned int, MovingImageType::ImageDimension );

  typedef typename ITKBaseType::ParametersValueType CoordinateRepresentationType;
  typedef PointSet<
    CoordinateRepresentationType, FixedImageDimension,
    DefaultStaticMeshTraits<
      CoordinateRepresentationType,
      FixedImageDimension, FixedImageDimension,
      CoordinateRepresentationType, CoordinateRepresentationType,
      CoordinateRepresentationType > >                FixedPointSetType;
  typedef PointSet<
    CoordinateRepresentationType, MovingImageDimension,
    DefaultStaticMeshTraits<
      CoordinateRepresentationType,
      MovingImageDimension, MovingImageDimension,
      CoordinateRepresentationType, CoordinateRepresentationType,
      CoordinateRepresentationType > >                MovingPointSetType;

  typedef typename AdvancedMetricType::ImageSamplerType  ImageSamplerBaseType;

  virtual ITKBaseType * GetAsITKBaseType( void )
  {
    return dynamic_cast<ITKBaseType *>( this );
  }

  virtual const ITKBaseType * GetAsITKBaseType( void ) const
  {
    return dynamic_cast<const ITKBaseType *>( this );
  }

  virtual void BeforeEachResolutionBase( void );

  virtual void AfterEachIterationBase( void );

  virtual void SelectNewSamples( void );

  virtual bool GetAdvancedMetricUseImageSampler( void ) const;

  virtual void SetAdvancedMetricImageSampler( ImageSamplerBaseType * sampler );

  virtual ImageSamplerBaseType * GetAdvancedMetricImageSampler( void ) const;

protected:

  typedef typename ITKBaseType::MeasureType       MeasureType;
  typedef typename ITKBaseType::ParametersType    ParametersType;

  typedef itk::ImageFullSampler<FixedImageType>   ImageFullSamplerType;

  MetricBase();
  virtual ~MetricBase() {}

  virtual MeasureType GetExactValue( const ParametersType& parameters );
  bool m_ShowExactMetricValue;
  typename ImageFullSamplerType::Pointer m_ExactMetricSampler;

private:

  MetricBase( const Self& );      // purposely not implemented
  void operator=( const Self& );  // purposely not implemented

}; // end class MetricBase


} // end namespace elastix

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

#endif // end #ifndef __elxMetricBase_h