#include <itkObject.h>

Detailed Description

Base class for most ITK classes.

Object is the second-highest level base class for most itk objects. It extends the base object functionality of LightObject by implementing callbacks (via object/observer), debug flags/methods, and modification time tracking. Most ITK classes should be a subclass of Object due to the need to keep track of modified time.

ITK Sphinx Examples:

All ITK Sphinx Examples

Copy Another

Examples: Examples/RegistrationITKv4/BSplineWarping1.cxx, Examples/RegistrationITKv4/BSplineWarping2.cxx, Examples/RegistrationITKv4/DeformableRegistration10.cxx, Examples/RegistrationITKv4/DeformableRegistration12.cxx, Examples/RegistrationITKv4/DeformableRegistration13.cxx, Examples/RegistrationITKv4/DeformableRegistration14.cxx, Examples/RegistrationITKv4/DeformableRegistration15.cxx, Examples/RegistrationITKv4/DeformableRegistration16.cxx, Examples/RegistrationITKv4/DeformableRegistration17.cxx, Examples/RegistrationITKv4/DeformableRegistration2.cxx, Examples/RegistrationITKv4/DeformableRegistration3.cxx, Examples/RegistrationITKv4/DeformableRegistration5.cxx, Examples/RegistrationITKv4/DeformableRegistration6.cxx, Examples/RegistrationITKv4/DeformableRegistration7.cxx, Examples/RegistrationITKv4/DeformableRegistration8.cxx, Examples/RegistrationITKv4/DeformableRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistration1.cxx, Examples/RegistrationITKv4/ImageRegistration10.cxx, Examples/RegistrationITKv4/ImageRegistration11.cxx, Examples/RegistrationITKv4/ImageRegistration12.cxx, Examples/RegistrationITKv4/ImageRegistration13.cxx, Examples/RegistrationITKv4/ImageRegistration14.cxx, Examples/RegistrationITKv4/ImageRegistration15.cxx, Examples/RegistrationITKv4/ImageRegistration16.cxx, Examples/RegistrationITKv4/ImageRegistration17.cxx, Examples/RegistrationITKv4/ImageRegistration18.cxx, Examples/RegistrationITKv4/ImageRegistration19.cxx, Examples/RegistrationITKv4/ImageRegistration2.cxx, Examples/RegistrationITKv4/ImageRegistration20.cxx, Examples/RegistrationITKv4/ImageRegistration3.cxx, Examples/RegistrationITKv4/ImageRegistration4.cxx, Examples/RegistrationITKv4/ImageRegistration5.cxx, Examples/RegistrationITKv4/ImageRegistration6.cxx, Examples/RegistrationITKv4/ImageRegistration7.cxx, Examples/RegistrationITKv4/ImageRegistration8.cxx, Examples/RegistrationITKv4/ImageRegistration9.cxx, Examples/RegistrationITKv4/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv4/IterativeClosestPoint1.cxx, Examples/RegistrationITKv4/IterativeClosestPoint2.cxx, Examples/RegistrationITKv4/ModelToImageRegistration1.cxx, Examples/RegistrationITKv4/ModelToImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration1.cxx, Examples/RegistrationITKv4/MultiResImageRegistration2.cxx, Examples/RegistrationITKv4/MultiResImageRegistration3.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx, Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, SphinxExamples/src/Core/Common/ObserveAnEvent/Code.cxx, SphinxExamples/src/Numerics/Optimizers/ExhaustiveOptimizer/Code.cxx, SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx, SphinxExamples/src/Registration/Common/WatchRegistration/Code.cxx, and SphinxExamples/src/Registration/Metricsv4/RegisterTwoPointSets/Code.cxx.

Definition at line 61 of file itkObject.h.

Inherits itk::LightObject.

Collaboration diagram for itk::Object:

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

const char *	GetNameOfClass () const override

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

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

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

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 Member Functions
	itkGetGlobalDeclarationMacro (bool, GlobalWarningDisplay)

Private Attributes
bool	m_Debug { false }

std::unique_ptr< MetaDataDictionary >	m_MetaDataDictionary { nullptr }

TimeStamp	m_MTime {}

std::string	m_ObjectName {}

std::unique_ptr< SubjectImplementation >	m_SubjectImplementation

Static Private Attributes
static bool *	m_GlobalWarningDisplay

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 70 of file itkObject.h.

◆ Pointer

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

Definition at line 69 of file itkObject.h.

◆ Self

using itk::Object::Self = Object

Smart pointer type alias support

