itkRegistrationParameterScalesFromShift.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 __itkRegistrationParameterScalesFromShift_h
#define __itkRegistrationParameterScalesFromShift_h

#include "itkRegistrationParameterScalesEstimator.h"

namespace itk
{

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

  itkNewMacro( Self );

  itkTypeMacro( RegistrationParameterScalesFromShift, RegistrationParameterScalesEstimator );

  typedef typename Superclass::ScalesType                ScalesType;

  typedef typename Superclass::ParametersType            ParametersType;

  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;

  itkSetMacro(UsePhysicalSpaceForShift, bool);
  itkGetConstMacro(UsePhysicalSpaceForShift, bool);

  virtual void EstimateScales(ScalesType &scales);

  virtual FloatType EstimateStepScale(const ParametersType &step);

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

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

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

  virtual FloatType ComputeMaximumVoxelShift(const ParametersType &deltaParameters);

  template <class TTransform> void
    ComputeSampleIndexShifts(const ParametersType &deltaParameters,
                                        ScalesType &localShifts);

  template <class TTransform> void
    ComputeSamplePhysicalShifts(const ParametersType &deltaParameters,
                                        ScalesType &localShifts);

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

  //A small variation of parameters
  typename ParametersType::ValueType   m_SmallParameterVariation;

  //A switch for using physical space for shift computation or continuous index space
  bool                                 m_UsePhysicalSpaceForShift;
}; //class RegistrationParameterScalesFromShift


}  // namespace itk


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

#endif /* __itkRegistrationParameterScalesFromShift_h */