itkExponentialDisplacementFieldImageFilter.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 itkExponentialDisplacementFieldImageFilter_h
#define itkExponentialDisplacementFieldImageFilter_h
 
#include "itkDivideImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkWarpVectorImageFilter.h"
#include "itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h"
#include "itkAddImageFilter.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ExponentialDisplacementFieldImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ExponentialDisplacementFieldImageFilter);

  using Self = ExponentialDisplacementFieldImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ExponentialDisplacementFieldImageFilter);

  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputPixelType = typename InputImageType::PixelType;
  using InputPixelRealValueType = typename InputPixelType::RealValueType;
 
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputPixelType = typename OutputImageType::PixelType;

  itkSetMacro(MaximumNumberOfIterations, unsigned int);
  itkGetConstMacro(MaximumNumberOfIterations, unsigned int);

  itkSetMacro(AutomaticNumberOfIterations, bool);
  itkGetConstMacro(AutomaticNumberOfIterations, bool);
  itkBooleanMacro(AutomaticNumberOfIterations);

  itkSetMacro(ComputeInverse, bool);
  itkGetConstMacro(ComputeInverse, bool);
  itkBooleanMacro(ComputeInverse);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int PixelDimension = InputPixelType::Dimension;
  static constexpr unsigned int OutputPixelDimension = OutputPixelType::Dimension;
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<typename OutputPixelType::ValueType>));
  itkConceptMacro(SameDimensionCheck1, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(SameDimensionCheck2, (Concept::SameDimension<ImageDimension, PixelDimension>));
  itkConceptMacro(SameDimensionCheck3, (Concept::SameDimension<ImageDimension, OutputPixelDimension>));
 
protected:
  ExponentialDisplacementFieldImageFilter();
  ~ExponentialDisplacementFieldImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;
 
  using RegionType = typename InputImageType::RegionType;
 
  using DivideByConstantType =
    DivideImageFilter<InputImageType, itk::Image<InputPixelRealValueType, ImageDimension>, OutputImageType>;
 
  using CasterType = CastImageFilter<InputImageType, OutputImageType>;
 
  using VectorWarperType = WarpVectorImageFilter<OutputImageType, OutputImageType, OutputImageType>;
 
  using FieldInterpolatorType = VectorLinearInterpolateNearestNeighborExtrapolateImageFunction<OutputImageType, double>;
 
  using AdderType = AddImageFilter<OutputImageType, OutputImageType, OutputImageType>;
 
  using DivideByConstantPointer = typename DivideByConstantType::Pointer;
  using CasterPointer = typename CasterType::Pointer;
  using VectorWarperPointer = typename VectorWarperType::Pointer;
  using FieldInterpolatorPointer = typename FieldInterpolatorType::Pointer;
  using FieldInterpolatorOutputType = typename FieldInterpolatorType::OutputType;
  using AdderPointer = typename AdderType::Pointer;
 
private:
  bool         m_AutomaticNumberOfIterations{};
  unsigned int m_MaximumNumberOfIterations{};
 
  bool m_ComputeInverse{};
 
  DivideByConstantPointer m_Divider{};
  CasterPointer           m_Caster{};
  VectorWarperPointer     m_Warper{};
  AdderPointer            m_Adder{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkExponentialDisplacementFieldImageFilter.hxx"
#endif
 
#endif