Definition at line 67 of file itkObject.h.

◆ Superclass

using itk::Object::Superclass = LightObject

Definition at line 68 of file itkObject.h.

Constructor & Destructor Documentation

◆ Object()

itk::Object::Object ( )

protected

◆ ~Object()

itk::Object::~Object ( )

overrideprotected

Member Function Documentation

◆ AddObserver() [1/3]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)

Add an observer/command to this object invoked for event.

This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command.

Note: This member function is overloaded for const and non-const, just for backward compatibility. Removing the non-const overload appears to break the use of SWIG pythonprepend in ITK/Wrapping/Generators/Python/PyBase/pyBase.i

◆ AddObserver() [2/3]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)		const

◆ AddObserver() [3/3]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		std::function< void(const EventObject &)>	function
	)		const

A convenient method to add an C++ lambda function as an observer.

A FunctionCommand object in implicitly create to hold function, and passed to this object as a standard observer. The command will be invoked for the specified event.

The function or lambda cannot captured this object as SmartPoint because a circular dependency is generated which causing memory leaks. Sample usage:

auto &objRef = *o.GetPointer();
o->AddObserver(itk::AnyEvent(), [&objRef](const itk::EventObject &event)
{ std::cout << "Object: " << objRef.GetNameOfClass() << " Event: " << event << std::endl; });

See also: FunctionCommand

◆ CreateAnother()

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

overridevirtual

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::LightObject.

Reimplemented in itk::BSplineDeformableTransform< TParametersValueType, VDimension, VSplineOrder >.

◆ DebugOff()

virtual void itk::Object::DebugOff ( ) const

virtual

Turn debugging output off.

◆ DebugOn()

virtual void itk::Object::DebugOn ( ) const

virtual

Turn debugging output on.

◆ GetCommand()

Command* itk::Object::GetCommand ( unsigned long tag )

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to assign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

◆ GetDebug()

bool itk::Object::GetDebug ( ) const

Get the value of the debug flag.

◆ GetGlobalWarningDisplay()

static bool itk::Object::GetGlobalWarningDisplay ( )

static

◆ GetMetaDataDictionary() [1/2]

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( )

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

◆ GetMetaDataDictionary() [2/2]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( ) const

Returns: A constant reference to this objects MetaDataDictionary.

◆ GetMTime()

virtual ModifiedTimeType itk::Object::GetMTime ( ) const

virtual

Return this object's modified time.

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Examples: Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

◆ GetObjectName()

virtual const std::string& itk::Object::GetObjectName ( ) const

virtual

A facility to help application programmers set a human identifiable name for a given object. This has no inherent use in ITK, but is a convenience to allow developers to provide a name for this object.

Examples: Examples/RegistrationITKv4/MultiStageImageRegistration1.cxx, and Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

◆ GetTimeStamp()

virtual const TimeStamp& itk::Object::GetTimeStamp ( ) const

virtual

Return this object's time stamp.

Reimplemented in itk::RealTimeClock.

◆ GlobalWarningDisplayOff()

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestatic

Definition at line 142 of file itkObject.h.

◆ GlobalWarningDisplayOn()

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestatic

Definition at line 137 of file itkObject.h.

◆ HasObserver()

bool itk::Object::HasObserver ( const EventObject & event ) const

Return true if an observer is registered for this event.

◆ InvokeEvent() [1/2]

void itk::Object::InvokeEvent ( const EventObject & )

Call Execute on all the Commands observing this event id.

◆ InvokeEvent() [2/2]

void itk::Object::InvokeEvent ( const EventObject & ) const

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

◆ itkGetGlobalDeclarationMacro()

itk::Object::itkGetGlobalDeclarationMacro	(	bool	,
		GlobalWarningDisplay
	)

private

Only used to synchronize the global variable across static libraries.

◆ Modified()

virtual void itk::Object::Modified ( ) const

virtual

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

◆ New()

static Pointer itk::Object::New ( )

static

Method for creation through the object factory.

◆ PrintObservers()

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

protected

◆ PrintSelf()

void itk::Object::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::LightObject.

