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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkVoronoiSegmentationImageFilterBase.h,v $
  Language:  C++
  Date:      $Date: 2006-01-19 12:19:20 $
  Version:   $Revision: 1.28 $

  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
{

/** \class VoronoiSegmentationImageFilterBase
 * /brief Base class for VoronoiSegmentationImageFilter
 * 
 * Voronoi SegmentationImageFilter is a class of segmenation algorithms that 
 * works on 2D image. 
 * Begin with certain number of seeds, VoronoiSegmentationImageFilter 
 * first partition the image plane to voronoi regions, and testing each 
 * region by some homogeneity operators, which need to be implemented in the private 
 * method:  
 *      virtual bool TestHomogeneity(IndexList &Plist); 
 * after testing, all the regions are classified as either "internal" or "external" 
 * region and the "boundary" regions was defined as an "external" region that has at  
 * least one "internal" region as its neighbor. 
 * the algorithm then added seed points to the "boundary" regions (on the edges) and 
 * recursively "split" the boundary region until all the "boundary" become sufficiently 
 * small. 
 * the output of the segmentation can be either a binary object, which is the collection 
 * of all the "internal" region. Or a binary boundary delineate, which is defined as 
 * the connected lines between seed points of "boundary" region. 
 * This class is a base class for voronoi segmenation, single channel or multiple channel 
 * image segmenation can be implemented by deriving imagefilters from this class, by  
 * implementing the virtual methods 
 *
 * Detailed information about this algorithm can be found in:
 *  " Semi-automated color segmentation of anatomical tissue,"
 *   C. Imelinska, M. Downes, and W. Yuan  
 *  Computerized Medical Imaging and Graphics, Vor.24, pp 173-180, 2000.
 *
 * \ingroup HybridSegmentation 
 */
template <class TInputImage, class TOutputImage,class TBinaryPriorImage=Image<unsigned char,2> >
class ITK_EXPORT VoronoiSegmentationImageFilterBase:
    public ImageToImageFilter<TInputImage,TOutputImage>
{
public:
  /** Standard class typedefs. */
  typedef VoronoiSegmentationImageFilterBase       Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>   Superclass;
  typedef SmartPointer <Self>  Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkTypeMacro(VoronoiSegmentationImageFilterBase,ImageToImageFilter);

  /** Get the image dimension from the template parameter. */
  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);
  
  /** Convenient typedefs. */
  typedef TInputImage InputImageType;
  typedef typename TInputImage::Pointer InputImagePointer;
  typedef typename TInputImage::ConstPointer InputImageConstPointer;
  typedef TOutputImage OutputImageType;
  typedef typename TInputImage::IndexType IndexType;
  typedef typename TInputImage::SizeType SizeType;
  typedef typename TInputImage::RegionType RegionType;
  typedef typename TInputImage::PixelType PixelType;
  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;

  /** To output the drawing of Voronoi Diagram (VD) . */ 
  typedef Image<unsigned char,2>  VDImage; 
  typedef typename VDImage::Pointer  VDImagePointer; 
    
  /** Set/Get the initial number of seeds for VD. */
  itkSetMacro(NumberOfSeeds, int);
  itkGetMacro(NumberOfSeeds, int);

  /** Set/Get the smallest region to be divided. */
  itkSetMacro(MinRegion, int);
  itkGetMacro(MinRegion, int);

  /** Set/Get the number of iterations to run (if set to 0: the classification
  * run process runs until no more cells can be divided). */
  itkSetMacro(Steps, int);
  itkGetMacro(Steps, int);

  /** Get the number of seeds before adding new ones. */
  itkGetMacro(LastStepSeeds, int);

  /** Get the number of seeds to add. */
  itkGetMacro(NumberOfSeedsToAdded, int); 

  /**  */
  itkSetMacro(UseBackgroundInAPrior, bool);
  itkGetMacro(UseBackgroundInAPrior, bool);

  /** Enable the generation of the output boundary. */
  itkSetMacro(OutputBoundary, bool);
  itkGetMacro(OutputBoundary, bool);

  /** Output the segmentation on every iteration.  Useful for iteractive
      sessions. The setting of OutputBoundary determines the type of output. */
  itkSetMacro(InteractiveSegmentation, bool);
  itkGetMacro(InteractiveSegmentation, bool);
  itkBooleanMacro(InteractiveSegmentation);
  
  /** Set/Get the mean deviation. */
  itkSetMacro(MeanDeviation, double);
  itkGetMacro(MeanDeviation, double);

  /** Set/Get the region size. */
  itkSetMacro(Size,SizeType);
  itkGetMacro(Size,SizeType);

  /** Take a prior from other segmentation node. This should be a
   * binary object. */
  virtual void TakeAPrior(const BinaryObjectImage*){};
  
  /** Perform the segmentation. */
  void RunSegment(void);

  /** Perform the segmentation. */
  void RunSegmentOneStep(void);

  /** Create the output binary result for boundaries.  */
  virtual void MakeSegmentBoundary(void);
  virtual void MakeSegmentObject(void);

  /** Return the Voroni Diagram structure. */
  VoronoiPointer GetVoronoiDiagram(void)
  { return m_WorkingVD; }
    
  /** Seeds positions are randomly set. 
   * If you need to set seeds position then use the SetSeeds method
   * after the InitializeSegment method .  */ 
  void SetSeeds(int num, SeedsIterator begin)
  { 
    m_NumberOfSeeds = num; 
    m_WorkingVD->SetSeeds(num,begin); 
  }; 
    
  /** Get the point specified by the ID given. */
  PointType GetSeed(int SeedID)
  { return m_WorkingVD->GetSeed(SeedID); } 
      
  /** Draw the Voronoi Diagram structure. */
  void DrawDiagram(VDImagePointer result,unsigned char incolor, 
                   unsigned char outcolor,unsigned char boundcolor); 

  void BeforeNextStep(void); 

  /** This filter does not stream and needs the entire image as input.
   * \sa ProcessObject::GenerateInputRequestedRegion(). */
  virtual void GenerateInputRequestedRegion();
  
  /** This filter does not stream and needs to produce the entire output.
   * \sa ProcessObject::EnlargeOutputRequestedRegion() */
  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