itkRegistrationParameterScalesFromShiftBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 ITK_TEMPLATE_EXPORT RegistrationParameterScalesFromShiftBase
  : public RegistrationParameterScalesEstimator<TMetric>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(RegistrationParameterScalesFromShiftBase);

  using Self = RegistrationParameterScalesFromShiftBase;
  using Superclass = RegistrationParameterScalesEstimator<TMetric>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(RegistrationParameterScalesFromShiftBase);

  using typename Superclass::ScalesType;

  using typename Superclass::ParametersType;
  using ParametersValueType = typename ParametersType::ValueType;

  using typename Superclass::FloatType;
 
  using typename Superclass::VirtualPointType;
  using typename Superclass::VirtualIndexType;
  using typename Superclass::MovingTransformType;
  using typename Superclass::FixedTransformType;
  using typename Superclass::JacobianType;
  using typename Superclass::VirtualImageConstPointer;

  void
  EstimateScales(ScalesType & parameterScales) override;

  FloatType
  EstimateStepScale(const ParametersType & step) override;

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

  itkSetMacro(SmallParameterVariation, ParametersValueType);
  itkGetConstMacro(SmallParameterVariation, ParametersValueType);
 
protected:
  RegistrationParameterScalesFromShiftBase();
  ~RegistrationParameterScalesFromShiftBase() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual FloatType
  ComputeMaximumVoxelShift(const ParametersType & deltaParameters);

  virtual void
  ComputeSampleShifts(const ParametersType & deltaParameters, ScalesType & localShifts) = 0;
 
private:
  // A small variation of parameters
  ParametersValueType m_SmallParameterVariation{};
 
}; // class RegistrationParameterScalesFromShiftBase
 
 
} // namespace itk
 
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkRegistrationParameterScalesFromShiftBase.hxx"
#endif
 
#endif /* itkRegistrationParameterScalesFromShiftBase_h */