itkObjectMorphologyImageFilter.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 itkObjectMorphologyImageFilter_h
#define itkObjectMorphologyImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkNeighborhoodIterator.h"
#include "itkConstSliceIterator.h"
#include "itkConstantBoundaryCondition.h"
#include "itkImageRegionIterator.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT ObjectMorphologyImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ObjectMorphologyImageFilter);

  using Self = ObjectMorphologyImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ObjectMorphologyImageFilter);

  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 typename Superclass::OutputImageRegionType;
 
  using ImageBoundaryConditionPointerType = ImageBoundaryCondition<InputImageType> *;
  using ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition<InputImageType> *;
  using DefaultBoundaryConditionType = ConstantBoundaryCondition<InputImageType>;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
  static constexpr unsigned int KernelDimension = TKernel::NeighborhoodDimension;

  using InputNeighborhoodIteratorType = ConstNeighborhoodIterator<TInputImage>;
  using OutputNeighborhoodIteratorType = NeighborhoodIterator<TOutputImage>;

  using KernelType = TKernel;

  using KernelIteratorType = typename KernelType::ConstIterator;

  using RadiusType = typename KernelType::SizeType;

  itkSetMacro(Kernel, KernelType);

  itkGetConstReferenceMacro(Kernel, KernelType);

  itkGetConstMacro(ObjectValue, PixelType);

  itkSetMacro(ObjectValue, PixelType);

  void
  GenerateInputRequestedRegion() override;

  void
  OverrideBoundaryCondition(const ImageBoundaryConditionPointerType i)
  {
    m_BoundaryCondition = i;
  }

  void
  ResetBoundaryCondition()
  {
    m_BoundaryCondition = &m_DefaultBoundaryCondition;
  }

  itkGetConstMacro(BoundaryCondition, ImageBoundaryConditionPointerType);

  itkSetMacro(UseBoundaryCondition, bool);

  itkGetConstMacro(UseBoundaryCondition, bool);
 
  itkConceptMacro(SameDimensionCheck1, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(SameDimensionCheck2, (Concept::SameDimension<ImageDimension, KernelDimension>));
  itkConceptMacro(OutputInputEqualityComparableCheck,
                  (Concept::EqualityComparable<typename TOutputImage::PixelType, PixelType>));
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<PixelType, typename TOutputImage::PixelType>));
  itkConceptMacro(IntConvertibleToOutputCheck, (Concept::Convertible<int, typename TOutputImage::PixelType>));
  itkConceptMacro(InputEqualityComparable, (Concept::EqualityComparable<PixelType>));
  itkConceptMacro(InputOStreamWritableCheck, (Concept::OStreamWritable<PixelType>));
 
protected:
  ObjectMorphologyImageFilter();
  ~ObjectMorphologyImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  DynamicThreadedGenerateData(const OutputImageRegionType &) override;

  virtual void
  Evaluate(OutputNeighborhoodIteratorType & nit, const KernelType & kernel) = 0;

  bool
  IsObjectPixelOnBoundary(const InputNeighborhoodIteratorType & iNIter);

  ImageBoundaryConditionPointerType m_BoundaryCondition{};

  DefaultBoundaryConditionType m_DefaultBoundaryCondition{};

  bool m_UseBoundaryCondition{};

  KernelType m_Kernel{};

  PixelType m_ObjectValue{};
 
  void
  BeforeThreadedGenerateData() override;
}; // end of class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkObjectMorphologyImageFilter.hxx"
#endif
 
#endif