itk::TreeContainer< TValueType > Class Template Reference
[Data Representation Objects]

#include <itkTreeContainer.h>

Inheritance diagram for itk::TreeContainer< TValueType >:

[legend]Collaboration diagram for itk::TreeContainer< TValueType >:

[legend]List of all members.

---

Detailed Description

template<class TValueType>
class itk::TreeContainer< TValueType >

TreeContainer class.

This class derives from the TreeContainerBase class.

The class is templated over the type of the elements.

Template parameters for class TreeContainer:

• TValueType = Element type stored at each location in the Tree.

Definition at line 41 of file itkTreeContainer.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TreeIteratorBase< Self >	IteratorType
typedef SmartPointer< Self >	Pointer
typedef PreOrderTreeIterator< Self >	PreOrderIteratorType
typedef TreeContainer< TValueType >	Self
typedef TreeContainerBase< TValueType >	Superclass
typedef TreeNode< ValueType >	TreeNodeType
typedef TValueType	ValueType
Public Member Functions
bool	Add (const TValueType child, const TValueType parent)
bool	Clear ()
bool	Contains (const TValueType element)
int	Count () const
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
const TreeNodeType *	GetNode (TValueType val) const
virtual int	GetReferenceCount () const
const TreeNodeType *	GetRoot () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
bool	IsLeaf (const TValueType element)
bool	IsRoot (const TValueType element)
virtual void	Modified () const
bool	operator== (TreeContainer< TValueType > &tree)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual bool	SetRoot (TreeNode< TValueType > *node)
bool	SetRoot (IteratorType &pos)
virtual bool	SetRoot (TValueType element)
void	SetSubtree (bool val)
bool	Swap (IteratorType &v, IteratorType &w)
	TreeContainer (TreeContainer< TValueType > &tree)
	TreeContainer (int defaultChildrenCount)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
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
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	TreeContainer ()
virtual	~TreeContainer ()
Protected Attributes
int	m_DefaultChildrenCount
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TreeNodeType::Pointer	m_Root
bool	m_SubTree
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<class TValueType> typedef SmartPointer<const Self> itk::TreeContainer< TValueType >::ConstPointer

Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 50 of file itkTreeContainer.h.

template<class TValueType> typedef TreeIteratorBase<Self> itk::TreeContainer< TValueType >::IteratorType

Iterators typedef Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 55 of file itkTreeContainer.h.

template<class TValueType> typedef SmartPointer<Self> itk::TreeContainer< TValueType >::Pointer

Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 49 of file itkTreeContainer.h.

template<class TValueType> typedef PreOrderTreeIterator<Self> itk::TreeContainer< TValueType >::PreOrderIteratorType

Definition at line 56 of file itkTreeContainer.h.

template<class TValueType> typedef TreeContainer<TValueType> itk::TreeContainer< TValueType >::Self

Smart pointer typedef support. Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 48 of file itkTreeContainer.h.

template<class TValueType> typedef TreeContainerBase<TValueType> itk::TreeContainer< TValueType >::Superclass

Standard typedefs Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 47 of file itkTreeContainer.h.

template<class TValueType> typedef TreeNode<ValueType> itk::TreeContainer< TValueType >::TreeNodeType

Reimplemented in itk::SpatialObjectTreeContainer< TDimension >. Definition at line 52 of file itkTreeContainer.h.

template<class TValueType> typedef TValueType itk::TreeContainer< TValueType >::ValueType

Reimplemented from itk::TreeContainerBase< TValueType >. Definition at line 51 of file itkTreeContainer.h.

---

Constructor & Destructor Documentation

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (  int  defaultChildrenCount  )

Constructor

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (  TreeContainer< TValueType > &  tree  )

Constructor

template<class TValueType> itk::TreeContainer< TValueType >::TreeContainer (   )  [protected]

template<class TValueType> virtual itk::TreeContainer< TValueType >::~TreeContainer (   )  [protected, virtual]

---

Member Function Documentation

template<class TValueType> bool itk::TreeContainer< TValueType >::Add (  const TValueType  child, const TValueType  parent )

Add a child to a given parent using values

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

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

template<class TValueType> bool itk::TreeContainer< TValueType >::Clear (   )  [virtual]

Clear the tree Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::Contains (  const TValueType  element  )  [virtual]

Return true if the element is in the tree Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> int itk::TreeContainer< TValueType >::Count (   )  const [virtual]

Return the number of elements in the tree Implements itk::TreeContainerBase< TValueType >.

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.

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.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TValueType> virtual const char* itk::TreeContainer< TValueType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::TreeContainerBase< TValueType >. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

template<class TValueType> const TreeNodeType* itk::TreeContainer< TValueType >::GetNode (  TValueType  val  )  const

Get node given a value

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

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

template<class TValueType> const TreeNodeType* itk::TreeContainer< TValueType >::GetRoot (   )  const [inline, virtual]

Get the root Implements itk::TreeContainerBase< TValueType >. Definition at line 101 of file itkTreeContainer.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<class TValueType> bool itk::TreeContainer< TValueType >::IsLeaf (  const TValueType  element  )  [virtual]

Return true if the element is a leaf Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::IsRoot (  const TValueType  element  )  [virtual]

Return true if the element is a root Implements itk::TreeContainerBase< TValueType >.

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<class TValueType> static Pointer itk::TreeContainer< TValueType >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object. Reimplemented in itk::SpatialObjectTreeContainer< TDimension >.

template<class TValueType> bool itk::TreeContainer< TValueType >::operator== (  TreeContainer< TValueType > &  tree  )

operator equal

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<class TValueType> void itk::TreeContainer< TValueType >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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

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

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

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

template<class TValueType> virtual bool itk::TreeContainer< TValueType >::SetRoot (  TreeNode< TValueType > *  node  )  [virtual]

Set the root as a tree node Implements itk::TreeContainerBase< TValueType >.

template<class TValueType> bool itk::TreeContainer< TValueType >::SetRoot (  IteratorType &  pos  )

The the root as an iterator position

template<class TValueType> virtual bool itk::TreeContainer< TValueType >::SetRoot (  TValueType  element  )  [virtual]

Set the root as an element Implements itk::TreeContainerBase< TValueType >. Referenced by itk::SpatialObjectTreeContainer< TDimension >::SetRoot().

template<class TValueType> void itk::TreeContainerBase< TValueType >::SetSubtree (  bool  val  )  [inline, inherited]

Set if the tree is a subtree Definition at line 72 of file itkTreeContainerBase.h.

template<class TValueType> bool itk::TreeContainer< TValueType >::Swap (  IteratorType &  v, IteratorType &  w )

Swap the iterators

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<class TValueType> int itk::TreeContainer< TValueType >::m_DefaultChildrenCount [protected]

Definition at line 115 of file itkTreeContainer.h.

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.

template<class TValueType> TreeNodeType::Pointer itk::TreeContainer< TValueType >::m_Root [protected]

Definition at line 114 of file itkTreeContainer.h. Referenced by itk::TreeContainer< itk::SpatialObject< TDimension > * >::GetRoot().

template<class TValueType> bool itk::TreeContainerBase< TValueType >::m_SubTree [protected, inherited]

Definition at line 77 of file itkTreeContainerBase.h. Referenced by itk::TreeContainerBase< itk::SpatialObject< TDimension > * >::SetSubtree().

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:

• itkTreeContainer.h

---