ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members

#include <itkKLMSegmentationBorder.h>

Detailed Description

Base class for KLMSegmentationBorder object.

itkKLMSegmentationBorder is the base class for the KLMSegmentationBorder objects. It provides the basic function definitions that are inherent to a KLMSegmentationBorder objects.

This class implements the border object that is used in particular with the KLM algorithm (see also KLMRegionGrowImageFilter). The border is defined by the adjacency of two regions. The parameter Lambda ascertains the importance of the border in defining the regions. The higher the values of Lambda the more dominant is its presence in the a region. In case of removal of a border during the region growing process the one with least Lambda value is eliminated.

Definition at line 138 of file itkKLMSegmentationBorder.h.

+ Inheritance diagram for itk::KLMSegmentationBorder:
+ Collaboration diagram for itk::KLMSegmentationBorder:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = KLMSegmentationBorder
 
using Superclass = SegmentationBorder
 
- Public Types inherited from itk::SegmentationBorder
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = SegmentationBorder
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void EvaluateLambda ()
 
const char * GetNameOfClass () const override
 
KLMSegmentationRegionGetRegion1 ()
 
KLMSegmentationRegionGetRegion2 ()
 
void PrintBorderInfo ()
 
void SetRegion1 (KLMSegmentationRegion *Region1)
 
void SetRegion2 (KLMSegmentationRegion *Region2)
 
virtual void SetLambda (double _arg)
 
virtual const double & GetLambda () const
 
- Public Member Functions inherited from itk::SegmentationBorder
virtual void ApplySegmentationBorder ()
 
const char * GetNameOfClass () const override
 
virtual void SetBorderLength (double _arg)
 
virtual const double & GetBorderLength () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::SegmentationBorder
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 KLMSegmentationBorder ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~KLMSegmentationBorder () override
 
- Protected Member Functions inherited from itk::SegmentationBorder
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SegmentationBorder ()
 
 ~SegmentationBorder () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

double m_Lambda {}
 
KLMSegmentationRegionm_Region1 {}
 
KLMSegmentationRegionm_Region2 {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

Definition at line 147 of file itkKLMSegmentationBorder.h.

◆ Pointer

Definition at line 146 of file itkKLMSegmentationBorder.h.

◆ Self

Standard class type aliases.

Definition at line 144 of file itkKLMSegmentationBorder.h.

◆ Superclass

Definition at line 145 of file itkKLMSegmentationBorder.h.

Constructor & Destructor Documentation

◆ KLMSegmentationBorder()

itk::KLMSegmentationBorder::KLMSegmentationBorder ( )
protected

Constructor.

◆ ~KLMSegmentationBorder()

itk::KLMSegmentationBorder::~KLMSegmentationBorder ( )
overrideprotected

Destructor.

Member Function Documentation

◆ EvaluateLambda()

void itk::KLMSegmentationBorder::EvaluateLambda ( )

Evaluate the Lambda for a given border.

◆ GetLambda()

virtual const double& itk::KLMSegmentationBorder::GetLambda ( ) const
virtual

Set/Get the Lambda parameter associate with the borders in the KLM algorithm

◆ GetNameOfClass()

const char* itk::KLMSegmentationBorder::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetRegion1()

KLMSegmentationRegion* itk::KLMSegmentationBorder::GetRegion1 ( )

Get the region 1 associated with the border.

◆ GetRegion2()

KLMSegmentationRegion* itk::KLMSegmentationBorder::GetRegion2 ( )

Get the region 2 associated with the border.

◆ New()

static Pointer itk::KLMSegmentationBorder::New ( )
static

Method for creation through the object factory.

◆ PrintBorderInfo()

void itk::KLMSegmentationBorder::PrintBorderInfo ( )

Print the data associated with each border.

◆ PrintSelf()

void itk::KLMSegmentationBorder::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Print self identity

Reimplemented from itk::Object.

◆ SetLambda()

virtual void itk::KLMSegmentationBorder::SetLambda ( double  _arg)
virtual

Set/Get the Lambda parameter associate with the borders in the KLM algorithm

◆ SetRegion1()

void itk::KLMSegmentationBorder::SetRegion1 ( KLMSegmentationRegion Region1)

Set the region 1 associated with the border

◆ SetRegion2()

void itk::KLMSegmentationBorder::SetRegion2 ( KLMSegmentationRegion Region2)

Set the region 2 associated with the border.

Member Data Documentation

◆ m_Lambda

double itk::KLMSegmentationBorder::m_Lambda {}
private

Definition at line 197 of file itkKLMSegmentationBorder.h.

◆ m_Region1

KLMSegmentationRegion* itk::KLMSegmentationBorder::m_Region1 {}
private

Definition at line 198 of file itkKLMSegmentationBorder.h.

◆ m_Region2

KLMSegmentationRegion* itk::KLMSegmentationBorder::m_Region2 {}
private

Definition at line 199 of file itkKLMSegmentationBorder.h.


The documentation for this class was generated from the following file: