#include <itkSegmentationBorder.h>

Detailed Description

Base class for SegmentationBorder object.

itkSegmentationBorder is the base class for the SegmentationBorder objects. It provides the basic function definitions that are inherent to a SegmentationBorder objects. This object stores information relevant to the borders that are used in the region growing class. This class allows access to the parameter that defines the length of the border associated with this object. In order to use this object in an application, the object must be created within the application and then used to initialize/store/use the various parameters accessible through the public methods. For usage also see itkRegionGrowImageFiltering class. This object can be used where a border of a region needs to be defined. Child classes can be derived from this class for tailoring them towards specific algorithmic needs.

Definition at line 47 of file itkSegmentationBorder.h.

Inheritance diagram for itk::SegmentationBorder:

Collaboration diagram for itk::SegmentationBorder:

Public Types
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
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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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)

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::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
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_BorderLength { 0 }

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

using itk::SegmentationBorder::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkSegmentationBorder.h.

◆ Pointer

using itk::SegmentationBorder::Pointer = SmartPointer<Self>

Definition at line 55 of file itkSegmentationBorder.h.

◆ Self

using itk::SegmentationBorder::Self = SegmentationBorder

Standard class type aliases.

Definition at line 53 of file itkSegmentationBorder.h.

◆ Superclass

using itk::SegmentationBorder::Superclass = Object

Definition at line 54 of file itkSegmentationBorder.h.

Constructor & Destructor Documentation

◆ SegmentationBorder()

itk::SegmentationBorder::SegmentationBorder ( )

protected

◆ ~SegmentationBorder()

itk::SegmentationBorder::~SegmentationBorder ( )

overrideprotected

Member Function Documentation

◆ ApplySegmentationBorder()

virtual void itk::SegmentationBorder::ApplySegmentationBorder ( )

inlinevirtual

Define a virtual SegmentationBorder function. This function allows access to specific instantiations of other border representations. This is the function should be overloaded in any derived classes for the user to access the various methods supported by the method.

Definition at line 74 of file itkSegmentationBorder.h.

◆ GetBorderLength()

virtual const double& itk::SegmentationBorder::GetBorderLength ( ) const

virtual

Set/Get the length of a border object.

◆ GetNameOfClass()

const char* itk::SegmentationBorder::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ New()

static Pointer itk::SegmentationBorder::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

◆ SetBorderLength()

virtual void itk::SegmentationBorder::SetBorderLength ( double _arg )

virtual

Set/Get the length of a border object.

Member Data Documentation

◆ m_BorderLength

double itk::SegmentationBorder::m_BorderLength { 0 }

private

Definition at line 84 of file itkSegmentationBorder.h.

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

itkSegmentationBorder.h