rtkCyclicDeformationImageFilter.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 rtkCyclicDeformationImageFilter_h
#define rtkCyclicDeformationImageFilter_h

#include <itkImageToImageFilter.h>

#include "rtkConfiguration.h"
#include "rtkMacro.h"

namespace rtk
{

template <class TInputImage, class TOutputImage>
class ITK_TEMPLATE_EXPORT CyclicDeformationImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CyclicDeformationImageFilter);

  using Self = CyclicDeformationImageFilter;
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using Superclass = itk::ImageToImageFilter<InputImageType, OutputImageType>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;
  using OutputImageRegionType = typename OutputImageType::RegionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CyclicDeformationImageFilter);

  itkGetMacro(SignalFilename, std::string);
  virtual void
  SetSignalFilename(const std::string _arg);
  virtual void
  SetSignalVector(std::vector<double> _arg);

  itkGetMacro(Frame, unsigned int);
  itkSetMacro(Frame, unsigned int);

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

  void
  GenerateOutputInformation() override;
  void
  GenerateInputRequestedRegion() override;
  void
  BeforeThreadedGenerateData() override;
  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

  // Linear interpolation position and weights
  unsigned int m_FrameInf;
  unsigned int m_FrameSup;
  double       m_WeightInf;
  double       m_WeightSup;

private:
  unsigned int m_Frame{ 0 };

  std::string         m_SignalFilename;
  std::vector<double> m_Signal;
};

} // end namespace rtk

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

#endif