itk::SceneSpatialObject< SpaceDimension > Class Template Reference

#include <itkSceneSpatialObject.h>

Inheritance diagram for itk::SceneSpatialObject< SpaceDimension >:

[legend]Collaboration diagram for itk::SceneSpatialObject< SpaceDimension >:

[legend]List of all members.

---

Detailed Description

template<unsigned int SpaceDimension = 3>
class itk::SceneSpatialObject< SpaceDimension >

a SceneSpatialObject has a list of SpatialObjects

This class represent a SceneSpatialObject object into which one can plug any kind of spatial object.

See also:

SpatialObject

Definition at line 38 of file itkSceneSpatialObject.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef std::list< SpatialObjectPointer >	ObjectListType
typedef SpatialObject< SpaceDimension >	ObjectType
typedef SmartPointer< Self >	Pointer
typedef SceneSpatialObject< SpaceDimension >	Self
typedef SpatialObjectType::Pointer	SpatialObjectPointer
typedef SpatialObject< SpaceDimension >	SpatialObjectType
typedef Object	Superclass
typedef Superclass::Pointer	SuperclassPointer
Public Member Functions
void	AddSpatialObject (SpatialObject< SpaceDimension > *pointer)
bool	CheckIdValidity (void)
void	Clear ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
bool	FixHierarchy (void)
void	FixIdValidity (void)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
unsigned long	GetMTime (void) const
virtual const char *	GetNameOfClass () const
int	GetNextAvailableId ()
unsigned int	GetNumberOfObjects (unsigned int depth=MaximumDepth, char *name=NULL)
SpatialObject< SpaceDimension > *	GetObjectById (int Id)
ObjectListType *	GetObjects (unsigned int depth=MaximumDepth, char *name=NULL)
int	GetParentId (void)
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (MaximumDepth, unsigned int, 9999999)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	RemoveSpatialObject (SpatialObject< SpaceDimension > *object)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetObjects (ObjectListType &children)
Get Set the ParentID *void	SetParentId (int parentid)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
Method for creation through the object factory *static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SceneSpatialObject ()
virtual	~SceneSpatialObject ()
Protected Attributes
ObjectListType	m_Objects
int	m_ParentId
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<unsigned int SpaceDimension = 3> typedef SmartPointer< const Self > itk::SceneSpatialObject< SpaceDimension >::ConstPointer

Reimplemented from itk::Object. Definition at line 48 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef std::list< SpatialObjectPointer > itk::SceneSpatialObject< SpaceDimension >::ObjectListType

Definition at line 55 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef SpatialObject<SpaceDimension> itk::SceneSpatialObject< SpaceDimension >::ObjectType

Definition at line 50 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef SmartPointer< Self > itk::SceneSpatialObject< SpaceDimension >::Pointer

Reimplemented from itk::Object. Definition at line 47 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef SceneSpatialObject<SpaceDimension> itk::SceneSpatialObject< SpaceDimension >::Self

Smart pointer typedef support. Reimplemented from itk::Object. Definition at line 44 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef SpatialObjectType::Pointer itk::SceneSpatialObject< SpaceDimension >::SpatialObjectPointer

Definition at line 52 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef SpatialObject<SpaceDimension> itk::SceneSpatialObject< SpaceDimension >::SpatialObjectType

Definition at line 51 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef Object itk::SceneSpatialObject< SpaceDimension >::Superclass

Reimplemented from itk::Object. Definition at line 45 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> typedef Superclass::Pointer itk::SceneSpatialObject< SpaceDimension >::SuperclassPointer

Definition at line 46 of file itkSceneSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int SpaceDimension = 3> itk::SceneSpatialObject< SpaceDimension >::SceneSpatialObject (   )  [protected]

constructor

template<unsigned int SpaceDimension = 3> virtual itk::SceneSpatialObject< SpaceDimension >::~SceneSpatialObject (   )  [protected, virtual]

