#include <itkObject.h>

Inherits itk::LightObject.

Collaboration diagram for itk::Object:

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.

Wiki Examples:

Examples:: Examples/RegistrationITKv3/BSplineWarping1.cxx, Examples/RegistrationITKv3/BSplineWarping2.cxx, Examples/RegistrationITKv3/DeformableRegistration10.cxx, Examples/RegistrationITKv3/DeformableRegistration12.cxx, Examples/RegistrationITKv3/DeformableRegistration13.cxx, Examples/RegistrationITKv3/DeformableRegistration14.cxx, Examples/RegistrationITKv3/DeformableRegistration15.cxx, Examples/RegistrationITKv3/DeformableRegistration16.cxx, Examples/RegistrationITKv3/DeformableRegistration17.cxx, Examples/RegistrationITKv3/DeformableRegistration2.cxx, Examples/RegistrationITKv3/DeformableRegistration3.cxx, Examples/RegistrationITKv3/DeformableRegistration5.cxx, Examples/RegistrationITKv3/DeformableRegistration7.cxx, Examples/RegistrationITKv3/DeformableRegistration8.cxx, Examples/RegistrationITKv3/DeformableRegistration9.cxx, Examples/RegistrationITKv3/ImageRegistration1.cxx, Examples/RegistrationITKv3/ImageRegistration10.cxx, Examples/RegistrationITKv3/ImageRegistration11.cxx, Examples/RegistrationITKv3/ImageRegistration12.cxx, Examples/RegistrationITKv3/ImageRegistration13.cxx, Examples/RegistrationITKv3/ImageRegistration14.cxx, Examples/RegistrationITKv3/ImageRegistration15.cxx, Examples/RegistrationITKv3/ImageRegistration16.cxx, Examples/RegistrationITKv3/ImageRegistration17.cxx, Examples/RegistrationITKv3/ImageRegistration18.cxx, Examples/RegistrationITKv3/ImageRegistration19.cxx, Examples/RegistrationITKv3/ImageRegistration2.cxx, Examples/RegistrationITKv3/ImageRegistration20.cxx, Examples/RegistrationITKv3/ImageRegistration3.cxx, Examples/RegistrationITKv3/ImageRegistration4.cxx, Examples/RegistrationITKv3/ImageRegistration5.cxx, Examples/RegistrationITKv3/ImageRegistration6.cxx, Examples/RegistrationITKv3/ImageRegistration7.cxx, Examples/RegistrationITKv3/ImageRegistration8.cxx, Examples/RegistrationITKv3/ImageRegistration9.cxx, Examples/RegistrationITKv3/ImageRegistrationHistogramPlotter.cxx, Examples/RegistrationITKv3/IterativeClosestPoint1.cxx, Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, Examples/RegistrationITKv3/ModelToImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration1.cxx, Examples/RegistrationITKv3/MultiResImageRegistration2.cxx, Examples/RegistrationITKv3/MultiResImageRegistration3.cxx, 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/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/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, and SphinxExamples/src/Registration/Common/PerformMultiModalityRegistrationWithMutualInformation/Code.cxx.

Definition at line 57 of file itkObject.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)

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

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride


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

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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
	Object (const Self &)

void	operator= (const Self &)

Private Attributes
bool	m_Debug

MetaDataDictionary *	m_MetaDataDictionary

TimeStamp	m_MTime

std::string	m_ObjectName

SubjectImplementation *	m_SubjectImplementation

Static Private Attributes
static bool	m_GlobalWarningDisplay

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::Object::ConstPointer

Definition at line 64 of file itkObject.h.

typedef SmartPointer< Self > itk::Object::Pointer

Definition at line 63 of file itkObject.h.

typedef Object itk::Object::Self

Smart pointer typedef support.

Definition at line 61 of file itkObject.h.

typedef LightObject itk::Object::Superclass

Definition at line 62 of file itkObject.h.

Constructor & Destructor Documentation

itk::Object::Object ( )

protected

virtual itk::Object::~Object ( )

protectedvirtual

itk::Object::Object ( const Self & )

private

Member Function Documentation

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

Allow people to add/remove/invoke observers (callbacks) to any ITK object. 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. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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

virtual 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.

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

virtual

Turn debugging output off.

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

virtual

Turn debugging output on.

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.

bool itk::Object::GetDebug ( ) const

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( )

static

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( )

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

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

Returns: A constant reference to this objects MetaDataDictionary.

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

virtual

Return this objects modified time.

Referenced by itk::SpatialObject< TMesh::PointDimension >::GetObjectMTime().

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

virtual

Standard part of all itk objects.

Reimplemented from itk::LightObject.

Examples:: Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

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.

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

virtual

Return this object's time stamp.

Reimplemented in itk::RealTimeClock.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestatic

Definition at line 118 of file itkObject.h.

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestatic

Definition at line 116 of file itkObject.h.

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

Return true if an observer is registered for this event.

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

Call Execute on all the Commands observing this event id.

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.

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.

static Pointer itk::Object::New ( )

static

Method for creation through the object factory.

void itk::Object::operator= ( const Self & )

private

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

protected

virtual 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::Statistics::NNetDistanceMetricBase< TMeasurementVector >::PrintSelf(), itk::Statistics::InputFunctionBase< TMeasurementVector, ScalarType >::PrintSelf(), itk::Statistics::TransferFunctionBase< TScalar >::PrintSelf(), itk::KernelFunctionBase< double >::PrintSelf(), itk::Statistics::RadialBasisFunctionBase< ScalarType >::PrintSelf(), 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(), itk::Statistics::MembershipFunctionBase< TMeasurementVector >::PrintSelf(), and itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf().

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

overridevirtual

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

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( )

Remove all observers .

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

Remove the observer with this tag value.

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

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

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

static

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

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

Set the MetaDataDictionary

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.

virtual void itk::Object::SetReferenceCount ( int )

overridevirtual

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

protectedvirtual

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

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

overridevirtualnoexcept

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

bool itk::Object::m_Debug

mutableprivate

Enable/Disable debug messages.

Definition at line 205 of file itkObject.h.

bool itk::Object::m_GlobalWarningDisplay

staticprivate

Global object debug flag.

Definition at line 211 of file itkObject.h.

MetaDataDictionary* itk::Object::m_MetaDataDictionary

mutableprivate

Implementation for holding Object MetaData

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

Definition at line 224 of file itkObject.h.

TimeStamp itk::Object::m_MTime

mutableprivate

Keep track of modification time.

Definition at line 208 of file itkObject.h.

std::string itk::Object::m_ObjectName

private

Definition at line 226 of file itkObject.h.

SubjectImplementation* itk::Object::m_SubjectImplementation

private

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

Definition at line 215 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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation