itk::watershed::SegmentTree< TScalarType > Class Template Reference

#include <itkWatershedSegmentTree.h>

Inheritance diagram for itk::watershed::SegmentTree:

[legend]Collaboration diagram for itk::watershed::SegmentTree< TScalarType >:

[legend]List of all members.

[NOHEADER]
typedef SegmentTree	Self
typedef DataObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TScalarType	ScalarType
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef std::deque< merge_t >	DequeType
typedef DequeType::iterator	Iterator
typedef DequeType::const_iterator	ConstIterator
typedef DequeType::value_type	ValueType
Public Methods
DequeType::size_type	Size () const
bool	Empty () const
const merge_t &	Front () const
const merge_t &	Back () const
merge_t &	Front ()
merge_t &	Back ()
void	PushFront (const ValueType &t)
void	PushBack (const ValueType &t)
void	PopFront ()
void	PopBack ()
Iterator	Begin ()
ConstIterator	Begin () const
Iterator	End ()
ConstIterator	End () const
void	Clear ()
Protected Methods
void	UpdateOutputInformation ()
bool	VerifyRequestedRegion ()
void	SetRequestedRegionToLargestPossibleRegion ()
bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
void	SetRequestedRegion (itk::DataObject *)
	SegmentTree ()
virtual	~SegmentTree ()
	SegmentTree (const Self &)
void	operator= (const Self &)
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
DequeType	m_Deque

template<class TScalarType>
class itk::watershed::SegmentTree< TScalarType >

---

Member Typedef Documentation

template<class TScalarType> typedef DequeType::const_iterator itk::watershed::SegmentTree< TScalarType >::ConstIterator

Definition at line 71 of file itkWatershedSegmentTree.h. Referenced by itk::watershed::SegmentTree< TScalarType >::Begin(), and itk::watershed::SegmentTree< TScalarType >::End().

template<class TScalarType> typedef SmartPointer<const Self> itk::watershed::SegmentTree< TScalarType >::ConstPointer

Define itk Smart Pointers for this object Reimplemented from itk::DataObject. Definition at line 51 of file itkWatershedSegmentTree.h.

template<class TScalarType> typedef std::deque<merge_t> itk::watershed::SegmentTree< TScalarType >::DequeType

Define the container type used in this list data structure Definition at line 69 of file itkWatershedSegmentTree.h. Referenced by itk::watershed::SegmentTree< TScalarType >::operator=().

template<class TScalarType> typedef DequeType::iterator itk::watershed::SegmentTree< TScalarType >::Iterator

Definition at line 70 of file itkWatershedSegmentTree.h. Referenced by itk::watershed::SegmentTree< TScalarType >::Begin(), and itk::watershed::SegmentTree< TScalarType >::PopBack().

template<class TScalarType> typedef SmartPointer<Self> itk::watershed::SegmentTree< TScalarType >::Pointer

Define itk Smart Pointers for this object Reimplemented from itk::DataObject. Definition at line 50 of file itkWatershedSegmentTree.h.

template<class TScalarType> typedef TScalarType itk::watershed::SegmentTree< TScalarType >::ScalarType

Define itk Smart Pointers for this object Definition at line 54 of file itkWatershedSegmentTree.h.

template<class TScalarType> typedef SegmentTree itk::watershed::SegmentTree< TScalarType >::Self

Define itk Smart Pointers for this object Reimplemented from itk::DataObject. Definition at line 48 of file itkWatershedSegmentTree.h.

template<class TScalarType> typedef DataObject itk::watershed::SegmentTree< TScalarType >::Superclass

Define itk Smart Pointers for this object Reimplemented from itk::DataObject. Definition at line 49 of file itkWatershedSegmentTree.h.

template<class TScalarType> typedef DequeType::value_type itk::watershed::SegmentTree< TScalarType >::ValueType

Definition at line 72 of file itkWatershedSegmentTree.h. Referenced by itk::watershed::SegmentTree< TScalarType >::Back(), and itk::watershed::SegmentTree< TScalarType >::PushFront().

---

Constructor & Destructor Documentation

template<class TScalarType> itk::watershed::SegmentTree< TScalarType >::SegmentTree (    )  [inline, protected]

Helper method for debugging. Definition at line 162 of file itkWatershedSegmentTree.h.

template<class TScalarType> virtual itk::watershed::SegmentTree< TScalarType >::~SegmentTree (    )  [inline, protected, virtual]

Helper method for debugging. Definition at line 163 of file itkWatershedSegmentTree.h.

template<class TScalarType> itk::watershed::SegmentTree< TScalarType >::SegmentTree (  const Self &    )  [inline, protected]

Helper method for debugging. Definition at line 164 of file itkWatershedSegmentTree.h.

---

Member Function Documentation

template<class TScalarType> merge_t& itk::watershed::SegmentTree< TScalarType >::Back (    )  [inline]

Returns a reference to the back of the list Definition at line 118 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque, and itk::watershed::SegmentTree< TScalarType >::ValueType.

template<class TScalarType> const merge_t& itk::watershed::SegmentTree< TScalarType >::Back (    )  const [inline]

