rtkDownsampleImageFilter.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 rtkDownsampleImageFilter_h
#define rtkDownsampleImageFilter_h

#include "itkImageToImageFilter.h"

namespace rtk
{

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

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(DownsampleImageFilter);

  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;

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

  void
  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;

private:
  unsigned int m_Factors[ImageDimension];
  int          m_Offsets[ImageDimension];
};


} // end namespace rtk

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

#endif