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< class TFixedImage, class TTransform >
class ComputePreconditionerUsingDisplacementDistribution :
  public ComputeDisplacementDistribution< TFixedImage, TTransform >
{
public:
 
  typedef ComputePreconditionerUsingDisplacementDistribution  Self;
  typedef ComputeDisplacementDistribution<
    TFixedImage, TTransform >                                 Superclass;
  typedef SmartPointer< Self >                                Pointer;
  typedef SmartPointer< const Self >                          ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ComputePreconditionerUsingDisplacementDistribution,
    ComputeDisplacementDistribution );
 
  typedef typename Superclass::FixedImageType          FixedImageType;
  typedef typename Superclass::FixedImagePixelType     FixedImagePixelType;
  typedef typename Superclass::TransformType           TransformType;
  typedef typename Superclass::TransformPointer        TransformPointer;
  typedef typename Superclass::FixedImageRegionType    FixedImageRegionType;
  typedef typename Superclass::ParametersType          ParametersType;
  typedef typename Superclass::DerivativeType          DerivativeType;
  typedef typename Superclass::ScalesType              ScalesType;
 
  typedef typename Superclass::FixedImageMaskType          FixedImageMaskType;
  typedef typename Superclass::FixedImageMaskPointer       FixedImageMaskPointer;
  typedef typename Superclass::FixedImageMaskConstPointer  FixedImageMaskConstPointer;
  typedef typename Superclass::NonZeroJacobianIndicesType  NonZeroJacobianIndicesType;
 
  // check
  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::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;
 
  virtual void ComputeDistributionTermsUsingSearchDir( const ParametersType & mu,
    double & jacg, double & maxJJ, std::string methods );
 
  virtual void ComputeForBSplineOnly( const ParametersType & mu,
    const double & delta, double & maxJJ, ParametersType & preconditioner );
 
  virtual void Compute( const ParametersType & mu,
    double & maxJJ, ParametersType & preconditioner );
 
  virtual void ComputeJacobiTypePreconditioner( const ParametersType & mu,
    double & maxJJ, ParametersType & preconditioner );
 
  virtual void PreconditionerInterpolation( ParametersType & preconditioner );
 
protected:
 
  ComputePreconditionerUsingDisplacementDistribution();
  ~ComputePreconditionerUsingDisplacementDistribution() override {}
 
  typedef typename Superclass::FixedImageIndexType           FixedImageIndexType;
  typedef typename Superclass::FixedImagePointType           FixedImagePointType;
  typedef typename Superclass::JacobianType                  JacobianType;
  typedef typename Superclass::JacobianValueType             JacobianValueType;
  typedef typename Superclass::ImageSamplerBaseType          ImageSamplerBaseType;
  typedef typename Superclass::ImageSamplerBasePointer       ImageSamplerBasePointer;
  typedef typename Superclass::ImageFullSamplerType          ImageFullSamplerType;
  typedef typename Superclass::ImageFullSamplerPointer       ImageFullSamplerPointer;
  typedef typename Superclass::ImageRandomSamplerBaseType    ImageRandomSamplerBaseType;
  typedef typename Superclass::ImageRandomSamplerBasePointer ImageRandomSamplerBasePointer;
  typedef typename Superclass::ImageGridSamplerType          ImageGridSamplerType;
  typedef typename Superclass::ImageGridSamplerPointer       ImageGridSamplerPointer;
  typedef typename Superclass::ImageSampleContainerType      ImageSampleContainerType;
  typedef typename Superclass::ImageSampleContainerPointer   ImageSampleContainerPointer;
  typedef typename Superclass::TransformJacobianType         TransformJacobianType;
  typedef typename Superclass::CoordinateRepresentationType  CoordinateRepresentationType;
  typedef typename Superclass::NumberOfParametersType        NumberOfParametersType;
 
  double m_MaximumStepLength;
  double m_RegularizationKappa;
  double m_ConditionNumber;
 
private:
 
  ComputePreconditionerUsingDisplacementDistribution( const Self & ); // purposely not implemented
  void operator=( const Self & );                  // purposely not implemented
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkComputePreconditionerUsingDisplacementDistribution.hxx"
#endif
 
#endif // end #ifndef __itkComputePreconditionerUsingDisplacementDistribution_h