itkKLMSegmentationBorder.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkKLMSegmentationBorder_h
#define itkKLMSegmentationBorder_h
 
#include "itkSegmentationBorder.h"
#include "itkKLMSegmentationRegion.h"
#include "itkMacro.h"
#include "ITKKLMRegionGrowingExport.h"
#include "itkMath.h"
#include "vnl/vnl_vector.h"
 
namespace itk
{
 
template <typename TBorder>
class KLMDynamicBorderArray
{
public:
  bool
  operator>(const KLMDynamicBorderArray<TBorder> & rhs) const
  {
    if (Math::ExactlyEquals(m_Pointer->GetLambda(), rhs.m_Pointer->GetLambda()))
    {
      if (m_Pointer->GetLambda() < 0)
      {
        return (m_Pointer > rhs.m_Pointer);
      }
 
      // The purpose of this comparison is to not let any one region
      // get more borders than another region.  In the degenerate
      // case of an image where the Lambdas are always equal to some
      // constant C, allowing a single region to be repeatedly
      // merged so that it gains many borders will result in
      // pathologically slow behavior.
      const double v1 = std::max(static_cast<double>(m_Pointer->GetRegion1()->GetRegionBorderSize()),
                                 static_cast<double>(m_Pointer->GetRegion2()->GetRegionBorderSize()));
 
      const double v2 = std::max(static_cast<double>(rhs.m_Pointer->GetRegion1()->GetRegionBorderSize()),
                                 static_cast<double>(rhs.m_Pointer->GetRegion2()->GetRegionBorderSize()));
 
      return (v1 > v2);
    }
    return (m_Pointer->GetLambda() > rhs.m_Pointer->GetLambda());
  }
 
  bool
  operator>(const KLMDynamicBorderArray<TBorder> * rhs) const
  {
    if (m_Pointer->GetLambda() == rhs->m_Pointer->GetLambda())
    {
      if (m_Pointer->GetLambda() < 0)
      {
        return (m_Pointer > rhs->m_Pointer);
      }
 
      // The purpose of this comparison is to not let any one region
      // get more borders than another region.  In the degenerate
      // case of an image where the Lambdas are always equal to some
      // constant C, allowing a single region to be repeatedly
      // merged so that it gains many borders will result in
      // pathologically slow behavior.
      double v1 = std::max(static_cast<double>(m_Pointer->GetRegion1()->GetRegionBorderSize()),
                           static_cast<double>(m_Pointer->GetRegion2()->GetRegionBorderSize()));
 
      double v2 = std::max(static_cast<double>(rhs->m_Pointer->GetRegion1()->GetRegionBorderSize()),
                           static_cast<double>(rhs->m_Pointer->GetRegion2()->GetRegionBorderSize()));
 
      return (v1 > v2);
    }
    return (m_Pointer->GetLambda() > rhs->m_Pointer->GetLambda());
  }
 
  TBorder * m_Pointer;
};

 
// Forward reference because of circular dependencies
class ITK_FORWARD_EXPORT KLMSegmentationRegion;
 
class ITKKLMRegionGrowing_EXPORT KLMSegmentationBorder : public SegmentationBorder
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(KLMSegmentationBorder);

  using Self = KLMSegmentationBorder;
  using Superclass = SegmentationBorder;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(KLMSegmentationBorder);

  void
  SetRegion1(KLMSegmentationRegion * Region1);

  KLMSegmentationRegion *
  GetRegion1();

  void
  SetRegion2(KLMSegmentationRegion * Region2);

  KLMSegmentationRegion *
  GetRegion2();

  itkSetMacro(Lambda, double);
  itkGetConstReferenceMacro(Lambda, double);

  void
  EvaluateLambda();

  void
  PrintBorderInfo();
 
protected:
  KLMSegmentationBorder();

  ~KLMSegmentationBorder() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  double                  m_Lambda{};
  KLMSegmentationRegion * m_Region1{};
  KLMSegmentationRegion * m_Region2{};
};
} // end namespace itk
 
#endif