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 <typename TElastix>
class ITK_TEMPLATE_EXPORT MetricBase : public BaseComponentSE<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MetricBase);

  using Self = MetricBase;
  using Superclass = BaseComponentSE<TElastix>;

  itkOverrideGetNameOfClassMacro(MetricBase);

  using typename Superclass::ElastixType;
  using typename Superclass::RegistrationType;

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

  using ITKBaseType = itk::SingleValuedCostFunction;
  using AdvancedMetricType = itk::AdvancedImageToImageMetric<FixedImageType, MovingImageType>;
  using MovingImageDerivativeScalesType = typename AdvancedMetricType::MovingImageDerivativeScalesType;

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

  using CoordinateRepresentationType = typename ITKBaseType::ParametersValueType;
  using FixedPointSetType = itk::PointSet<CoordinateRepresentationType,
                                          FixedImageDimension,
                                          itk::DefaultStaticMeshTraits<CoordinateRepresentationType,
                                                                       FixedImageDimension,
                                                                       FixedImageDimension,
                                                                       CoordinateRepresentationType,
                                                                       CoordinateRepresentationType,
                                                                       CoordinateRepresentationType>>;
  using MovingPointSetType = itk::PointSet<CoordinateRepresentationType,
                                           MovingImageDimension,
                                           itk::DefaultStaticMeshTraits<CoordinateRepresentationType,
                                                                        MovingImageDimension,
                                                                        MovingImageDimension,
                                                                        CoordinateRepresentationType,
                                                                        CoordinateRepresentationType,
                                                                        CoordinateRepresentationType>>;

  using ImageSamplerBaseType = typename AdvancedMetricType::ImageSamplerType;

  using MeasureType = typename ITKBaseType::MeasureType;

  ITKBaseType *
  GetAsITKBaseType()
  {
    return &(this->GetSelf());
  }
 

  const ITKBaseType *
  GetAsITKBaseType() const
  {
    return &(this->GetSelf());
  }
 
 
  void
  BeforeRegistrationBase() override;

  void
  BeforeEachResolutionBase() override;

  void
  AfterEachIterationBase() override;

  virtual void
  SelectNewSamples();

  virtual bool
  GetAdvancedMetricUseImageSampler() const;

  virtual void
  SetAdvancedMetricImageSampler(ImageSamplerBaseType * sampler);

  virtual ImageSamplerBaseType *
  GetAdvancedMetricImageSampler() const;

  virtual bool
  GetShowExactMetricValue() const
  {
    return this->m_ShowExactMetricValue;
  }

  virtual MeasureType
  GetCurrentExactMetricValue() const
  {
    return this->m_CurrentExactMetricValue;
  }
 
protected:
  using ParametersType = typename ITKBaseType::ParametersType;

  using ExactMetricImageSamplerType = itk::ImageGridSampler<FixedImageType>;
  using ExactMetricImageSamplerPointer = typename ExactMetricImageSamplerType::Pointer;
  using ExactMetricSampleGridSpacingType = typename ExactMetricImageSamplerType::SampleGridSpacingType;

  MetricBase() = default;
  ~MetricBase() override = default;

  virtual MeasureType
  GetExactValue(const ParametersType & parameters);

 
  bool                             m_ShowExactMetricValue{ false };
  ExactMetricImageSamplerPointer   m_ExactMetricSampler{ nullptr };
  MeasureType                      m_CurrentExactMetricValue{ 0.0 };
  ExactMetricSampleGridSpacingType m_ExactMetricSampleGridSpacing{ itk::MakeFilled<ExactMetricSampleGridSpacingType>(
    1) };
  unsigned int                     m_ExactMetricEachXNumberOfIterations{ 1 };
 
private:
  elxDeclarePureVirtualGetSelfMacro(ITKBaseType);
};
 
} // end namespace elastix
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxMetricBase.hxx"
#endif
 
#endif // end #ifndef elxMetricBase_h