itkGaussianSmoothingOnUpdateDisplacementFieldTransform.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 itkGaussianSmoothingOnUpdateDisplacementFieldTransform_h
#define itkGaussianSmoothingOnUpdateDisplacementFieldTransform_h
 
#include "itkDisplacementFieldTransform.h"
 
#include "itkGaussianOperator.h"
#include "itkVectorNeighborhoodOperatorImageFilter.h"
 
namespace itk
{

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

  using Self = GaussianSmoothingOnUpdateDisplacementFieldTransform;
  using Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(GaussianSmoothingOnUpdateDisplacementFieldTransform);

  itkNewMacro(Self);

  using typename Superclass::ScalarType;
  using typename Superclass::DerivativeType;
  using DerivativeValueType = typename DerivativeType::ValueType;
  using typename Superclass::DisplacementFieldType;
  using typename Superclass::DisplacementFieldPointer;
  using DisplacementVectorType = typename DisplacementFieldType::PixelType;
 
  using TransformPointer = typename Transform<TParametersValueType, VDimension, VDimension>::Pointer;

  itkSetMacro(GaussianSmoothingVarianceForTheUpdateField, ScalarType);
  itkGetConstReferenceMacro(GaussianSmoothingVarianceForTheUpdateField, ScalarType);

  itkSetMacro(GaussianSmoothingVarianceForTheTotalField, ScalarType);
  itkGetConstReferenceMacro(GaussianSmoothingVarianceForTheTotalField, ScalarType);

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

  virtual DisplacementFieldPointer
  GaussianSmoothDisplacementField(DisplacementFieldType *, ScalarType);
 
protected:
  GaussianSmoothingOnUpdateDisplacementFieldTransform();
  ~GaussianSmoothingOnUpdateDisplacementFieldTransform() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  typename LightObject::Pointer
  InternalClone() const override;

  ScalarType m_GaussianSmoothingVarianceForTheUpdateField{};
  ScalarType m_GaussianSmoothingVarianceForTheTotalField{};

  using GaussianSmoothingOperatorType = GaussianOperator<ScalarType, Superclass::Dimension>;
  using GaussianSmoothingSmootherType =
    VectorNeighborhoodOperatorImageFilter<DisplacementFieldType, DisplacementFieldType>;
  GaussianSmoothingOperatorType m_GaussianSmoothingOperator{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGaussianSmoothingOnUpdateDisplacementFieldTransform.hxx"
#endif
 
#endif // itkGaussianSmoothingOnUpdateDisplacementFieldTransform_h