itkSmoothingRecursiveGaussianImageFilter.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 itkSmoothingRecursiveGaussianImageFilter_h
#define itkSmoothingRecursiveGaussianImageFilter_h
 
#include "itkRecursiveGaussianImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkImage.h"
#include "itkPixelTraits.h"
#include "itkCommand.h"
#include <array>
 
namespace itk
{

 
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT SmoothingRecursiveGaussianImageFilter : public InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SmoothingRecursiveGaussianImageFilter);

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

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using PixelType = typename TInputImage::PixelType;
  using RealType = typename NumericTraits<PixelType>::RealType;
  using ScalarRealType = typename NumericTraits<PixelType>::ScalarRealType;

  itkOverrideGetNameOfClassMacro(SmoothingRecursiveGaussianImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using SigmaArrayType = FixedArray<ScalarRealType, Self::ImageDimension>;

  using InternalRealType = typename NumericTraits<PixelType>::FloatType;
  using RealImageType = typename InputImageType::template Rebind<InternalRealType>::Type;

  using FirstGaussianFilterType = RecursiveGaussianImageFilter<InputImageType, RealImageType>;

  using InternalGaussianFilterType = RecursiveGaussianImageFilter<RealImageType, RealImageType>;

  using CastingFilterType = CastImageFilter<RealImageType, OutputImageType>;

  using InternalGaussianFilterPointer = typename InternalGaussianFilterType::Pointer;

  using FirstGaussianFilterPointer = typename FirstGaussianFilterType::Pointer;

  using CastingFilterPointer = typename CastingFilterType::Pointer;

  using OutputImagePointer = typename OutputImageType::Pointer;

  itkNewMacro(Self);

  void
  SetSigmaArray(const SigmaArrayType & sigma);
  void
  SetSigma(ScalarRealType sigma);
  SigmaArrayType
  GetSigmaArray() const;

  ScalarRealType
  GetSigma() const;

  void
  SetNormalizeAcrossScale(bool normalize);
  itkGetConstMacro(NormalizeAcrossScale, bool);
  itkBooleanMacro(NormalizeAcrossScale);
  void
  SetNumberOfWorkUnits(ThreadIdType nb) override;
 
  [[nodiscard]] bool
  CanRunInPlace() const override;
 
  // This concept does not work with variable length vector images
  // itkConceptMacro( InputHasNumericTraitsCheck,
  //( Concept::HasNumericTraits< PixelType > ) );
 
protected:
  SmoothingRecursiveGaussianImageFilter();
  ~SmoothingRecursiveGaussianImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;
 
  // Override since the filter produces the entire dataset
  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
private:
  std::array<InternalGaussianFilterPointer, ImageDimension - 1> m_SmoothingFilters{};
  FirstGaussianFilterPointer                                    m_FirstSmoothingFilter{};
  CastingFilterPointer                                          m_CastingFilter{};
 
  bool m_NormalizeAcrossScale{ false };
 
  SigmaArrayType m_Sigma{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSmoothingRecursiveGaussianImageFilter.hxx"
#endif
 
#endif