destructor

---

Member Function Documentation

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::AddSpatialObject (  SpatialObject< SpaceDimension > *  pointer  )

Add an object to the list of children.

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<unsigned int SpaceDimension = 3> bool itk::SceneSpatialObject< SpaceDimension >::CheckIdValidity (  void   )

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::Clear (   )

Clear function : Remove all the objects in the scene

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<unsigned int SpaceDimension = 3> bool itk::SceneSpatialObject< SpaceDimension >::FixHierarchy (  void   )

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::FixIdValidity (  void   )

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign 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 [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

template<unsigned int SpaceDimension = 3> unsigned long itk::SceneSpatialObject< SpaceDimension >::GetMTime (  void   )  const [virtual]

Returns the latest modified time of all the objects contained in this SceneSpatialObject object. Reimplemented from itk::Object.

template<unsigned int SpaceDimension = 3> virtual const char* itk::SceneSpatialObject< SpaceDimension >::GetNameOfClass (   )  const [virtual]

Standard part of all itk objects. Reimplemented from itk::Object.

template<unsigned int SpaceDimension = 3> int itk::SceneSpatialObject< SpaceDimension >::GetNextAvailableId (   )

template<unsigned int SpaceDimension = 3> unsigned int itk::SceneSpatialObject< SpaceDimension >::GetNumberOfObjects (  unsigned int  depth = MaximumDepth, char *  name = NULL )

Returns the number of children currently assigned to the SceneSpatialObject object.

template<unsigned int SpaceDimension = 3> SpatialObject<SpaceDimension>* itk::SceneSpatialObject< SpaceDimension >::GetObjectById (  int  Id  )

Return a SpatialObject in the SceneSpatialObject given its ID

template<unsigned int SpaceDimension = 3> ObjectListType* itk::SceneSpatialObject< SpaceDimension >::GetObjects (  unsigned int  depth = MaximumDepth, char *  name = NULL )

Returns a list of pointer to the objects in the scene. Warning: This function creates a new list therefore the user is responsible for the deletion of the list.

template<unsigned int SpaceDimension = 3> int itk::SceneSpatialObject< SpaceDimension >::GetParentId (  void   )  [inline]

Definition at line 92 of file itkSceneSpatialObject.h.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

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

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

template<unsigned int SpaceDimension = 3> itk::SceneSpatialObject< SpaceDimension >::itkStaticConstMacro (  MaximumDepth  , unsigned  int, 9999999  )

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<unsigned int SpaceDimension = 3> Method for creation through the object factory* static Pointer itk::SceneSpatialObject< SpaceDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<unsigned int SpaceDimension = 3> virtual void itk::SceneSpatialObject< SpaceDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Print the object informations in a stream. Reimplemented from itk::Object.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::RemoveSpatialObject (  SpatialObject< SpaceDimension > *  object  )

Remove the object passed as arguments from the list of children. May this function should return a false value if the object to remove is not found in the list.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

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

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::SetObjects (  ObjectListType &  children  )

Set the list of pointers to children to the list passed as argument.

template<unsigned int SpaceDimension = 3> Get Set the ParentID* void itk::SceneSpatialObject< SpaceDimension >::SetParentId (  int  parentid  )  [inline]

Definition at line 91 of file itkSceneSpatialObject.h.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<unsigned int SpaceDimension = 3> ObjectListType itk::SceneSpatialObject< SpaceDimension >::m_Objects [protected]

List of the children object plug to the SceneSpatialObject spatial object. Definition at line 109 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> int itk::SceneSpatialObject< SpaceDimension >::m_ParentId [protected]

Parent ID : default = -1 Definition at line 121 of file itkSceneSpatialObject.h. Referenced by itk::SceneSpatialObject< NDimensions >::GetParentId(), and itk::SceneSpatialObject< NDimensions >::SetParentId().

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkSceneSpatialObject.h

---