itkMultiResolutionPyramidImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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 itkMultiResolutionPyramidImageFilter_h
#define itkMultiResolutionPyramidImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkArray2D.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT MultiResolutionPyramidImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiResolutionPyramidImageFilter);

  using Self = MultiResolutionPyramidImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MultiResolutionPyramidImageFilter);

  using ScheduleType = Array2D<unsigned int>;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::OutputImagePointer;
  using typename Superclass::InputImageConstPointer;

  virtual void
  SetNumberOfLevels(unsigned int num);

  itkGetConstMacro(NumberOfLevels, unsigned int);

  virtual void
  SetSchedule(const ScheduleType & schedule);

  itkGetConstReferenceMacro(Schedule, ScheduleType);

  virtual void
  SetStartingShrinkFactors(unsigned int factor);
 
  virtual void
  SetStartingShrinkFactors(const unsigned int * factors);

  const unsigned int *
  GetStartingShrinkFactors() const;

  static bool
  IsScheduleDownwardDivisible(const ScheduleType & schedule);

  void
  GenerateOutputInformation() override;

  void
  GenerateOutputRequestedRegion(DataObject * refOutput) override;

  void
  GenerateInputRequestedRegion() override;
 
  itkSetMacro(MaximumError, double);
  itkGetConstReferenceMacro(MaximumError, double);
 
  itkSetMacro(UseShrinkImageFilter, bool);
  itkGetConstMacro(UseShrinkImageFilter, bool);
  itkBooleanMacro(UseShrinkImageFilter);
 
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<typename TOutputImage::PixelType>));
 
protected:
  MultiResolutionPyramidImageFilter();
  ~MultiResolutionPyramidImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;
 
  double m_MaximumError{};
 
  unsigned int m_NumberOfLevels{};
  ScheduleType m_Schedule{};
 
  bool m_UseShrinkImageFilter{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiResolutionPyramidImageFilter.hxx"
#endif
 
#endif