itkBinaryMorphologyImageFilter.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 itkBinaryMorphologyImageFilter_h
#define itkBinaryMorphologyImageFilter_h
 
#include <vector>
#include <queue>
#include "itkKernelImageFilter.h"
#include "itkNeighborhoodIterator.h"
#include "itkImageBoundaryCondition.h"
#include "itkImageRegionIterator.h"
#include "itkConceptChecking.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage, typename TKernel>
class ITK_TEMPLATE_EXPORT BinaryMorphologyImageFilter : public KernelImageFilter<TInputImage, TOutputImage, TKernel>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(BinaryMorphologyImageFilter);

  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;

  static constexpr unsigned int KernelDimension = TKernel::NeighborhoodDimension;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  using Self = BinaryMorphologyImageFilter;
  using Superclass = KernelImageFilter<InputImageType, OutputImageType, TKernel>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BinaryMorphologyImageFilter);

  using KernelType = TKernel;

  using KernelIteratorType = typename KernelType::ConstIterator;

  using InputPixelType = typename InputImageType::PixelType;
  using OutputPixelType = typename OutputImageType::PixelType;
  using InputRealType = typename NumericTraits<InputPixelType>::RealType;
  using OffsetType = typename InputImageType::OffsetType;
  using IndexType = typename InputImageType::IndexType;
  using IndexValueType = typename InputImageType::IndexValueType;
 
  using InputImageRegionType = typename InputImageType::RegionType;
  using OutputImageRegionType = typename OutputImageType::RegionType;
  using InputSizeType = typename InputImageType::SizeType;
  using InputSizeValueType = typename InputImageType::SizeValueType;

  itkConceptMacro(ImageDimensionCheck, (Concept::SameDimension<Self::InputImageDimension, Self::OutputImageDimension>));

  itkSetMacro(ForegroundValue, InputPixelType);

  itkGetConstMacro(ForegroundValue, InputPixelType);

  itkSetMacro(BackgroundValue, OutputPixelType);

  itkGetConstMacro(BackgroundValue, OutputPixelType);

  itkSetMacro(BoundaryToForeground, bool);
  itkGetConstReferenceMacro(BoundaryToForeground, bool);
  itkBooleanMacro(BoundaryToForeground);

  void
  SetKernel(const KernelType & kernel) override;
 
protected:
  BinaryMorphologyImageFilter();
  ~BinaryMorphologyImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  AnalyzeKernel();

  using NeighborIndexContainer = std::vector<OffsetType>;

  using NeighborIndexContainerContainer = std::vector<NeighborIndexContainer>;

  using ComponentVectorType = std::vector<OffsetType>;

  using ComponentVectorConstIterator = typename ComponentVectorType::const_iterator;

  NeighborIndexContainer &
  GetDifferenceSet(unsigned int code)
  {
    return m_KernelDifferenceSets[code];
  }

  ComponentVectorConstIterator
  KernelCCVectorBegin()
  {
    return m_KernelCCVector.begin();
  }

  ComponentVectorConstIterator
  KernelCCVectorEnd()
  {
    return m_KernelCCVector.end();
  }
 
  bool m_BoundaryToForeground{};
 
private:
  InputPixelType m_ForegroundValue{};

  OutputPixelType m_BackgroundValue{};

  NeighborIndexContainerContainer m_KernelDifferenceSets{};

  std::vector<OffsetType> m_KernelCCVector{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkBinaryMorphologyImageFilter.hxx"
#endif
 
#endif