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 "ITKKLMRegionGrowingExport.h"

#include "vnl/vnl_vector.h"

namespace itk
{
// Forward reference because of circular dependencies
class ITK_FORWARD_EXPORT KLMSegmentationBorder;

class ITKKLMRegionGrowing_EXPORT KLMSegmentationRegion:public SegmentationRegion
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(KLMSegmentationRegion);

  using Self = KLMSegmentationRegion;
  using Superclass = SegmentationRegion;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(KLMSegmentationRegion, SegmentationRegion);

  using MeanRegionIntensityType = vnl_vector< double >;

  using RegionBorderVectorType = std::vector< KLMSegmentationBorder * >;
  using RegionBorderVectorSizeType = RegionBorderVectorType::size_type;

  using RegionBorderVectorIterator = RegionBorderVectorType::iterator;

  using RegionBorderVectorConstIterator = RegionBorderVectorType::const_iterator;

  using RegionLabelType = Superclass::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() override;
  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  RegionBorderVectorType  m_RegionBorderVector;
  MeanRegionIntensityType m_MeanRegionIntensity;
}; // class SegmentationRegion
} // namespace itk

#endif