itkFixedPointInverseDisplacementFieldImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkFixedPointInverseDisplacementFieldImageFilter_h
#define itkFixedPointInverseDisplacementFieldImageFilter_h


#include "itkImageToImageFilter.h"

#include "itkWarpVectorImageFilter.h"
#include "itkVectorLinearInterpolateImageFunction.h"
#include "itkImageRegionIterator.h"
#include "itkTimeProbe.h"

namespace itk
{

template < typename TInputImage, typename TOutputImage >
class ITK_TEMPLATE_EXPORT FixedPointInverseDisplacementFieldImageFilter :
    public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(FixedPointInverseDisplacementFieldImageFilter);

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

  itkNewMacro(Self);

  itkTypeMacro(FixedPointInverseDisplacementFieldImageFilter, ImageToImageFilter);


  using InputImageType = TInputImage;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImagePointType = typename InputImageType::PointType;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImageSpacingType = typename InputImageType::SpacingType;
  using InputImageIndexType = typename InputImageType::IndexType;


  using OutputImageType = TOutputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using OutputImagePixelType = typename OutputImageType::PixelType;
  using OutputImagePointType = typename OutputImageType::PointType;
  using OutputImageIndexType = typename OutputImageType::IndexType;
  using OutputImageValueType = typename OutputImagePixelType::ValueType;
  using OutputImageSizeType = typename OutputImageType::SizeType;
  using OutputImageSpacingType = typename OutputImageType::SpacingType;
  using OutputImageOriginPointType = typename TOutputImage::PointType;
  using TimeType = TimeProbe;


  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using InputConstIterator = ImageRegionConstIterator<InputImageType>;
  using InputIterator = ImageRegionIterator<InputImageType>;
  using OutputConstIterator = ImageRegionConstIterator<OutputImageType>;
  using OutputIterator = ImageRegionIterator<OutputImageType>;

  using VectorWarperType = WarpVectorImageFilter<TOutputImage,TInputImage,TOutputImage>;
  using InterpolatorVectorType = typename NumericTraits<typename TOutputImage::PixelType>::RealType;
  using OutputVectorType = typename TOutputImage::PixelType;
  using FieldInterpolatorType = VectorLinearInterpolateImageFunction<TInputImage, double>;
  using FieldInterpolatorPointer = typename FieldInterpolatorType::Pointer;
  using FieldInterpolatorOutputType = typename FieldInterpolatorType::OutputType;


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


  itkSetMacro( Size, OutputImageSizeType );

  itkGetConstReferenceMacro( Size, OutputImageSizeType );

  itkSetMacro(OutputSpacing, OutputImageSpacingType);
  virtual void SetOutputSpacing(const double* values);

  itkGetConstReferenceMacro( OutputSpacing, OutputImageSpacingType );

  itkSetMacro(OutputOrigin, OutputImageOriginPointType);
  virtual void SetOutputOrigin( const double* values);

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(OutputHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<OutputImageValueType>));
  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< TInputImage::ImageDimension, TOutputImage::ImageDimension > ) );

#endif

protected:
  FixedPointInverseDisplacementFieldImageFilter();
  ~FixedPointInverseDisplacementFieldImageFilter() override {}

  void PrintSelf(std::ostream& os, Indent indent) const override;

  void GenerateData( ) override;
  void GenerateOutputInformation() override;

  void GenerateInputRequestedRegion() override;

  unsigned int m_NumberOfIterations;


private:
  OutputImageSizeType                      m_Size;              // Size of the output image
  OutputImageSpacingType                   m_OutputSpacing;     // output image spacing
  OutputImageOriginPointType               m_OutputOrigin;      // output image origin

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFixedPointInverseDisplacementFieldImageFilter.hxx"
#endif
#endif