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 ITK_TEMPLATE_EXPORT RegistrationParameterScalesEstimator
  : public OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(RegistrationParameterScalesEstimator);

  using Self = RegistrationParameterScalesEstimator;
  using Superclass = OptimizerParameterScalesEstimatorTemplate<typename TMetric::ParametersValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro( RegistrationParameterScalesEstimator, Superclass );

  using ScalesType = typename Superclass::ScalesType;

  using ParametersType = typename Superclass::ParametersType;

  using FloatType = typename Superclass::FloatType;

  using MetricType = TMetric;
  using MetricPointer = typename MetricType::Pointer;
  using MetricConstPointer = typename MetricType::ConstPointer;

  using FixedTransformType = typename MetricType::FixedTransformType;
  using FixedTransformConstPointer = typename FixedTransformType::ConstPointer;

  using MovingTransformType = typename MetricType::MovingTransformType;
  using MovingTransformConstPointer = typename MovingTransformType::ConstPointer;

  static constexpr SizeValueType FixedDimension = TMetric::FixedDimension;
  static constexpr SizeValueType MovingDimension = TMetric::MovingDimension;
  static constexpr SizeValueType VirtualDimension = TMetric::VirtualDimension;

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

  using VirtualPointSetType = typename TMetric::VirtualPointSetType;
  using VirtualPointSetPointer = typename TMetric::VirtualPointSetPointer;

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

  using SamplePointContainerType = std::vector<VirtualPointType>;

  using JacobianType = typename TMetric::JacobianType;

  itkSetObjectMacro(Metric, MetricType);

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

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

  itkSetMacro(CentralRegionRadius, IndexValueType);

  void EstimateScales(ScalesType &scales) override = 0;

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

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

  FloatType EstimateMaximumStepSize() override;

  virtual void SetScalesSamplingStrategy();

  virtual void SetStepScaleSamplingStrategy();

protected:
  RegistrationParameterScalesEstimator();
  ~RegistrationParameterScalesEstimator() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const 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 constexpr SizeValueType    SizeOfSmallDomain = 1000;

private:
  bool m_TransformForward;

  // sampling stategy
  SamplingStrategyType          m_SamplingStrategy;

}; //class RegistrationParameterScalesEstimator


}  // namespace itk


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

#endif /* itkRegistrationParameterScalesEstimator_h */