ITK  4.0.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | Friends
itk::LevelSetContainerBase< TIdentifier, TLevelSet > Class Template Reference

Container of level set. More...

#include <itkLevelSetContainerBase.h>

Inheritance diagram for itk::LevelSetContainerBase< TIdentifier, TLevelSet >:
Collaboration diagram for itk::LevelSetContainerBase< TIdentifier, TLevelSet >:

List of all members.

Classes

class  ConstIterator
class  Iterator

Public Types

typedef Image< short, DimensionCacheImageType
typedef SmartPointer< const SelfConstPointer
typedef std::map
< LevelSetIdentifierType,
LevelSetDomainType
DomainContainerType
typedef
DomainContainerType::iterator 
DomainIteratorType
typedef
DomainMapImageFilterType::Pointer 
DomainMapImageFilterPointer
typedef
LevelSetDomainMapImageFilter
< IdListImageType,
CacheImageType
DomainMapImageFilterType
typedef LevelSetType::GradientType GradientType
typedef HeavisideType::ConstPointer HeavisideConstPointer
typedef
HeavisideStepFunctionBase
< OutputRealType,
OutputRealType
HeavisideType
typedef LevelSetType::HessianType HessianType
typedef IdListType::const_iterator IdListConstIterator
typedef Image< IdListType,
Dimension
IdListImageType
typedef IdListType::iterator IdListIterator
typedef std::list
< LevelSetIdentifierType
IdListType
typedef LevelSetType::InputType InputIndexType
typedef
LevelSetContainerType::const_iterator 
LevelSetContainerConstIteratorType
typedef
LevelSetContainerType::iterator 
LevelSetContainerIteratorType
typedef std::map
< LevelSetIdentifierType,
LevelSetPointer
LevelSetContainerType
typedef
LevelSetType::LevelSetDataType 
LevelSetDataType
typedef
DomainMapImageFilterType::LevelSetDomain 
LevelSetDomainType
typedef TIdentifier LevelSetIdentifierType
typedef std::pair
< LevelSetIdentifierType,
LevelSetPointer
LevelSetPairType
typedef LevelSetType::Pointer LevelSetPointer
typedef TLevelSet LevelSetType
typedef
LevelSetType::OutputRealType 
OutputRealType
typedef LevelSetType::OutputType OutputType
typedef SmartPointer< SelfPointer
typedef LevelSetContainerBase Self
typedef Object Superclass

Public Member Functions

bool AddLevelSet (const LevelSetIdentifierType &iId, LevelSetType *iLevelSet, const bool iForce=true)
Iterator Begin ()
ConstIterator Begin () const
ConstIterator End () const
Iterator End ()
LevelSetPointer GetLevelSet (const LevelSetIdentifierType &iId) const
virtual const char * GetNameOfClass () const
bool HasDomainMap () const
bool RemoveLevelSet (const LevelSetIdentifierType &iId)
LevelSetIdentifierType Size () const
virtual void SetHeaviside (HeavisideType *_arg)
virtual const HeavisideTypeGetHeaviside ()
virtual void SetDomainMapFilter (DomainMapImageFilterType *_arg)
virtual DomainMapImageFilterTypeGetDomainMapFilter ()

Static Public Attributes

static const unsigned int Dimension = LevelSetType::Dimension

Protected Member Functions

const LevelSetContainerTypeGetContainer () const
 LevelSetContainerBase ()
void SetContainer (const LevelSetContainerType &iContainer)
 ~LevelSetContainerBase ()

Private Member Functions

 LevelSetContainerBase (const Self &)
void operator= (const Self &)

Private Attributes

LevelSetContainerType m_Container
DomainMapImageFilterPointer m_DomainMapFilter
HeavisideConstPointer m_Heaviside

Friends

class Iterator

Detailed Description

template<class TIdentifier, class TLevelSet>
class itk::LevelSetContainerBase< TIdentifier, TLevelSet >

Container of level set.

Encapsulate an ordered set of level set function (see LevelSetBase).

Template Parameters:
TIdentifiertype of the identifier used to reference on level set function
TLevelSettype of level set function in the container.

Definition at line 42 of file itkLevelSetContainerBase.h.


Member Typedef Documentation

template<class TIdentifier, class TLevelSet>
typedef Image< short, Dimension > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::CacheImageType
template<class TIdentifier, class TLevelSet>
typedef SmartPointer< const Self > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::ConstPointer
template<class TIdentifier, class TLevelSet>
typedef std::map< LevelSetIdentifierType, LevelSetDomainType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainContainerType

Definition at line 88 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef DomainContainerType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainIteratorType
template<class TIdentifier, class TLevelSet>
typedef DomainMapImageFilterType::Pointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainMapImageFilterPointer
template<class TIdentifier, class TLevelSet>
typedef LevelSetDomainMapImageFilter< IdListImageType, CacheImageType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainMapImageFilterType
template<class TIdentifier, class TLevelSet>
typedef LevelSetType::GradientType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GradientType
template<class TIdentifier, class TLevelSet>
typedef HeavisideType::ConstPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HeavisideConstPointer
template<class TIdentifier, class TLevelSet>
typedef HeavisideStepFunctionBase< OutputRealType, OutputRealType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HeavisideType
template<class TIdentifier, class TLevelSet>
typedef LevelSetType::HessianType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HessianType
template<class TIdentifier, class TLevelSet>
typedef IdListType::const_iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListConstIterator

