rtkWarpSequenceImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK 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
 *
 *         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 rtkWarpSequenceImageFilter_h
#define rtkWarpSequenceImageFilter_h

#include "rtkConstantImageSource.h"

#include <itkExtractImageFilter.h>
#include <itkPasteImageFilter.h>
#include <itkCastImageFilter.h>
#include <itkNearestNeighborInterpolateImageFunction.h>

#ifdef RTK_USE_CUDA
#  include "rtkCudaWarpImageFilter.h"
#  include "rtkCudaForwardWarpImageFilter.h"
#  include "rtkCudaCyclicDeformationImageFilter.h"
#else
#  include <itkWarpImageFilter.h>
#  include "rtkForwardWarpImageFilter.h"
#  include "rtkCyclicDeformationImageFilter.h"
#endif

namespace rtk
{
template <typename TImageSequence,
          typename TDVFImageSequence =
            itk::Image<itk::CovariantVector<typename TImageSequence::ValueType, TImageSequence::ImageDimension - 1>,
                       TImageSequence::ImageDimension>,
          typename TImage = itk::Image<typename TImageSequence::ValueType, TImageSequence::ImageDimension - 1>,
          typename TDVFImage =
            itk::Image<itk::CovariantVector<typename TImageSequence::ValueType, TImageSequence::ImageDimension - 1>,
                       TImageSequence::ImageDimension - 1>>
class ITK_TEMPLATE_EXPORT WarpSequenceImageFilter : public itk::ImageToImageFilter<TImageSequence, TImageSequence>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(WarpSequenceImageFilter);

  using Self = WarpSequenceImageFilter;
  using Superclass = itk::ImageToImageFilter<TImageSequence, TImageSequence>;
  using Pointer = itk::SmartPointer<Self>;

  itkNewMacro(Self);

  using CPUImageType = typename itk::Image<typename TImage::PixelType, TImage::ImageDimension>;
  using CPUWarpFilterType = typename itk::WarpImageFilter<TImage, TImage, TDVFImage>;
#ifdef RTK_USE_CUDA
  typedef
    typename std::conditional<std::is_same<TImage, CPUImageType>::value, CPUWarpFilterType, CudaWarpImageFilter>::type
                                                                            WarpFilterType;
  typedef typename std::conditional<std::is_same<TImage, CPUImageType>::value,
                                    ForwardWarpImageFilter<TImage, TImage, TDVFImage>,
                                    CudaForwardWarpImageFilter>::type       ForwardWarpFilterType;
  typedef typename std::conditional<std::is_same<TImage, CPUImageType>::value,
                                    CyclicDeformationImageFilter<TDVFImageSequence, TDVFImage>,
                                    CudaCyclicDeformationImageFilter>::type CudaCyclicDeformationImageFilterType;
#else
  using WarpFilterType = CPUWarpFilterType;
  using ForwardWarpFilterType = ForwardWarpImageFilter<TImage, TImage, TDVFImage>;
  using CudaCyclicDeformationImageFilterType = CyclicDeformationImageFilter<TDVFImageSequence, TDVFImage>;
#endif

  itkOverrideGetNameOfClassMacro(WarpSequenceImageFilter);

  void
  SetDisplacementField(const TDVFImageSequence * DVFs);

  typename TDVFImageSequence::Pointer
  GetDisplacementField();

  itkGetMacro(ForwardWarp, bool);
  itkSetMacro(ForwardWarp, bool);

  itkSetMacro(PhaseShift, float);
  itkGetMacro(PhaseShift, float);

  itkSetMacro(UseNearestNeighborInterpolationInWarping, bool);
  itkGetMacro(UseNearestNeighborInterpolationInWarping, bool);

  itkSetMacro(UseCudaCyclicDeformation, bool);
  itkGetMacro(UseCudaCyclicDeformation, bool);

  using LinearInterpolatorType = itk::LinearInterpolateImageFunction<TImage, double>;
  using NearestNeighborInterpolatorType = itk::NearestNeighborInterpolateImageFunction<TImage, double>;
  using ExtractFilterType = itk::ExtractImageFilter<TImageSequence, TImage>;
  using DVFInterpolatorType = rtk::CyclicDeformationImageFilter<TDVFImageSequence, TDVFImage>;
  using PasteFilterType = itk::PasteImageFilter<TImageSequence, TImageSequence>;
  using CastFilterType = itk::CastImageFilter<TImage, TImageSequence>;
  using ConstantImageSourceType = rtk::ConstantImageSource<TImageSequence>;

protected:
  WarpSequenceImageFilter();
  ~WarpSequenceImageFilter() override = default;

  void
  GenerateData() override;

  typename CPUWarpFilterType::Pointer       m_WarpFilter;
  typename ExtractFilterType::Pointer       m_ExtractFilter;
  typename DVFInterpolatorType::Pointer     m_DVFInterpolatorFilter;
  typename PasteFilterType::Pointer         m_PasteFilter;
  typename CastFilterType::Pointer          m_CastFilter;
  typename ConstantImageSourceType::Pointer m_ConstantSource;

  typename TImageSequence::RegionType m_ExtractAndPasteRegion;

  bool  m_ForwardWarp;
  float m_PhaseShift;

  void
  VerifyInputInformation() const override
  {}

  void
  GenerateOutputInformation() override;
  void
  GenerateInputRequestedRegion() override;

  bool m_UseNearestNeighborInterpolationInWarping; // Default is false, linear interpolation is used instead
  bool m_UseCudaCyclicDeformation;
};
} // namespace rtk


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

#endif