Referenced by itk::OptimizerParameterScalesEstimatorTemplate< TMetric::ParametersValueType >::PrintSelf(), itk::QuadEdgeMeshDecimationCriterion< TMesh, TElement, TMeasure, TPriorityQueueWrapper >::PrintSelf(), itk::TransformParametersAdaptorBase< Transform< TTransform::ScalarType, TTransform::InputSpaceDimension, TTransform::OutputSpaceDimension > >::PrintSelf(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::PrintSelf(), itk::Function::ColormapFunction< TScalar, TRGBPixel >::PrintSelf(), and itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf().

◆ Register()

void itk::Object::Register ( ) const

overridevirtual

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

◆ RemoveAllObservers()

void itk::Object::RemoveAllObservers ( )

Remove all observers .

◆ RemoveObserver()

void itk::Object::RemoveObserver ( unsigned long tag )

Remove the observer with this tag value.

◆ SetDebug()

void itk::Object::SetDebug ( bool debugFlag ) const

Set the value of the debug flag. A non-zero value turns debugging on.

◆ SetGlobalWarningDisplay()

static void itk::Object::SetGlobalWarningDisplay ( bool val )

static

This is a global flag that controls whether any debug, warning or error messages are displayed.

◆ SetMetaDataDictionary() [1/2]

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

Set the MetaDataDictionary

◆ SetMetaDataDictionary() [2/2]

void itk::Object::SetMetaDataDictionary ( MetaDataDictionary && rrhs )

Set the MetaDataDictionary

◆ SetObjectName()

virtual void itk::Object::SetObjectName ( std::string _arg )

virtual

A facility to help application programmers set a human identifiable name for a given object. This has no inherent use in ITK, but is a convenience to allow developers to provide a name for this object.

◆ SetReferenceCount()

void itk::Object::SetReferenceCount ( int )

overridevirtual

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

◆ SetTimeStamp()

virtual void itk::Object::SetTimeStamp ( const TimeStamp & timeStamp )

protectedvirtual

Set the time stamp of this object. This method must be used very carefully !!!. Most mortals will never need to call this method.

◆ UnRegister()

void itk::Object::UnRegister ( ) const

overridevirtualnoexcept

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

◆ m_Debug

bool itk::Object::m_Debug { false }

mutableprivate

Enable/Disable debug messages.

Definition at line 272 of file itkObject.h.

◆ m_GlobalWarningDisplay

bool* itk::Object::m_GlobalWarningDisplay

staticprivate

Global object debug flag.

Definition at line 278 of file itkObject.h.

◆ m_MetaDataDictionary

std::unique_ptr<MetaDataDictionary> itk::Object::m_MetaDataDictionary { nullptr }

mutableprivate

Implementation for holding Object MetaData

See also: itk::MetaDataDictionary; itk::MetaDataObjectBase; itk::MetaDataObject This is only allocated if used.

Definition at line 294 of file itkObject.h.

◆ m_MTime

TimeStamp itk::Object::m_MTime {}

mutableprivate

Keep track of modification time.

Definition at line 275 of file itkObject.h.

◆ m_ObjectName

std::string itk::Object::m_ObjectName {}

private

Definition at line 296 of file itkObject.h.

◆ m_SubjectImplementation

std::unique_ptr<SubjectImplementation> itk::Object::m_SubjectImplementation

mutableprivate

Implementation class for Subject/Observer Pattern. This is only allocated if used.

Definition at line 281 of file itkObject.h.

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

itkObject.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ Object()

◆ ~Object()

Member Function Documentation

◆ AddObserver() [1/3]

◆ AddObserver() [2/3]

◆ AddObserver() [3/3]

◆ CreateAnother()

◆ DebugOff()

◆ DebugOn()

◆ GetCommand()

◆ GetDebug()

◆ GetGlobalWarningDisplay()

◆ GetMetaDataDictionary() [1/2]

◆ GetMetaDataDictionary() [2/2]

◆ GetMTime()

◆ GetNameOfClass()

◆ GetObjectName()

◆ GetTimeStamp()

◆ GlobalWarningDisplayOff()

◆ GlobalWarningDisplayOn()

◆ HasObserver()

◆ InvokeEvent() [1/2]

◆ InvokeEvent() [2/2]

◆ itkGetGlobalDeclarationMacro()

◆ Modified()

◆ New()

◆ PrintObservers()

◆ PrintSelf()

◆ Register()

◆ RemoveAllObservers()

◆ RemoveObserver()

◆ SetDebug()

◆ SetGlobalWarningDisplay()

◆ SetMetaDataDictionary() [1/2]

◆ SetMetaDataDictionary() [2/2]

◆ SetObjectName()

◆ SetReferenceCount()

◆ SetTimeStamp()

◆ UnRegister()

Member Data Documentation

◆ m_Debug

◆ m_GlobalWarningDisplay

◆ m_MetaDataDictionary

◆ m_MTime

◆ m_ObjectName

◆ m_SubjectImplementation