itkGrayscaleErodeImageFilter.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 itkGrayscaleErodeImageFilter_h
#define itkGrayscaleErodeImageFilter_h
 
#include "itkKernelImageFilter.h"
#include "itkMathematicalMorphologyEnums.h"
#include "itkMovingHistogramErodeImageFilter.h"
#include "itkBasicErodeImageFilter.h"
#include "itkAnchorErodeImageFilter.h"
#include "itkVanHerkGilWermanErodeImageFilter.h"
#include "itkCastImageFilter.h"
#include "itkConstantBoundaryCondition.h"
#include "itkNeighborhood.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT GrayscaleErodeImageFilter : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(GrayscaleErodeImageFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(GrayscaleErodeImageFilter);

  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 HistogramFilterType = MovingHistogramErodeImageFilter<TInputImage, TOutputImage, TKernel>;
  using BasicFilterType = BasicErodeImageFilter<TInputImage, TOutputImage, TKernel>;
 
  using FlatKernelType = FlatStructuringElement<Self::ImageDimension>;
 
  using AnchorFilterType = AnchorErodeImageFilter<TInputImage, FlatKernelType>;
  using VHGWFilterType = VanHerkGilWermanErodeImageFilter<TInputImage, FlatKernelType>;
  using CastFilterType = CastImageFilter<TInputImage, TOutputImage>;

  using ImageBoundaryConditionPointerType = ImageBoundaryCondition<InputImageType> *;
  using ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition<InputImageType> *;
  using DefaultBoundaryConditionType = ConstantBoundaryCondition<InputImageType>;

  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 = AlgorithmType::BASIC;
  static constexpr AlgorithmType HISTO = AlgorithmType::HISTO;
  static constexpr AlgorithmType ANCHOR = AlgorithmType::ANCHOR;
  static constexpr AlgorithmType VHGW = AlgorithmType::VHGW;
#endif

  void
  SetKernel(const KernelType & kernel) override;

  void
  SetBoundary(const PixelType value);
 
  itkGetConstMacro(Boundary, PixelType);

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

  void
  Modified() const override;
 
  void
  SetNumberOfWorkUnits(ThreadIdType nb) override;
 
protected:
  GrayscaleErodeImageFilter();
  ~GrayscaleErodeImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
private:
  PixelType m_Boundary{};
 
  // the filters used internally
  typename HistogramFilterType::Pointer m_HistogramFilter{};
 
  typename BasicFilterType::Pointer m_BasicFilter{};
 
  typename AnchorFilterType::Pointer m_AnchorFilter{};
 
  typename VHGWFilterType::Pointer m_VHGWFilter{};
 
  // and the name of the filter
  AlgorithmEnum m_Algorithm{};
 
  // the boundary condition need to be stored here
  DefaultBoundaryConditionType m_BoundaryCondition{};
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGrayscaleErodeImageFilter.hxx"
#endif
 
#endif