itkRegistrationParameterScalesEstimator.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 __itkRegistrationParameterScalesEstimator_h
#define __itkRegistrationParameterScalesEstimator_h

#include "itkTransform.h"
#include "itkMatrixOffsetTransformBase.h"
#include "itkTranslationTransform.h"
#include "itkIdentityTransform.h"
#include "itkRigid3DPerspectiveTransform.h"

#include "itkOptimizerParameterScalesEstimator.h"
#include "itkImageRandomConstIteratorWithIndex.h"
#include "itkImageRegionConstIteratorWithIndex.h"

namespace itk
{

template < class TMetric >
class ITK_EXPORT RegistrationParameterScalesEstimator : public OptimizerParameterScalesEstimator
{
public:
  typedef RegistrationParameterScalesEstimator  Self;
  typedef OptimizerParameterScalesEstimator     Superclass;
  typedef SmartPointer<Self>                    Pointer;
  typedef SmartPointer<const Self>              ConstPointer;

  itkTypeMacro( RegistrationParameterScalesEstimator, OptimizerParameterScalesEstimator );

  typedef typename Superclass::ScalesType           ScalesType;

  typedef typename Superclass::ParametersType       ParametersType;

  typedef typename Superclass::FloatType            FloatType;

  typedef TMetric                                   MetricType;
  typedef typename MetricType::ConstPointer         MetricConstPointer;

  typedef typename MetricType::FixedTransformType   FixedTransformType;
  typedef typename FixedTransformType::ConstPointer FixedTransformConstPointer;

  typedef typename MetricType::MovingTransformType  MovingTransformType;
  typedef typename MovingTransformType::ConstPointer
                                                    MovingTransformConstPointer;

  typedef typename TMetric::FixedImageType          FixedImageType;
  typedef typename TMetric::MovingImageType         MovingImageType;
  typedef typename TMetric::VirtualImageType        VirtualImageType;

  typedef typename FixedImageType::ConstPointer     FixedImageConstPointer;
  typedef typename MovingImageType::ConstPointer    MovingImageConstPointer;
  typedef typename VirtualImageType::ConstPointer   VirtualImageConstPointer;

  /* Image dimension accessors */
  itkStaticConstMacro(FixedImageDimension, SizeValueType,
      ::itk::GetImageDimension<FixedImageType>::ImageDimension);
  itkStaticConstMacro(MovingImageDimension, SizeValueType,
      ::itk::GetImageDimension<MovingImageType>::ImageDimension);
  itkStaticConstMacro(VirtualImageDimension, SizeValueType,
      ::itk::GetImageDimension<VirtualImageType>::ImageDimension);

  typedef typename VirtualImageType::RegionType     VirtualRegionType;
  typedef typename VirtualImageType::SizeType       VirtualSizeType;
  typedef typename VirtualImageType::PointType      VirtualPointType;
  typedef typename VirtualImageType::IndexType      VirtualIndexType;

  typedef typename FixedImageType::PointType        FixedPointType;
  typedef typename FixedImageType::IndexType        FixedIndexType;
  typedef typename FixedImageType::PointValueType   FixedPointValueType;
  typedef typename itk::ContinuousIndex< FixedPointValueType,
          FixedImageType::ImageDimension >          FixedContinuousIndexType;

  typedef typename MovingImageType::PointType       MovingPointType;
  typedef typename MovingImageType::IndexType       MovingIndexType;
  typedef typename MovingImageType::PointValueType  MovingPointValueType;
  typedef typename itk::ContinuousIndex< MovingPointValueType,
          MovingImageType::ImageDimension >         MovingContinuousIndexType;

  typedef enum { FullDomainSampling, CornerSampling, RandomSampling,
                 CentralRegionSampling }
          SamplingStrategyType;

  typedef std::vector<VirtualPointType>             ImageSampleContainerType;

  typedef typename TMetric::JacobianType            JacobianType;

  itkSetObjectMacro(Metric, MetricType);

  itkSetMacro(TransformForward, bool);
  itkGetConstMacro(TransformForward, bool);

  itkSetMacro(CentralRegionRadius, IndexValueType);

  virtual void EstimateScales(ScalesType &scales) = 0;

  virtual FloatType EstimateStepScale(const ParametersType &step) = 0;

  virtual void EstimateLocalStepScales(const ParametersType &step,
    ScalesType &localStepScales) = 0;

  virtual FloatType EstimateMaximumStepSize();

  virtual void SetScalesSamplingStrategy();

  virtual void SetStepScaleSamplingStrategy();

protected:
  RegistrationParameterScalesEstimator();
  ~RegistrationParameterScalesEstimator(){};

  virtual void PrintSelf(std::ostream &os, Indent indent) const;

  bool CheckAndSetInputs();

  itkSetMacro(NumberOfRandomSamples, SizeValueType);

  itkSetMacro(SamplingStrategy, SamplingStrategyType);

  bool CheckGeneralAffineTransform();

  template< class TTransform > bool CheckGeneralAffineTransformTemplated();

  template< class TTargetPointType > void TransformPoint(
                              const VirtualPointType &point,
                              TTargetPointType &mappedPoint);

  template< class TContinuousIndexType > void TransformPointToContinuousIndex(
                              const VirtualPointType &point,
                              TContinuousIndexType &mappedIndex);

  void ComputeSquaredJacobianNorms(
                              const VirtualPointType  & p,
                              ParametersType & squareNorms);

  bool HasLocalSupport();

  SizeValueType GetNumberOfLocalParameters();

  void UpdateTransformParameters(const ParametersType &deltaParameters);

  virtual void SampleImageDomain();

  void SampleImageDomainFully();

  void SampleImageDomainWithCorners();

  void SampleImageDomainRandomly();

  void SampleImageDomainWithCentralRegion();

  void SampleImageDomainWithRegion(VirtualRegionType region);

  VirtualIndexType GetVirtualImageCentralIndex();

  VirtualRegionType GetVirtualImageCentralRegion();

  const TransformBase *GetTransform();

  SizeValueType GetImageDimension();

  itkGetConstObjectMacro(FixedImage,  FixedImageType);

  itkGetConstObjectMacro(MovingImage, MovingImageType);

  itkGetConstObjectMacro(VirtualImage, VirtualImageType);

  itkGetConstObjectMacro(FixedTransform,  FixedTransformType);

  itkGetConstObjectMacro(MovingTransform, MovingTransformType);

  // the metric object
  MetricConstPointer            m_Metric;

  // the image samples in the virtual image domain
  ImageSampleContainerType      m_ImageSamples;

  mutable TimeStamp             m_SamplingTime;

  // the number of image samples in the virtual image domain
  SizeValueType                 m_NumberOfRandomSamples;

  // the radius of the central region for sampling
  IndexValueType                m_CentralRegionRadius;

  // the threadhold to decide if the number of random samples uses logarithm
  static const SizeValueType    SizeOfSmallDomain = 1000;

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

  // the transform objects
  FixedTransformConstPointer         m_FixedTransform;
  MovingTransformConstPointer        m_MovingTransform;

  // the fixed images
  FixedImageConstPointer             m_FixedImage;
  // the moving images
  MovingImageConstPointer            m_MovingImage;
  // the virtual image for symmetric registration
  VirtualImageConstPointer           m_VirtualImage;

  bool m_TransformForward;

  // sampling stategy
  SamplingStrategyType          m_SamplingStrategy;

}; //class RegistrationParameterScalesEstimator


}  // namespace itk


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

#endif /* __itkRegistrationParameterScalesEstimator_h */