itkGradientMagnitudeRecursiveGaussianImageFilter.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 itkGradientMagnitudeRecursiveGaussianImageFilter_h
#define itkGradientMagnitudeRecursiveGaussianImageFilter_h
 
#include "itkNthElementImageAdaptor.h"
#include "itkImage.h"
#include "itkPixelTraits.h"
#include "itkRecursiveGaussianImageFilter.h"
#include "itkSqrtImageFilter.h"
#include "itkBinaryGeneratorImageFilter.h"
#include <array>
 
namespace itk
{
// NOTE that the typename macro has to be used here in lieu
// of "typename" because VC++ doesn't like the typename keyword
// on the defaults of template parameters
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT GradientMagnitudeRecursiveGaussianImageFilter
  : public InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GradientMagnitudeRecursiveGaussianImageFilter);

  using Self = GradientMagnitudeRecursiveGaussianImageFilter;
  using Superclass = InPlaceImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using InputImageType = TInputImage;
  using PixelType = typename InputImageType::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  using RealType = typename NumericTraits<PixelType>::RealType;

 
  using InternalRealType = float;
  using RealImageType = Image<InternalRealType, Self::ImageDimension>;

  using GaussianFilterType = RecursiveGaussianImageFilter<RealImageType, RealImageType>;

  using DerivativeFilterType = RecursiveGaussianImageFilter<InputImageType, RealImageType>;

  using SqrtFilterType = SqrtImageFilter<RealImageType, TOutputImage>;

  using GaussianFilterPointer = typename GaussianFilterType::Pointer;

  using DerivativeFilterPointer = typename DerivativeFilterType::Pointer;
 
  using SqrtFilterPointer = typename SqrtFilterType::Pointer;

  using OutputImagePointer = typename TOutputImage::Pointer;

  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;

  using CumulativeImageType = Image<InternalRealType, Self::ImageDimension>;
  using CumulativeImagePointer = typename CumulativeImageType::Pointer;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GradientMagnitudeRecursiveGaussianImageFilter);

  void
  SetSigma(RealType sigma);
  RealType
  GetSigma();
  void
  SetNormalizeAcrossScale(bool normalize);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);
  void
  SetNumberOfWorkUnits(ThreadIdType nb) override;
 
  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<PixelType>));
 
protected:
  GradientMagnitudeRecursiveGaussianImageFilter();
  ~GradientMagnitudeRecursiveGaussianImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
private:
  using SqrSpacingFilterType = BinaryGeneratorImageFilter<RealImageType, RealImageType, RealImageType>;
  using SqrSpacingFilterPointer = typename SqrSpacingFilterType::Pointer;
 
  std::array<GaussianFilterPointer, ImageDimension - 1> m_SmoothingFilters{};
  DerivativeFilterPointer                               m_DerivativeFilter{};
  SqrSpacingFilterPointer                               m_SqrSpacingFilter{};
  SqrtFilterPointer                                     m_SqrtFilter{};

  bool m_NormalizeAcrossScale{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGradientMagnitudeRecursiveGaussianImageFilter.hxx"
#endif
 
#endif