itkVoronoiSegmentationImageFilterBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkVoronoiSegmentationImageFilterBase.h,v $
  Language:  C++
  Date:      $Date: 2009-06-16 14:57:53 $
  Version:   $Revision: 1.31 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkVoronoiSegmentationImageFilterBase_h
#define __itkVoronoiSegmentationImageFilterBase_h

#include "itkImageToImageFilter.h"
#include "itkVoronoiDiagram2D.h"
#include "itkVoronoiDiagram2DGenerator.h"
#include "itkImage.h"

namespace itk
{

template <class TInputImage, class TOutputImage,class TBinaryPriorImage=Image<unsigned char,2> >
class ITK_EXPORT VoronoiSegmentationImageFilterBase:
    public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
  typedef VoronoiSegmentationImageFilterBase             Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>   Superclass;
  typedef SmartPointer <Self>                            Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(VoronoiSegmentationImageFilterBase,ImageToImageFilter);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef TInputImage                        InputImageType;
  typedef typename TInputImage::Pointer      InputImagePointer;
  typedef typename TInputImage::ConstPointer InputImageConstPointer;
  typedef typename TInputImage::IndexType    IndexType;
  typedef typename TInputImage::SizeType     SizeType;
  typedef typename TInputImage::RegionType   RegionType;
  typedef typename TInputImage::PixelType    PixelType;

  typedef TOutputImage                       OutputImageType;
  typedef typename TOutputImage::PixelType   OutputPixelType;

  typedef VoronoiDiagram2D<double>                     VoronoiDiagram;
  typedef VoronoiDiagram2DGenerator<double>            VoronoiDiagramGenerator;
  typedef typename VoronoiDiagram::PointType           PointType;
  typedef typename VoronoiDiagram::CellType            CellType;
  typedef typename VoronoiDiagram::CellAutoPointer     CellAutoPointer;
  typedef typename VoronoiDiagram::Pointer             VoronoiPointer;
  typedef typename CellType::PointIdIterator           PointIdIterator;
  typedef typename VoronoiDiagram::SeedsType           SeedsType;
  typedef typename VoronoiDiagram::SeedsIterator       SeedsIterator;
  typedef typename VoronoiDiagram::NeighborIdIterator  NeighborIdIterator;
  typedef typename VoronoiDiagram::VoronoiEdgeIterator EdgeIterator;
  typedef typename VoronoiDiagram::VoronoiEdge         EdgeInfo;
  typedef std::vector<PointType>                       PointTypeVector;
  typedef std::deque<PointType>                        PointTypeDeque;
  typedef TBinaryPriorImage                            BinaryObjectImage;
  typedef typename BinaryObjectImage::Pointer          BinaryObjectImagePointer;
  typedef std::vector<IndexType>                       IndexList;

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

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

  itkSetMacro(MinRegion, int);
  itkGetConstMacro(MinRegion, int);

  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);

  void RunSegmentOneStep(void);

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

  VoronoiPointer GetVoronoiDiagram(void)
    { return m_WorkingVD; }

#if !defined(CABLE_CONFIGURATION)  // 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();
    typename SeedsType::iterator 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); 

  virtual void GenerateInputRequestedRegion();

  virtual void EnlargeOutputRequestedRegion(DataObject *output);  

protected:
  VoronoiSegmentationImageFilterBase();
  ~VoronoiSegmentationImageFilterBase();
  virtual void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateData(void); //general pipeline function.

  SizeType m_Size;
  int      m_NumberOfSeeds;
  int      m_MinRegion;
  int      m_Steps;
  int      m_LastStepSeeds;
  int      m_NumberOfSeedsToAdded;
  int      m_NumberOfBoundary;

  std::vector<int>           m_NumberOfPixels;
  std::vector<unsigned char> m_Label;

  double m_MeanDeviation;
  bool   m_UseBackgroundInAPrior;
  bool   m_OutputBoundary; //if =1 then output the boundaries, if = 0 then output the object.
  bool   m_InteractiveSegmentation;
  
  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(void);
  
  // Generate the seeds to be added by dividing the boundary cells.
  virtual void GenerateAddingSeeds(void);
  
  // Compute the statistics of the pixels inside the cell.
  void GetPixelIndexFromPolygon(PointTypeDeque VertList, IndexList *PixelPool);
  virtual bool TestHomogeneity(IndexList&)
    {return 1;}
  
  void FillPolygon(PointTypeDeque vertlist, OutputPixelType color=1);
  
  // Draw a straight line to the output image.
  void drawLine(PointType p1,PointType p2);
  
  // Draw the intermedia Voronoi Diagram structure. 
  void drawVDline(VDImagePointer result,PointType p1,PointType p2, unsigned char color);
  
private:
  VoronoiSegmentationImageFilterBase(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
};

}//end namespace


#ifndef ITK_MANUAL_INSTANTIATION
#include "itkVoronoiSegmentationImageFilterBase.txx"
#endif

#endif