itkConvolutionImageFilter.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 itkConvolutionImageFilter_h
#define itkConvolutionImageFilter_h
 
#include "itkConvolutionImageFilterBase.h"
 
#include "itkProgressAccumulator.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"
 
namespace itk
{
template <typename TInputImage, typename TKernelImage = TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ConvolutionImageFilter
  : public ConvolutionImageFilterBase<TInputImage, TKernelImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConvolutionImageFilter);
 
  using Self = ConvolutionImageFilter;
  using Superclass = ConvolutionImageFilterBase<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ConvolutionImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using KernelImageType = TKernelImage;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
  using KernelPixelType = typename KernelImageType::PixelType;
  using InputIndexType = typename InputImageType::IndexType;
  using OutputIndexType = typename OutputImageType::IndexType;
  using KernelIndexType = typename KernelImageType::IndexType;
  using InputSizeType = typename InputImageType::SizeType;
  using OutputSizeType = typename OutputImageType::SizeType;
  using KernelSizeType = typename KernelImageType::SizeType;
  using InputRegionType = typename InputImageType::RegionType;
  using OutputRegionType = typename OutputImageType::RegionType;
  using KernelRegionType = typename KernelImageType::RegionType;
 
protected:
  ConvolutionImageFilter() = default;
  ~ConvolutionImageFilter() override = default;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;

  bool
  GetKernelNeedsPadding() const;

  KernelSizeType
  GetKernelPadSize() const;

  template <typename TImage>
  KernelSizeType
  GetKernelRadius(const TImage * kernelImage) const;
 
private:
  template <typename TImage>
  void
  ComputeConvolution(const TImage * kernelImage, ProgressAccumulator * progress);
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConvolutionImageFilter.hxx"
#endif
 
#endif