itkInverseDisplacementFieldImageFilter.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 itkInverseDisplacementFieldImageFilter_h
#define itkInverseDisplacementFieldImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkKernelTransform.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT InverseDisplacementFieldImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(InverseDisplacementFieldImageFilter);

  using Self = InverseDisplacementFieldImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(InverseDisplacementFieldImageFilter);

  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using KernelTransformType = KernelTransform<double, Self::ImageDimension>;
  using KernelTransformPointerType = typename KernelTransformType::Pointer;

  using SizeType = typename OutputImageType::SizeType;

  using IndexType = typename OutputImageType::IndexType;

  using OutputPixelType = typename TOutputImage::PixelType;
  using OutputPixelComponentType = typename OutputPixelType::ValueType;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  using SpacingType = typename TOutputImage::SpacingType;
  using OriginPointType = typename TOutputImage::PointType;
  using DirectionType = typename TOutputImage::DirectionType;

  itkSetObjectMacro(KernelTransform, KernelTransformType);
  itkGetModifiableObjectMacro(KernelTransform, KernelTransformType);
  itkSetMacro(Size, SizeType);

  itkGetConstReferenceMacro(Size, SizeType);

  itkSetMacro(OutputSpacing, SpacingType);
  virtual void
  SetOutputSpacing(const double * spacing);
  itkGetConstReferenceMacro(OutputSpacing, SpacingType);

  itkSetMacro(OutputOrigin, OriginPointType);
  virtual void
  SetOutputOrigin(const double * origin);
  itkGetConstReferenceMacro(OutputOrigin, OriginPointType);

  virtual void
  SetOutputDirection(const DirectionType & direction);
  itkGetConstReferenceMacro(OutputDirection, DirectionType);

  itkSetMacro(SubsamplingFactor, unsigned int);
  itkGetConstMacro(SubsamplingFactor, unsigned int);
  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

  [[nodiscard]] ModifiedTimeType
  GetMTime() const override;

  void
  VerifyPreconditions() const override;

  void
  VerifyInputInformation() const override;
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputPixelComponentType>));
 
protected:
  InverseDisplacementFieldImageFilter();
  ~InverseDisplacementFieldImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;

  void
  PrepareKernelBaseSpline();
 
private:
  SizeType                   m_Size{};            // Size of the output image
  KernelTransformPointerType m_KernelTransform{}; // Coordinate transform to
                                                  // use
  SpacingType     m_OutputSpacing{};              // output image spacing
  OriginPointType m_OutputOrigin{};               // output image origin
  DirectionType   m_OutputDirection{};            // output image direction cosines
  bool            m_OutputDirectionSpecified{ false };
 
  unsigned int m_SubsamplingFactor{}; // factor to subsample the
                                      // input field.
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkInverseDisplacementFieldImageFilter.hxx"
#endif
 
#endif