itkGaussianExponentialDiffeomorphicTransform.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 itkGaussianExponentialDiffeomorphicTransform_h
#define itkGaussianExponentialDiffeomorphicTransform_h
 
#include "itkConstantVelocityFieldTransform.h"
 
#include "itkGaussianOperator.h"
#include "itkVectorNeighborhoodOperatorImageFilter.h"
 
namespace itk
{

template <typename TParametersValueType, unsigned int VDimension>
class ITK_TEMPLATE_EXPORT GaussianExponentialDiffeomorphicTransform
  : public ConstantVelocityFieldTransform<TParametersValueType, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GaussianExponentialDiffeomorphicTransform);

  using Self = GaussianExponentialDiffeomorphicTransform;
  using Superclass = ConstantVelocityFieldTransform<TParametersValueType, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(GaussianExponentialDiffeomorphicTransform);

  itkNewMacro(Self);

  static constexpr unsigned int ConstantVelocityFieldDimension = VDimension;

  static constexpr unsigned int Dimension = VDimension;

  using typename Superclass::ScalarType;
  using typename Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;
 
  using typename Superclass::DisplacementFieldType;
  using typename Superclass::DisplacementFieldPointer;
  using typename Superclass::ConstantVelocityFieldType;
  using typename Superclass::ConstantVelocityFieldPointer;
 
  using DisplacementVectorType = typename DisplacementFieldType::PixelType;

  void
  UpdateTransformParameters(const DerivativeType & update, ScalarType factor = 1.0) override;

  virtual ConstantVelocityFieldPointer
  GaussianSmoothConstantVelocityField(ConstantVelocityFieldType *, ScalarType);

  itkSetMacro(GaussianSmoothingVarianceForTheConstantVelocityField, ScalarType);
  itkGetConstMacro(GaussianSmoothingVarianceForTheConstantVelocityField, ScalarType);

  itkSetMacro(GaussianSmoothingVarianceForTheUpdateField, ScalarType);
  itkGetConstMacro(GaussianSmoothingVarianceForTheUpdateField, ScalarType);
 
protected:
  GaussianExponentialDiffeomorphicTransform();
  ~GaussianExponentialDiffeomorphicTransform() override = default;

  using GaussianSmoothingOperatorType = GaussianOperator<ScalarType, VDimension>;
 
  using GaussianSmoothingSmootherType =
    VectorNeighborhoodOperatorImageFilter<ConstantVelocityFieldType, ConstantVelocityFieldType>;
 
  GaussianSmoothingOperatorType m_GaussianSmoothingOperator{};
 
  void
  PrintSelf(std::ostream &, Indent) const override;
 
private:
  ScalarType m_GaussianSmoothingVarianceForTheUpdateField{};
  ScalarType m_GaussianSmoothingVarianceForTheConstantVelocityField{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaussianExponentialDiffeomorphicTransform.hxx"
#endif
 
#endif // itkGaussianExponentialDiffeomorphicTransform_h