itkVoronoiSegmentationImageFilterBase.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 itkVoronoiSegmentationImageFilterBase_h
#define itkVoronoiSegmentationImageFilterBase_h
 
#include "itkImageToImageFilter.h"
#include "itkVoronoiDiagram2DGenerator.h"
#include "itkImage.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage, typename TBinaryPriorImage = Image<unsigned char, 2>>
class ITK_TEMPLATE_EXPORT VoronoiSegmentationImageFilterBase : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VoronoiSegmentationImageFilterBase);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VoronoiSegmentationImageFilterBase);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using InputImageType = TInputImage;
  using InputImagePointer = typename TInputImage::Pointer;
  using InputImageConstPointer = typename TInputImage::ConstPointer;
  using IndexType = typename TInputImage::IndexType;
  using SizeType = typename TInputImage::SizeType;
  using RegionType = typename TInputImage::RegionType;
  using PixelType = typename TInputImage::PixelType;
 
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename TOutputImage::PixelType;
 
  using VoronoiDiagram = VoronoiDiagram2D<double>;
  using VoronoiDiagramGenerator = VoronoiDiagram2DGenerator<double>;
  using PointType = typename VoronoiDiagram::PointType;
  using CellType = typename VoronoiDiagram::CellType;
  using CellAutoPointer = typename VoronoiDiagram::CellAutoPointer;
  using VoronoiPointer = typename VoronoiDiagram::Pointer;
  using PointIdIterator = typename CellType::PointIdIterator;
  using SeedsType = typename VoronoiDiagram::SeedsType;
  using SeedsIterator = typename VoronoiDiagram::SeedsIterator;
  using NeighborIdIterator = typename VoronoiDiagram::NeighborIdIterator;
  using EdgeIterator = typename VoronoiDiagram::VoronoiEdgeIterator;
  using EdgeInfo = typename VoronoiDiagram::VoronoiEdge;
  using PointTypeVector = std::vector<PointType>;
  using PointTypeDeque = std::deque<PointType>;
  using BinaryObjectImage = TBinaryPriorImage;
  using BinaryObjectImagePointer = typename BinaryObjectImage::Pointer;
  using IndexList = std::vector<IndexType>;

  using VDImage = Image<unsigned char, 2>;
  using VDImagePointer = typename VDImage::Pointer;

  itkSetMacro(NumberOfSeeds, int);
  itkGetConstMacro(NumberOfSeeds, int);

  itkSetMacro(MinRegion, SizeValueType);
  itkGetConstMacro(MinRegion, SizeValueType);

  itkSetMacro(Steps, int);
  itkGetConstMacro(Steps, int);

  itkGetConstMacro(LastStepSeeds, int);

  itkGetConstMacro(NumberOfSeedsToAdded, int);

  itkSetMacro(UseBackgroundInAPrior, bool);
  itkGetConstMacro(UseBackgroundInAPrior, bool);

  itkSetMacro(OutputBoundary, bool);
  itkGetConstMacro(OutputBoundary, bool);

  itkSetMacro(InteractiveSegmentation, bool);
  itkGetConstMacro(InteractiveSegmentation, bool);
  itkBooleanMacro(InteractiveSegmentation);

  itkSetMacro(MeanDeviation, double);
  itkGetConstMacro(MeanDeviation, double);

  itkSetMacro(Size, SizeType);
  itkGetConstMacro(Size, SizeType);

  virtual void
  TakeAPrior(const BinaryObjectImage *)
  {}

  void
  RunSegment();

  void
  RunSegmentOneStep();

  virtual void
  MakeSegmentBoundary();
 
  virtual void
  MakeSegmentObject();

  VoronoiPointer
  GetVoronoiDiagram()
  {
    return m_WorkingVD;
  }
 
#if !defined(ITK_WRAPPING_PARSER) // generates invalid iterator instantiation
                                  // with msvc
  void
  SetSeeds(int num, SeedsIterator begin)
  {
    m_NumberOfSeeds = num;
    m_WorkingVD->SetSeeds(num, begin);
  }
#endif

  void
  SetSeeds(SeedsType & seeds)
  {
    m_NumberOfSeeds = seeds.size();
    auto it = seeds.begin();
    m_WorkingVD->SetSeeds(m_NumberOfSeeds, it);
  }

  PointType
  GetSeed(int SeedID)
  {
    return m_WorkingVD->GetSeed(SeedID);
  }

  void
  DrawDiagram(VDImagePointer result, unsigned char incolor, unsigned char outcolor, unsigned char boundcolor);
 
  void
  BeforeNextStep();

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
protected:
  VoronoiSegmentationImageFilterBase();
  ~VoronoiSegmentationImageFilterBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override; // general pipeline function.
 
  SizeType      m_Size{};
  int           m_NumberOfSeeds{ 200 };
  SizeValueType m_MinRegion{ 20 };
  int           m_Steps{ 0 };
  int           m_LastStepSeeds{ 0 };
  int           m_NumberOfSeedsToAdded{ 0 };
  int           m_NumberOfBoundary{ 0 };
 
  std::vector<SizeValueType> m_NumberOfPixels{};
  std::vector<unsigned char> m_Label{};
 
  double m_MeanDeviation{ 0.8 };
  bool   m_UseBackgroundInAPrior{ false };
  bool   m_OutputBoundary{ false }; // if =1 then output the boundaries, if = 0 then
                                    // output the object.
  bool m_InteractiveSegmentation{ false };
 
  typename VoronoiDiagram::Pointer m_WorkingVD{};
 
  typename VoronoiDiagramGenerator::Pointer m_VDGenerator{};
 
  std::vector<PointType> m_SeedsToAdded{};
 
  // private methods:
  // Classify all the voronoi cells as interior , exterior or boundary.
  virtual void
  ClassifyDiagram();
 
  // Generate the seeds to be added by dividing the boundary cells.
  virtual void
  GenerateAddingSeeds();
 
  // Compute the statistics of the pixels inside the cell.
  void
  GetPixelIndexFromPolygon(PointTypeDeque vertlist, IndexList * PixelPool);
 
  virtual bool
  TestHomogeneity(IndexList &)
  {
    return true;
  }
 
  void
  FillPolygon(PointTypeDeque vertlist, OutputPixelType color = 1);
 
  // Draw a straight line to the output image.
  void
  drawLine(PointType p1, PointType p2);
 
  // Draw the intermediate Voronoi Diagram structure.
  void
  drawVDline(VDImagePointer result, PointType p1, PointType p2, unsigned char color);
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVoronoiSegmentationImageFilterBase.hxx"
#endif
 
#endif