itkKLMSegmentationRegion.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 __itkKLMSegmentationRegion_h
#define __itkKLMSegmentationRegion_h

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

#include "vnl/vnl_vector.h"

namespace itk
{
class KLMSegmentationBorder;

class 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();
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

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