elxMetricBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __elxMetricBase_h
#define __elxMetricBase_h
 
#include "elxMacro.h"
 
#include "elxBaseComponentSE.h"
#include "itkAdvancedImageToImageMetric.h"
#include "itkImageGridSampler.h"
#include "itkPointSet.h"
 
namespace elastix
{
 
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 itk::SingleValuedCostFunction ITKBaseType;
  typedef itk::AdvancedImageToImageMetric<
    FixedImageType, MovingImageType >                 AdvancedMetricType;
  typedef typename AdvancedMetricType::MovingImageDerivativeScalesType MovingImageDerivativeScalesType;
 
  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::ImageDimension );
  itkStaticConstMacro( MovingImageDimension, unsigned int, MovingImageType::ImageDimension );
 
  typedef typename ITKBaseType::ParametersValueType CoordinateRepresentationType;
  typedef itk::PointSet<
    CoordinateRepresentationType, FixedImageDimension,
    itk::DefaultStaticMeshTraits<
    CoordinateRepresentationType,
    FixedImageDimension, FixedImageDimension,
    CoordinateRepresentationType, CoordinateRepresentationType,
    CoordinateRepresentationType > >                FixedPointSetType;
  typedef itk::PointSet<
    CoordinateRepresentationType, MovingImageDimension,
    itk::DefaultStaticMeshTraits<
    CoordinateRepresentationType,
    MovingImageDimension, MovingImageDimension,
    CoordinateRepresentationType, CoordinateRepresentationType,
    CoordinateRepresentationType > >                MovingPointSetType;
 
  typedef typename AdvancedMetricType::ImageSamplerType ImageSamplerBaseType;
 
  typedef typename ITKBaseType::MeasureType MeasureType;
 
  virtual ITKBaseType * GetAsITKBaseType( void )
  {
    return dynamic_cast< ITKBaseType * >( this );
  }
 
 
  virtual const ITKBaseType * GetAsITKBaseType( void ) const
  {
    return dynamic_cast< const ITKBaseType * >( this );
  }
 
 
  void BeforeEachResolutionBase( void ) override;
 
  void AfterEachIterationBase( void ) override;
 
  virtual void SelectNewSamples( void );
 
  virtual bool GetAdvancedMetricUseImageSampler( void ) const;
 
  virtual void SetAdvancedMetricImageSampler( ImageSamplerBaseType * sampler );
 
  virtual ImageSamplerBaseType * GetAdvancedMetricImageSampler( void ) const;
 
  virtual bool GetShowExactMetricValue( void ) const
  { return this->m_ShowExactMetricValue; }
 
  virtual MeasureType GetCurrentExactMetricValue( void ) const
  { return this->m_CurrentExactMetricValue; }
 
protected:
 
  typedef typename ITKBaseType::ParametersType ParametersType;
 
  typedef itk::ImageGridSampler< FixedImageType >                     ExactMetricImageSamplerType;
  typedef typename ExactMetricImageSamplerType::Pointer               ExactMetricImageSamplerPointer;
  typedef typename ExactMetricImageSamplerType::SampleGridSpacingType ExactMetricSampleGridSpacingType;
 
  MetricBase();
  ~MetricBase() override {}
 
  virtual MeasureType GetExactValue( const ParametersType & parameters );
 
  bool                             m_ShowExactMetricValue;
  ExactMetricImageSamplerPointer   m_ExactMetricSampler;
  MeasureType                      m_CurrentExactMetricValue;
  ExactMetricSampleGridSpacingType m_ExactMetricSampleGridSpacing;
  unsigned int                     m_ExactMetricEachXNumberOfIterations;
 
private:
 
  MetricBase( const Self & );      // purposely not implemented
  void operator=( const Self & );  // purposely not implemented
 
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "elxMetricBase.hxx"
#endif
 
#endif // end #ifndef __elxMetricBase_h