#include <itkSegmentationRegion.h>

Inheritance diagram for itk::SegmentationRegion:

Collaboration diagram for itk::SegmentationRegion:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	RegionLabelType = unsigned int

using	Self = SegmentationRegion

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	ApplySegmentationRegion ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () 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

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 ()

RegionLabelType	m_RegionLabel { 0 }

double	m_RegionArea { 0 }

virtual void	SetRegionLabel (RegionLabelType _arg)

virtual const RegionLabelType &	GetRegionLabel () const

virtual void	SetRegionArea (double _arg)

virtual const double &	GetRegionArea () const

	SegmentationRegion ()

	~SegmentationRegion () override

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

Additional Inherited Members
Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

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

Detailed Description

Base class for SegmentationRegion object.

itkSegmentationRegion is the base class for the SegmentationRegion objects. It provides the basic function definitions that are inherent to a SegmentationRegion objects. A region object is defined by the label it owns. We use integer labels to represent a region. This object stores the region label. The user can get the area and a label associated with the region through access functions provided publicly. This class provides an interface method called ApplySegmentationRegion is defined as virtual to enable future extension of the region object. This object can be used where region in images needs to be defined. Child classes can be derived from this class for tailoring them towards specific algorithmic needs.

Definition at line 48 of file itkSegmentationRegion.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 57 of file itkSegmentationRegion.h.

◆ Pointer

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

Definition at line 56 of file itkSegmentationRegion.h.

◆ RegionLabelType

using itk::SegmentationRegion::RegionLabelType = unsigned int

Type definition for a segmentation region label.

Definition at line 66 of file itkSegmentationRegion.h.

◆ Self

using itk::SegmentationRegion::Self = SegmentationRegion

Standard class type aliases.

Definition at line 54 of file itkSegmentationRegion.h.

◆ Superclass

using itk::SegmentationRegion::Superclass = Object

Definition at line 55 of file itkSegmentationRegion.h.

Constructor & Destructor Documentation

◆ SegmentationRegion()

itk::SegmentationRegion::SegmentationRegion ( )

protected

Set/Get the region with parameter values defining the region.

◆ ~SegmentationRegion()

itk::SegmentationRegion::~SegmentationRegion ( )

overrideprotected

Set/Get the region with parameter values defining the region.

Member Function Documentation

◆ ApplySegmentationRegion()

virtual void itk::SegmentationRegion::ApplySegmentationRegion ( )

inlinevirtual

Define a virtual SegmentationRegion function that is meant to be used in derived classes if some operation needs to be performed on a region object.

Definition at line 72 of file itkSegmentationRegion.h.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::SegmentationRegion::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ GetNameOfClass()

virtual const char* itk::SegmentationRegion::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::KLMSegmentationRegion.

◆ GetRegionArea()

virtual const double& itk::SegmentationRegion::GetRegionArea ( ) const

virtual

Set/Get the region with parameter values defining the region.

◆ GetRegionLabel()

virtual const RegionLabelType& itk::SegmentationRegion::GetRegionLabel ( ) const

virtual

Set/Get the region with parameter values defining the region.

◆ New()

static Pointer itk::SegmentationRegion::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

overrideprotectedvirtual

Set/Get the region with parameter values defining the region.

Reimplemented from itk::Object.

◆ SetRegionArea()

virtual void itk::SegmentationRegion::SetRegionArea ( double _arg )

virtual

Set/Get the area of the region.

◆ SetRegionLabel()

virtual void itk::SegmentationRegion::SetRegionLabel ( RegionLabelType _arg )

virtual

Set/Get the region with parameter values defining the region.

Member Data Documentation

◆ m_RegionArea

double itk::SegmentationRegion::m_RegionArea { 0 }

private

Set/Get the region with parameter values defining the region.

Definition at line 94 of file itkSegmentationRegion.h.

◆ m_RegionLabel

RegionLabelType itk::SegmentationRegion::m_RegionLabel { 0 }

private

Set/Get the region with parameter values defining the region.

Definition at line 93 of file itkSegmentationRegion.h.

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

itkSegmentationRegion.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ RegionLabelType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ SegmentationRegion()

◆ ~SegmentationRegion()

Member Function Documentation

◆ ApplySegmentationRegion()

◆ CreateAnother()

◆ GetNameOfClass()

◆ GetRegionArea()

◆ GetRegionLabel()

◆ New()

◆ PrintSelf()

◆ SetRegionArea()

◆ SetRegionLabel()

Member Data Documentation

◆ m_RegionArea

◆ m_RegionLabel