itkRegistrationParameterScalesFromShiftBase.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 itkRegistrationParameterScalesFromShiftBase_h
#define itkRegistrationParameterScalesFromShiftBase_h

#include "itkRegistrationParameterScalesEstimator.h"

namespace itk
{

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

  itkTypeMacro( RegistrationParameterScalesFromShiftBase, RegistrationParameterScalesEstimator );

  typedef typename Superclass::ScalesType                ScalesType;

  typedef typename Superclass::ParametersType            ParametersType;
  typedef typename ParametersType::ValueType             ParametersValueType;

  typedef typename Superclass::FloatType                 FloatType;

  typedef typename Superclass::VirtualPointType          VirtualPointType;
  typedef typename Superclass::VirtualIndexType          VirtualIndexType;
  typedef typename Superclass::MovingTransformType       MovingTransformType;
  typedef typename Superclass::FixedTransformType        FixedTransformType;
  typedef typename Superclass::JacobianType              JacobianType;
  typedef typename Superclass::VirtualImageConstPointer  VirtualImageConstPointer;

  virtual void EstimateScales(ScalesType &scales) ITK_OVERRIDE;

  virtual FloatType EstimateStepScale(const ParametersType &step) ITK_OVERRIDE;

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

  itkSetMacro( SmallParameterVariation, ParametersValueType );
  itkGetConstMacro( SmallParameterVariation, ParametersValueType );

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

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

  virtual FloatType ComputeMaximumVoxelShift(const ParametersType &deltaParameters);

  virtual void ComputeSampleShifts(const ParametersType &deltaParameters, ScalesType &localShifts) = 0;

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

  //A small variation of parameters
  ParametersValueType  m_SmallParameterVariation;

}; //class RegistrationParameterScalesFromShiftBase


}  // namespace itk


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

#endif /* itkRegistrationParameterScalesFromShiftBase_h */