ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::SegmentationRegion Class Reference

#include <itkSegmentationRegion.h>

+ Inheritance diagram for itk::SegmentationRegion:
+ Collaboration diagram for itk::SegmentationRegion:

Detailed Description

Base class for SegmentationRegion object.

itkSegmentationRegion is the base class for the SegmentationRegion objects. It provides the basic function definitons 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 47 of file itkSegmentationRegion.h.

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
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
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)
void SetDebug (bool debugFlag) const
void SetReferenceCount (int) override
void UnRegister () const noexceptoverride
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
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
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 flag)
- 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 &time)
 ~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

Definition at line 56 of file itkSegmentationRegion.h.

Definition at line 55 of file itkSegmentationRegion.h.

Type definition for a segmentation region label.

Definition at line 65 of file itkSegmentationRegion.h.

Standard class type aliases.

Definition at line 53 of file itkSegmentationRegion.h.

Definition at line 54 of file itkSegmentationRegion.h.

Constructor & Destructor Documentation

itk::SegmentationRegion::SegmentationRegion ( )
itk::SegmentationRegion::~SegmentationRegion ( )

Member Function Documentation

virtual void itk::SegmentationRegion::ApplySegmentationRegion ( )

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 70 of file itkSegmentationRegion.h.

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

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.

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::KLMSegmentationRegion.

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

Set/Get the area of the region.

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

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

static Pointer itk::SegmentationRegion::New ( )

Method for creation through the object factory.

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

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.

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

Set/Get the area of the region.

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

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

Member Data Documentation

double itk::SegmentationRegion::m_RegionArea {0}

Definition at line 90 of file itkSegmentationRegion.h.

RegionLabelType itk::SegmentationRegion::m_RegionLabel {0}

Definition at line 89 of file itkSegmentationRegion.h.

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