itkFFTDiscreteGaussianImageFilter.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 itkFFTDiscreteGaussianImageFilter_h
#define itkFFTDiscreteGaussianImageFilter_h
 
#include "itkDiscreteGaussianImageFilter.h"
#include "itkFFTConvolutionImageFilter.h"
#include "itkImage.h"
#include "itkMacro.h"
#include "ITKSmoothingExport.h"
 
namespace itk
{
class FFTDiscreteGaussianImageFilterEnums
{
public:
  enum class KernelSource : uint8_t
  {
    OPERATORS = 0,
    IMAGE_SOURCE,
  };
};
// Define how to print enumeration
extern ITKSmoothing_EXPORT std::ostream &
operator<<(std::ostream & out, const FFTDiscreteGaussianImageFilterEnums::KernelSource value);

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

  using Self = FFTDiscreteGaussianImageFilter;
  using Superclass = DiscreteGaussianImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FFTDiscreteGaussianImageFilter);

  using InputImageType = typename Superclass::InputImageType;
  using OutputImageType = typename Superclass::OutputImageType;

  using OutputPixelType = typename Superclass::OutputPixelType;
  using OutputInternalPixelType = typename Superclass::OutputInternalPixelType;
  using InputPixelType = typename Superclass::InputPixelType;
  using InputInternalPixelType = typename Superclass::InputInternalPixelType;

  using InputPixelValueType = typename Superclass::InputPixelValueType;
  using OutputPixelValueType = typename Superclass::OutputPixelValueType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using typename Superclass::RealOutputPixelType;
  using typename Superclass::RealOutputImageType;
  using typename Superclass::RealOutputPixelValueType;
  using RealPixelType = RealOutputPixelType;
  using RealImageType = RealOutputImageType;

  using typename Superclass::BoundaryConditionType;
  using typename Superclass::InputDefaultBoundaryConditionType;
  using typename Superclass::RealBoundaryConditionPointerType;
  using typename Superclass::RealDefaultBoundaryConditionType;

  using typename Superclass::ArrayType;
  using typename Superclass::SigmaArrayType;
  using typename Superclass::ScalarRealType;

  using typename Superclass::KernelType;
  using typename Superclass::RadiusType;

  using ConvolutionImageFilterType = FFTConvolutionImageFilter<RealImageType, RealImageType, OutputImageType>;

 
  void
  SetInputBoundaryCondition(BoundaryConditionType *) override;
 
  itkSetMacro(KernelSource, FFTDiscreteGaussianImageFilterEnums::KernelSource);
  itkGetConstMacro(KernelSource, FFTDiscreteGaussianImageFilterEnums::KernelSource);
 
  itkGetConstMacro(KernelImage, typename RealImageType::Pointer);
 
protected:
  FFTDiscreteGaussianImageFilter() = default;
  ~FFTDiscreteGaussianImageFilter() override = default;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;

  auto
  GenerateKernelImage() -> RealImageType *;
 
private:
  /* Enum for choosing among available kernel generation methods */
  FFTDiscreteGaussianImageFilterEnums::KernelSource m_KernelSource =
    FFTDiscreteGaussianImageFilterEnums::KernelSource::OPERATORS;
 
  /* Kernel image is allocated with GenerateKernelImage() */
  typename RealImageType::Pointer m_KernelImage{};
 
  /* Persist mini-pipeline filter to minimize construction costs
   * on repeated calls to GenerateData() */
  typename ConvolutionImageFilterType::Pointer m_ConvolutionImageFilter = ConvolutionImageFilterType::New();
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFFTDiscreteGaussianImageFilter.hxx"
#endif
 
#endif