Definition at line 77 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef Image< IdListType, Dimension > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListImageType
template<class TIdentifier, class TLevelSet>
typedef IdListType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListIterator
template<class TIdentifier, class TLevelSet>
typedef std::list< LevelSetIdentifierType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListType
template<class TIdentifier, class TLevelSet>
typedef LevelSetType::InputType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::InputIndexType
template<class TIdentifier, class TLevelSet>
typedef LevelSetContainerType::const_iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerConstIteratorType
template<class TIdentifier, class TLevelSet>
typedef LevelSetContainerType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerIteratorType
template<class TIdentifier, class TLevelSet>
typedef std::map< LevelSetIdentifierType, LevelSetPointer > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerType
template<class TIdentifier, class TLevelSet>
typedef LevelSetType::LevelSetDataType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetDataType

Definition at line 61 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef DomainMapImageFilterType::LevelSetDomain itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetDomainType
template<class TIdentifier, class TLevelSet>
typedef TIdentifier itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetIdentifierType
template<class TIdentifier, class TLevelSet>
typedef std::pair< LevelSetIdentifierType, LevelSetPointer > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetPairType

Definition at line 83 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef LevelSetType::Pointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetPointer
template<class TIdentifier, class TLevelSet>
typedef TLevelSet itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetType

typedefs related to the type of level set

Reimplemented in itk::LevelSetContainer< TIdentifier, TLevelSet >, and itk::LevelSetContainer< TIdentifier, LevelSetDenseImageBase< TImage > >.

Definition at line 51 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef LevelSetType::OutputRealType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::OutputRealType
template<class TIdentifier, class TLevelSet>
typedef LevelSetType::OutputType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::OutputType

Definition at line 57 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef SmartPointer< Self > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Pointer
template<class TIdentifier, class TLevelSet>
typedef LevelSetContainerBase itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Reimplemented in itk::LevelSetContainer< TIdentifier, TLevelSet >, and itk::LevelSetContainer< TIdentifier, LevelSetDenseImageBase< TImage > >.

Definition at line 45 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
typedef Object itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Superclass

Constructor & Destructor Documentation

template<class TIdentifier, class TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerBase ( ) [protected]

Default Constructor.

template<class TIdentifier, class TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::~LevelSetContainerBase ( ) [protected]

Default Destructor.

template<class TIdentifier, class TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerBase ( const Self ) [private]

Member Function Documentation

template<class TIdentifier, class TLevelSet>
bool itk::LevelSetContainerBase< TIdentifier, TLevelSet >::AddLevelSet ( const LevelSetIdentifierType iId,
LevelSetType iLevelSet,
const bool  iForce = true 
)

Add one level set function given its id.

Parameters:
[in]iIdid of the level set function
[in]iLevelSetthe level set function to be added
[in]iForceif iForce is true (default) the level set function will be added to the container even if there is already one with the same id.
Returns:
true if the level set has been added.
template<class TIdentifier, class TLevelSet>
Iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Begin ( )
template<class TIdentifier, class TLevelSet>
ConstIterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Begin ( ) const
template<class TIdentifier, class TLevelSet>
ConstIterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::End ( ) const
template<class TIdentifier, class TLevelSet>
Iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::End ( )
template<class TIdentifier, class TLevelSet>
const LevelSetContainerType& itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetContainer ( ) const [protected]
template<class TIdentifier, class TLevelSet>
virtual DomainMapImageFilterType* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetDomainMapFilter ( ) [virtual]

Set/Get the domain map image filter.

template<class TIdentifier, class TLevelSet>
virtual const HeavisideType* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetHeaviside ( ) [virtual]
Todo:
add documentation
template<class TIdentifier, class TLevelSet>
LevelSetPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetLevelSet ( const LevelSetIdentifierType iId) const

Get the level set function given its id.

Parameters:
[in]iId
Returns:
the level set function if it is in the container, else NULL.
template<class TIdentifier, class TLevelSet>
virtual const char* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetNameOfClass ( ) const [virtual]
template<class TIdentifier, class TLevelSet>
bool itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HasDomainMap ( ) const

Does the level set container have a domain map?

template<class TIdentifier, class TLevelSet>
void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::operator= ( const Self ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::LevelSetContainer< TIdentifier, TLevelSet >, and itk::LevelSetContainer< TIdentifier, LevelSetDenseImageBase< TImage > >.

template<class TIdentifier, class TLevelSet>
bool itk::LevelSetContainerBase< TIdentifier, TLevelSet >::RemoveLevelSet ( const LevelSetIdentifierType iId)

Remove one level set function given its id.

Parameters:
[in]iIdid of the level set function to be removed
Returns:
true if it has been removed, false if the id was not present in the container.
template<class TIdentifier, class TLevelSet>
void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::SetContainer ( const LevelSetContainerType iContainer) [protected]
template<class TIdentifier, class TLevelSet>
virtual void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::SetDomainMapFilter ( DomainMapImageFilterType _arg) [virtual]

Set/Get the domain map image filter.

template<class TIdentifier, class TLevelSet>
virtual void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::SetHeaviside ( HeavisideType _arg) [virtual]
Todo:
add documentation
template<class TIdentifier, class TLevelSet>
LevelSetIdentifierType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Size ( ) const

Friends And Related Function Documentation

template<class TIdentifier, class TLevelSet>
friend class Iterator [friend]

Definition at line 92 of file itkLevelSetContainerBase.h.


Member Data Documentation

template<class TIdentifier, class TLevelSet>
const unsigned int itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Dimension = LevelSetType::Dimension [static]
template<class TIdentifier, class TLevelSet>
LevelSetContainerType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_Container [private]

Definition at line 291 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
DomainMapImageFilterPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_DomainMapFilter [private]

Definition at line 290 of file itkLevelSetContainerBase.h.

template<class TIdentifier, class TLevelSet>
HeavisideConstPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_Heaviside [private]

Definition at line 289 of file itkLevelSetContainerBase.h.


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