rtkUnwarpSequenceConjugateGradientOperator.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 rtkUnwarpSequenceConjugateGradientOperator_h
#define rtkUnwarpSequenceConjugateGradientOperator_h

#include "rtkWarpSequenceImageFilter.h"
#include "rtkConjugateGradientOperator.h"

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 UnwarpSequenceConjugateGradientOperator : public ConjugateGradientOperator<TImageSequence>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(UnwarpSequenceConjugateGradientOperator);

  using Self = UnwarpSequenceConjugateGradientOperator;
  using Superclass = ConjugateGradientOperator<TImageSequence>;
  using Pointer = itk::SmartPointer<Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(UnwarpSequenceConjugateGradientOperator);

  using WarpSequenceFilterType = rtk::WarpSequenceImageFilter<TImageSequence, TDVFImageSequence, TImage, TDVFImage>;

  void
  SetDisplacementField(const TDVFImageSequence * DVFs);

  typename TDVFImageSequence::Pointer
  GetDisplacementField();

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

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

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

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

  void
  GenerateData() override;

  typename WarpSequenceFilterType::Pointer m_WarpSequenceBackwardFilter;
  typename WarpSequenceFilterType::Pointer m_WarpSequenceForwardFilter;

  float m_PhaseShift;
  bool  m_UseNearestNeighborInterpolationInWarping; // Default is false, linear interpolation is used instead

  void
  VerifyInputInformation() const override
  {}

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

  bool m_UseCudaCyclicDeformation;
};
} // namespace rtk


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

#endif