itkKLMSegmentationRegion.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkKLMSegmentationRegion.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:04:58 $
  Version:   $Revision: 1.16 $

  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 __itkKLMSegmentationRegion_h
#define __itkKLMSegmentationRegion_h

#include "itkObject.h"
#include "itkKLMSegmentationBorder.h"
#include "itkSegmentationRegion.h"

#include "vnl/vnl_vector.h"

namespace itk
{

class KLMSegmentationBorder;

class ITKCommon_EXPORT KLMSegmentationRegion : public SegmentationRegion
{
public:
  typedef KLMSegmentationRegion     Self;
  typedef SegmentationRegion        Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(KLMSegmentationRegion,SegmentationRegion);

  typedef vnl_vector<double> MeanRegionIntensityType;

  typedef std::vector< KLMSegmentationBorder * > RegionBorderVectorType;
  typedef RegionBorderVectorType::size_type      RegionBorderVectorSizeType;

  typedef RegionBorderVectorType::iterator RegionBorderVectorIterator;

  typedef RegionBorderVectorType::const_iterator RegionBorderVectorConstIterator;

  typedef Superclass::RegionLabelType RegionLabelType;

  RegionBorderVectorIterator GetRegionBorderItBegin();
  RegionBorderVectorConstIterator GetRegionBorderConstItBegin();

  RegionBorderVectorIterator GetRegionBorderItEnd();
  RegionBorderVectorConstIterator GetRegionBorderConstItEnd();

  RegionBorderVectorSizeType GetRegionBorderSize() const;

  itkSetMacro(MeanRegionIntensity, MeanRegionIntensityType)
  itkGetConstReferenceMacro(MeanRegionIntensity, MeanRegionIntensityType);

  void SetRegionParameters(MeanRegionIntensityType meanRegionIntensity,
                           double                  regionArea,
                           RegionLabelType         label);

  void PrintRegionInfo();

  void PushFrontRegionBorder(KLMSegmentationBorder *pBorderCandidate);

  void PushBackRegionBorder(KLMSegmentationBorder *pBorderCandidate);

  void InsertRegionBorder(KLMSegmentationBorder *pBorderCandidate);

  void InsertRegionBorder(RegionBorderVectorIterator it,
                          KLMSegmentationBorder *pBorderCandidate);

  void DeleteRegionBorder(KLMSegmentationBorder *pBorderCandidate);

  void DeleteAllRegionBorders();

  void CombineRegionParameters(const Self *region);

  double EnergyFunctional(const Self *region);

  void ResetRegionLabelAndUpdateBorders(Self *region);

  void SpliceRegionBorders(Self *region);

  void UpdateRegionBorderLambda();

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

private:
  KLMSegmentationRegion(const Self&); // purposely not implemented
  void operator=(const Self&); // purposely not implemented

  RegionBorderVectorType    m_RegionBorderVector;
  MeanRegionIntensityType   m_MeanRegionIntensity;

}; // class SegmentationRegion


} // namespace itk


#endif