itkGenericMultiResolutionPyramidImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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 itkGenericMultiResolutionPyramidImageFilter_h
#define itkGenericMultiResolutionPyramidImageFilter_h
 
#include "itkMultiResolutionPyramidImageFilter.h"
#include "itkSmoothingRecursiveGaussianImageFilter.h"
 
namespace itk
{
template <class TInputImage, class TOutputImage, class TPrecisionType = double>
class ITK_TEMPLATE_EXPORT GenericMultiResolutionPyramidImageFilter
  : public MultiResolutionPyramidImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GenericMultiResolutionPyramidImageFilter);
 
  using Self = GenericMultiResolutionPyramidImageFilter;
  using Superclass = MultiResolutionPyramidImageFilter<TInputImage, TOutputImage>;
  using SuperSuperclass = typename Superclass::Superclass;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(GenericMultiResolutionPyramidImageFilter, MultiResolutionPyramidImageFilter);
 
  itkStaticConstMacro(ImageDimension, unsigned int, TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, TOutputImage::ImageDimension);
 
  using typename Superclass::ScheduleType;
  using typename Superclass::InputImageType;
  using typename Superclass::OutputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::OutputImagePointer;
  using typename Superclass::InputImageConstPointer;
  using SpacingType = typename Superclass::InputImageType::SpacingType;
  using PixelType = typename InputImageType::PixelType;
  using ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType;
 
  using SmoothingScheduleType = vnl_matrix<ScalarRealType>;
  using RescaleScheduleType = ScheduleType;
 
  using SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>;
  using RescaleFactorArrayType = SigmaArrayType;
 
  void
  SetSchedule(const ScheduleType & schedule) override;
 
  virtual void
  SetRescaleSchedule(const RescaleScheduleType & schedule);
 
  virtual void
  SetRescaleScheduleToUnity();
 
  const RescaleScheduleType &
  GetRescaleSchedule() const
  {
    return this->m_Schedule;
  }
 
 
  virtual void
  SetSmoothingSchedule(const SmoothingScheduleType & schedule);
 
  virtual void
  SetSmoothingScheduleToZero();
 
  itkGetConstReferenceMacro(SmoothingSchedule, SmoothingScheduleType);
 
  void
  SetNumberOfLevels(unsigned int num) override;
 
  virtual void
  SetCurrentLevel(unsigned int level);
 
  itkGetConstReferenceMacro(CurrentLevel, unsigned int);
 
  virtual void
  SetComputeOnlyForCurrentLevel(const bool _arg);
 
  itkGetConstMacro(ComputeOnlyForCurrentLevel, bool);
  itkBooleanMacro(ComputeOnlyForCurrentLevel);
 
#ifdef ITK_USE_CONCEPT_CHECKING
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<typename TOutputImage::PixelType>));
#endif
 
protected:
  GenericMultiResolutionPyramidImageFilter();
  ~GenericMultiResolutionPyramidImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateOutputInformation() override;
 
  void
  GenerateOutputRequestedRegion(DataObject * output) override;
 
  void
  GenerateInputRequestedRegion() override;
 
  void
  GenerateData() override;
 
  void
  ReleaseOutputs();
 
  SmoothingScheduleType m_SmoothingSchedule{};
  unsigned int          m_CurrentLevel{};
  bool                  m_ComputeOnlyForCurrentLevel{};
  bool                  m_SmoothingScheduleDefined{};
 
private:
  using SmootherType = SmoothingRecursiveGaussianImageFilter<InputImageType, OutputImageType>;
 
  using ImageToImageFilterSameTypes = ImageToImageFilter<OutputImageType, OutputImageType>;
  using ImageToImageFilterDifferentTypes = ImageToImageFilter<InputImageType, OutputImageType>;
 
  bool
  SetupSmoother(const unsigned int               level,
                typename SmootherType::Pointer & smoother,
                const InputImageConstPointer &   input);
 
  int
  SetupShrinkerOrResampler(const unsigned int                                   level,
                           typename SmootherType::Pointer &                     smoother,
                           const bool                                           sameType,
                           const InputImageConstPointer &                       input,
                           const OutputImagePointer &                           outputPtr,
                           typename ImageToImageFilterSameTypes::Pointer &      rescaleSameTypes,
                           typename ImageToImageFilterDifferentTypes::Pointer & rescaleDifferentTypes);
 
  void
  DefineShrinkerOrResampler(const bool                                           sameType,
                            const RescaleFactorArrayType &                       shrinkFactors,
                            const OutputImagePointer &                           outputPtr,
                            typename ImageToImageFilterSameTypes::Pointer &      rescaleSameTypes,
                            typename ImageToImageFilterDifferentTypes::Pointer & rescaleDifferentTypes);
 
  void
  SetSmoothingScheduleToDefault();
 
  bool
  ComputeForCurrentLevel(const unsigned int level) const;
 
  double
  GetDefaultSigma(const unsigned int   level,
                  const unsigned int   dim,
                  const unsigned int * factors,
                  const SpacingType &  spacing) const;
 
  void
  GetSigma(const unsigned int level, SigmaArrayType & sigmaArray) const;
 
  void
  GetShrinkFactors(const unsigned int level, RescaleFactorArrayType & shrinkFactors) const;
 
  bool
  AreSigmasAllZeros(const SigmaArrayType & sigmaArray) const;
 
  bool
  AreRescaleFactorsAllOnes(const RescaleFactorArrayType & rescaleFactorArray) const;
 
  bool
  IsSmoothingUsed() const;
 
  bool
  IsRescaleUsed() const;
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGenericMultiResolutionPyramidImageFilter.hxx"
#endif
 
#endif