Returns a const reference to the back of the list (node with the greatest saliency value). Definition at line 110 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> ConstIterator itk::watershed::SegmentTree< TScalarType >::Begin (    )  const [inline]

Returns a const iterator pointing to the first element in the list. Definition at line 142 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::Iterator, and itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> Iterator itk::watershed::SegmentTree< TScalarType >::Begin (    )  [inline]

Returns an iterator pointing to the first element in the list. Definition at line 138 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::ConstIterator, and itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::Clear (    )  [inline]

Clears the Deque completely Definition at line 156 of file itkWatershedSegmentTree.h.

template<class TScalarType> bool itk::watershed::SegmentTree< TScalarType >::Empty (    )  const [inline]

Returns TRUE if the SegmentTree is empty, FALSE if the SegmentTree is not empty. Definition at line 100 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> ConstIterator itk::watershed::SegmentTree< TScalarType >::End (    )  const [inline]

Returns a const iterator pointing one element past the last element in the list. Definition at line 152 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> Iterator itk::watershed::SegmentTree< TScalarType >::End (    )  [inline]

Returns an iterator pointing one element past the last element in the list. Definition at line 147 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::ConstIterator, and itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> merge_t& itk::watershed::SegmentTree< TScalarType >::Front (    )  [inline]

Returns a reference to the front of the list Definition at line 114 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> const merge_t& itk::watershed::SegmentTree< TScalarType >::Front (    )  const [inline]

Returns a const reference to the front of the list (node with the least saliency value). Definition at line 105 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> virtual const char* itk::watershed::SegmentTree< TScalarType >::GetClassName (    )  const [virtual]

Define itk Smart Pointers for this object Reimplemented from itk::DataObject.

template<class TScalarType> Pointer itk::watershed::SegmentTree< TScalarType >::New (    )  [static]

Define itk Smart Pointers for this object Reimplemented from itk::Object.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::operator= (  const Self &    )  [inline, protected]

Helper method for debugging. Reimplemented from itk::DataObject. Definition at line 165 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::DequeType, and itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::PopBack (    )  [inline]

Erases the node at the back of the list. Definition at line 134 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::Iterator, and itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::PopFront (    )  [inline]

Erases the node at the front of the list. Definition at line 130 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

Helper method for debugging. Reimplemented from itk::DataObject.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::PushBack (  const ValueType &    t )  [inline]

Inserts a node at the back of the list Definition at line 126 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::PushFront (  const ValueType &    t )  [inline]

Inserts a node at the front of the list. Definition at line 122 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque, and itk::watershed::SegmentTree< TScalarType >::ValueType.

template<class TScalarType> bool itk::watershed::SegmentTree< TScalarType >::RequestedRegionIsOutsideOfTheBufferedRegion (    )  [inline, protected, virtual]

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute Implements itk::DataObject. Definition at line 173 of file itkWatershedSegmentTree.h.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::SetRequestedRegion (  itk::DataObject *    )  [inline, protected, virtual]

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method is implemented in the concrete subclasses of DataObject. Implements itk::DataObject. Definition at line 174 of file itkWatershedSegmentTree.h.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::SetRequestedRegionToLargestPossibleRegion (    )  [inline, protected, virtual]

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update(). Implements itk::DataObject. Definition at line 172 of file itkWatershedSegmentTree.h.

template<class TScalarType> DequeType::size_type itk::watershed::SegmentTree< TScalarType >::Size (    )  const [inline]

Returns the size of the list. Definition at line 95 of file itkWatershedSegmentTree.h. References itk::watershed::SegmentTree< TScalarType >::m_Deque.

template<class TScalarType> void itk::watershed::SegmentTree< TScalarType >::UpdateOutputInformation (    )  [protected, virtual]

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used in the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. Any implementation of this method in a derived class is assumed to call its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc. Implements itk::DataObject.

template<class TScalarType> bool itk::watershed::SegmentTree< TScalarType >::VerifyRequestedRegion (    )  [inline, protected, virtual]

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possibly satisfy the request. This method returns true if the request can be satisfied (even if it will be necessary to process the entire LargestPossibleRegion) and returns false otherwise. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception if the requested region is not within the LargestPossibleRegion. Implements itk::DataObject. Definition at line 171 of file itkWatershedSegmentTree.h.

---

Member Data Documentation

template<class TScalarType> DequeType itk::watershed::SegmentTree< TScalarType >::m_Deque [protected]

Definition at line 169 of file itkWatershedSegmentTree.h. Referenced by itk::watershed::SegmentTree< TScalarType >::Back(), itk::watershed::SegmentTree< TScalarType >::Begin(), itk::watershed::SegmentTree< TScalarType >::Empty(), itk::watershed::SegmentTree< TScalarType >::End(), itk::watershed::SegmentTree< TScalarType >::Front(), itk::watershed::SegmentTree< TScalarType >::operator=(), itk::watershed::SegmentTree< TScalarType >::PopBack(), itk::watershed::SegmentTree< TScalarType >::PopFront(), itk::watershed::SegmentTree< TScalarType >::PushBack(), itk::watershed::SegmentTree< TScalarType >::PushFront(), and itk::watershed::SegmentTree< TScalarType >::Size().

---

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

• itkWatershedSegmentTree.h

---