itkMorphologicalGradientImageFilter.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 itkMorphologicalGradientImageFilter_h
#define itkMorphologicalGradientImageFilter_h
 
#include "itkKernelImageFilter.h"
#include "itkMathematicalMorphologyEnums.h"
#include "itkMovingHistogramMorphologicalGradientImageFilter.h"
#include "itkBasicDilateImageFilter.h"
#include "itkBasicErodeImageFilter.h"
#include "itkAnchorErodeImageFilter.h"
#include "itkAnchorDilateImageFilter.h"
#include "itkVanHerkGilWermanDilateImageFilter.h"
#include "itkVanHerkGilWermanErodeImageFilter.h"
#include "itkSubtractImageFilter.h"
#include "itkConstantBoundaryCondition.h"
#include "itkNeighborhood.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT MorphologicalGradientImageFilter
  : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MorphologicalGradientImageFilter);

  using Self = MorphologicalGradientImageFilter;
  using Superclass = KernelImageFilter<TInputImage, TOutputImage, TKernel>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MorphologicalGradientImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using RegionType = typename TInputImage::RegionType;
  using SizeType = typename TInputImage::SizeType;
  using IndexType = typename TInputImage::IndexType;
  using PixelType = typename TInputImage::PixelType;
  using OffsetType = typename TInputImage::OffsetType;
  using typename Superclass::OutputImageRegionType;
 
  using FlatKernelType = FlatStructuringElement<Self::ImageDimension>;
  using HistogramFilterType = MovingHistogramMorphologicalGradientImageFilter<TInputImage, TOutputImage, TKernel>;
  using BasicDilateFilterType = BasicDilateImageFilter<TInputImage, TInputImage, TKernel>;
  using BasicErodeFilterType = BasicErodeImageFilter<TInputImage, TInputImage, TKernel>;
  using AnchorDilateFilterType = AnchorDilateImageFilter<TInputImage, FlatKernelType>;
  using AnchorErodeFilterType = AnchorErodeImageFilter<TInputImage, FlatKernelType>;
  using VHGWDilateFilterType = VanHerkGilWermanDilateImageFilter<TInputImage, FlatKernelType>;
  using VHGWErodeFilterType = VanHerkGilWermanErodeImageFilter<TInputImage, FlatKernelType>;
  using SubtractFilterType = SubtractImageFilter<TInputImage, TInputImage, TOutputImage>;

  using KernelType = TKernel;
  //   using KernelSuperclass = typename KernelType::Superclass;
  //   using KernelSuperclass = Neighborhood< typename KernelType::PixelType, ImageDimension >;
 
  using AlgorithmEnum = MathematicalMorphologyEnums::Algorithm;
 
#if !defined(ITK_LEGACY_REMOVE)
  using AlgorithmType = AlgorithmEnum;
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr AlgorithmType BASIC = AlgorithmEnum::BASIC;
  static constexpr AlgorithmType HISTO = AlgorithmEnum::HISTO;
  static constexpr AlgorithmType ANCHOR = AlgorithmEnum::ANCHOR;
  static constexpr AlgorithmType VHGW = AlgorithmEnum::VHGW;
#endif

  void
  SetKernel(const KernelType & kernel) override;

  void
  SetAlgorithm(AlgorithmEnum algo);
  itkGetConstMacro(Algorithm, AlgorithmEnum);

  void
  Modified() const override;
 
protected:
  MorphologicalGradientImageFilter();
  ~MorphologicalGradientImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
private:
  // the filters used internally
  typename HistogramFilterType::Pointer m_HistogramFilter{};
 
  typename BasicDilateFilterType::Pointer m_BasicDilateFilter{};
 
  typename BasicErodeFilterType::Pointer m_BasicErodeFilter{};
 
  typename AnchorDilateFilterType::Pointer m_AnchorDilateFilter{};
 
  typename AnchorErodeFilterType::Pointer m_AnchorErodeFilter{};
 
  typename VHGWDilateFilterType::Pointer m_VanHerkGilWermanDilateFilter{};
 
  typename VHGWErodeFilterType::Pointer m_VanHerkGilWermanErodeFilter{};
 
  // and the name of the filter
  AlgorithmEnum m_Algorithm{};
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMorphologicalGradientImageFilter.hxx"
#endif
 
#endif