itkComputePreconditionerUsingDisplacementDistribution.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkComputePreconditionerUsingDisplacementDistribution_h
#define itkComputePreconditionerUsingDisplacementDistribution_h
 
#include "itkComputeDisplacementDistribution.h"
 
 
namespace itk
{
 
template <typename TFixedImage, typename TTransform>
class ITK_TEMPLATE_EXPORT ComputePreconditionerUsingDisplacementDistribution
  : public ComputeDisplacementDistribution<TFixedImage, TTransform>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ComputePreconditionerUsingDisplacementDistribution);

  using Self = ComputePreconditionerUsingDisplacementDistribution;
  using Superclass = ComputeDisplacementDistribution<TFixedImage, TTransform>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ComputePreconditionerUsingDisplacementDistribution);

  using typename Superclass::FixedImageType;
  using typename Superclass::FixedImagePixelType;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::FixedImageRegionType;
  using typename Superclass::ParametersType;
  using typename Superclass::DerivativeType;
  using typename Superclass::ScalesType;
  using typename Superclass::FixedImageMaskType;
  using typename Superclass::FixedImageMaskPointer;
  using typename Superclass::FixedImageMaskConstPointer;
  using typename Superclass::NonZeroJacobianIndicesType;
 
  // check
  itkStaticConstMacro(FixedImageDimension, unsigned int, TFixedImage::ImageDimension);

  itkSetClampMacro(RegularizationKappa, double, 0.0, 1.0);
  itkGetConstReferenceMacro(RegularizationKappa, double);

  itkSetMacro(MaximumStepLength, double);
  itkGetConstReferenceMacro(MaximumStepLength, double);

  itkSetClampMacro(ConditionNumber, double, 0.0, 10.0);
  itkGetConstReferenceMacro(ConditionNumber, double);

  void
  Compute(const ParametersType & mu, double & jacg, double & maxJJ, std::string method) override;

  void
  Compute(const ParametersType & mu, double & maxJJ, ParametersType & preconditioner) const;
 
  void
  ComputeJacobiTypePreconditioner(double & maxJJ, ParametersType & preconditioner);

  virtual void
  PreconditionerInterpolation(ParametersType & preconditioner);
 
protected:
  ComputePreconditionerUsingDisplacementDistribution();
  ~ComputePreconditionerUsingDisplacementDistribution() override = default;
 
  using typename Superclass::FixedImageIndexType;
  using typename Superclass::FixedImagePointType;
  using typename Superclass::JacobianType;
  using typename Superclass::JacobianValueType;
  using typename Superclass::ImageSampleType;
  using typename Superclass::TransformJacobianType;
  using typename Superclass::CoordinateRepresentationType;
  using typename Superclass::NumberOfParametersType;
 
  double m_MaximumStepLength{};
  double m_RegularizationKappa{};
  double m_ConditionNumber{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkComputePreconditionerUsingDisplacementDistribution.hxx"
#endif
 
#endif // end #ifndef itkComputePreconditionerUsingDisplacementDistribution_h