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 < typename TMetric >
class RegistrationParameterScalesEstimator
  : public OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType>
{
public:
  typedef RegistrationParameterScalesEstimator                                              Self;
  typedef OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType>  Superclass;
  typedef SmartPointer<Self>                                                                Pointer;
  typedef SmartPointer<const Self>                                                          ConstPointer;

  itkTypeMacro( RegistrationParameterScalesEstimator, Superclass );

  typedef typename Superclass::ScalesType           ScalesType;

  typedef typename Superclass::ParametersType       ParametersType;

  typedef typename Superclass::FloatType            FloatType;

  typedef TMetric                                   MetricType;
  typedef typename MetricType::Pointer              MetricPointer;
  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;

  itkStaticConstMacro(FixedDimension, SizeValueType, TMetric::FixedDimension );
  itkStaticConstMacro(MovingDimension, SizeValueType, TMetric::MovingDimension );
  itkStaticConstMacro(VirtualDimension, SizeValueType, TMetric::VirtualDimension );

  typedef typename TMetric::VirtualImageType          VirtualImageType;
  typedef typename TMetric::VirtualImageConstPointer  VirtualImageConstPointer;
  typedef typename TMetric::VirtualImagePointer       VirtualImagePointer;
  typedef typename TMetric::VirtualSpacingType        VirtualSpacingType;
  typedef typename TMetric::VirtualRegionType         VirtualRegionType;
  typedef typename TMetric::VirtualSizeType           VirtualSizeType;
  typedef typename TMetric::VirtualPointType          VirtualPointType;
  typedef typename TMetric::VirtualIndexType          VirtualIndexType;

  typedef typename TMetric::VirtualPointSetType       VirtualPointSetType;
  typedef typename TMetric::VirtualPointSetPointer    VirtualPointSetPointer;

  typedef enum { FullDomainSampling = 0,
                 CornerSampling,
                 RandomSampling,
                 CentralRegionSampling,
                 VirtualDomainPointSetSampling }    SamplingStrategyType;

  typedef std::vector<VirtualPointType>             SamplePointContainerType;

  typedef typename TMetric::JacobianType            JacobianType;

  itkSetObjectMacro(Metric, MetricType);

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

  itkSetObjectMacro(VirtualDomainPointSet, VirtualPointSetType);
  itkSetConstObjectMacro(VirtualDomainPointSet, VirtualPointSetType);
  itkGetConstObjectMacro(VirtualDomainPointSet, VirtualPointSetType);

  itkSetMacro(CentralRegionRadius, IndexValueType);

  virtual void EstimateScales(ScalesType &scales) ITK_OVERRIDE = 0;

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

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

  virtual FloatType EstimateMaximumStepSize() ITK_OVERRIDE;

  virtual void SetScalesSamplingStrategy();

  virtual void SetStepScaleSamplingStrategy();

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

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

  bool CheckAndSetInputs();

  itkSetMacro(NumberOfRandomSamples, SizeValueType);

  itkSetMacro(SamplingStrategy, SamplingStrategyType);

  bool CheckGeneralAffineTransform();

  template< typename TTransform > bool CheckGeneralAffineTransformTemplated();

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

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

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

  bool TransformHasLocalSupportForScalesEstimation();

  bool IsDisplacementFieldTransform();

  bool IsBSplineTransform();

  SizeValueType GetNumberOfLocalParameters();

  void UpdateTransformParameters(const ParametersType &deltaParameters);

  virtual void SampleVirtualDomain();

  void SampleVirtualDomainFully();

  void SampleVirtualDomainWithCorners();

  void SampleVirtualDomainRandomly();

  void SampleVirtualDomainWithCentralRegion();

  void SampleVirtualDomainWithRegion(VirtualRegionType region);

  void SampleVirtualDomainWithPointSet();

  VirtualIndexType GetVirtualDomainCentralIndex();

  VirtualRegionType GetVirtualDomainCentralRegion();

  const TransformBaseTemplate<typename TMetric::MeasureType> *GetTransform();

  SizeValueType GetDimension();

  itkGetMacro( SamplingStrategy, SamplingStrategyType )


  MetricPointer                 m_Metric;

  SamplePointContainerType      m_SamplePoints;

  mutable TimeStamp             m_SamplingTime;

  SizeValueType                 m_NumberOfRandomSamples;

  IndexValueType                m_CentralRegionRadius;

  typename VirtualPointSetType::ConstPointer  m_VirtualDomainPointSet;

  // 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

  bool m_TransformForward;

  // sampling stategy
  SamplingStrategyType          m_SamplingStrategy;

}; //class RegistrationParameterScalesEstimator


}  // namespace itk


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

#endif /* itkRegistrationParameterScalesEstimator_h */