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 <itkSegmentationRegion.h>

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.

+ 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 ()
 
 itkOverrideGetNameOfClassMacro (SegmentationRegion)
 
virtual void SetRegionLabel (RegionLabelType _arg)
 
virtual const RegionLabelTypeGetRegionLabel () const
 
virtual void SetRegionArea (double _arg)
 
virtual const double & GetRegionArea () 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
 
 itkOverrideGetNameOfClassMacro (Object)
 
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
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
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
 
 SegmentationRegion ()
 
 ~SegmentationRegion () 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_RegionArea { 0 }
 
RegionLabelType m_RegionLabel { 0 }
 

Additional Inherited Members

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

Member Typedef Documentation

◆ ConstPointer

Definition at line 57 of file itkSegmentationRegion.h.

◆ Pointer

Definition at line 56 of file itkSegmentationRegion.h.

◆ RegionLabelType

Type definition for a segmentation region label.

Definition at line 66 of file itkSegmentationRegion.h.

◆ Self

Standard class type aliases.

Definition at line 54 of file itkSegmentationRegion.h.

◆ Superclass

Definition at line 55 of file itkSegmentationRegion.h.

Constructor & Destructor Documentation

◆ SegmentationRegion()

itk::SegmentationRegion::SegmentationRegion ( )
protected

◆ ~SegmentationRegion()

itk::SegmentationRegion::~SegmentationRegion ( )
overrideprotected

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.

◆ GetRegionArea()

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

Set/Get the area of the region.

◆ GetRegionLabel()

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

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

◆ itkOverrideGetNameOfClassMacro()

itk::SegmentationRegion::itkOverrideGetNameOfClassMacro ( SegmentationRegion  )

Run-time type information (and related methods).

◆ 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

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.

◆ 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

Definition at line 94 of file itkSegmentationRegion.h.

◆ m_RegionLabel

RegionLabelType itk::SegmentationRegion::m_RegionLabel { 0 }
private

Definition at line 93 of file itkSegmentationRegion.h.


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