rtkUpsampleImageFilter.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 rtkUpsampleImageFilter_h
#define rtkUpsampleImageFilter_h

#include <itkImageToImageFilter.h>
#include <itkImageRegionSplitterDirection.h>

namespace rtk
{

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

  using Self = UpsampleImageFilter;
  using Superclass = itk::ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  itkNewMacro(Self);

#ifdef itkOverrideGetNameOfClassMacro
  itkOverrideGetNameOfClassMacro(UpsampleImageFilter);
#else
  itkTypeMacro(UpsampleImageFilter, ImageToImageFilter);
#endif


  using OutputImageType = TOutputImage;
  using InputImageType = TInputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  void
  SetFactors(const unsigned int factors[]);

  void
  SetFactor(unsigned int dimension, unsigned int factor);

  void
  GenerateOutputInformation() override;

  void
  GenerateInputRequestedRegion() override;

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

  itkSetMacro(OutputSize, typename TOutputImage::SizeType);
  itkGetMacro(OutputSize, typename TOutputImage::SizeType);

  itkSetMacro(OutputIndex, typename TOutputImage::IndexType);
  itkGetMacro(OutputIndex, typename TOutputImage::IndexType);

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

  void
  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
                       itk::ThreadIdType             itkNotUsed(threadId)) override;

private:
  unsigned int                     m_Factors[ImageDimension];
  unsigned int                     m_Order;
  typename TOutputImage::SizeType  m_OutputSize;
  typename TOutputImage::IndexType m_OutputIndex;

  const itk::ImageRegionSplitterBase *
                                             GetImageRegionSplitter() const override;
  itk::ImageRegionSplitterDirection::Pointer m_Splitter;
};


} // end namespace rtk

#ifndef rtk_MANUAL_INSTANTIATION
#  include "rtkUpsampleImageFilter.hxx"
#endif

#endif