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

#include <itkLevelSetContainerBase.h>

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

Detailed Description

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

Container of level set.

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

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.

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 Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

bool AddLevelSet (const LevelSetIdentifierType &iId, LevelSetType *iLevelSet, const bool iForce=true)
 
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
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 (const HeavisideType *_arg)
 
virtual const HeavisideTypeGetHeaviside () const
 
virtual void SetDomainMapFilter (DomainMapImageFilterType *_arg)
 
virtual DomainMapImageFilterTypeGetModifiableDomainMapFilter ()
 
virtual const
DomainMapImageFilterType
GetDomainMapFilter () const
 
- Public Member Functions inherited from itk::Object
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 Attributes

static const unsigned int Dimension = LevelSetType::Dimension
 

Protected Member Functions

const LevelSetContainerTypeGetContainer () const
 
 LevelSetContainerBase ()
 
void SetContainer (const LevelSetContainerType &iContainer)
 
 ~LevelSetContainerBase ()
 
- Protected Member Functions inherited from itk::Object
 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

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

Private Attributes

LevelSetContainerType m_Container
 
DomainMapImageFilterPointer m_DomainMapFilter
 
HeavisideConstPointer m_Heaviside
 

Friends

class Iterator
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
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 Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TIdentifier, typename TLevelSet>
typedef Image< short, Dimension > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::CacheImageType

Definition at line 79 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef SmartPointer< const Self > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::ConstPointer

Definition at line 47 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef std::map< LevelSetIdentifierType, LevelSetDomainType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainContainerType

Definition at line 88 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef DomainContainerType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainIteratorType

Definition at line 89 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef DomainMapImageFilterType::Pointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainMapImageFilterPointer

Definition at line 85 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetDomainMapImageFilter< IdListImageType, CacheImageType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::DomainMapImageFilterType

Definition at line 81 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetType::GradientType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GradientType

Definition at line 59 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef HeavisideType::ConstPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HeavisideConstPointer

Definition at line 71 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef HeavisideStepFunctionBase< OutputRealType, OutputRealType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HeavisideType

Definition at line 70 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetType::HessianType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HessianType

Definition at line 60 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef IdListType::const_iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListConstIterator

Definition at line 77 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef Image< IdListType, Dimension > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListImageType

Definition at line 78 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef IdListType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListIterator

Definition at line 76 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef std::list< LevelSetIdentifierType > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::IdListType

Definition at line 75 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetType::InputType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::InputIndexType

Definition at line 56 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetContainerType::const_iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerConstIteratorType

Definition at line 67 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetContainerType::iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerIteratorType

Definition at line 68 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef std::map< LevelSetIdentifierType, LevelSetPointer > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerType

Definition at line 66 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetType::LevelSetDataType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetDataType

Definition at line 61 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef DomainMapImageFilterType::LevelSetDomain itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetDomainType

Definition at line 86 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef TIdentifier itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetIdentifierType

IdentifierType

Definition at line 64 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef std::pair< LevelSetIdentifierType, LevelSetPointer > itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetPairType

Definition at line 83 of file itkLevelSetContainerBase.h.

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

Definition at line 55 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef TLevelSet itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetType

typedefs related to the type of level set

Definition at line 51 of file itkLevelSetContainerBase.h.

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

Definition at line 58 of file itkLevelSetContainerBase.h.

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

Definition at line 57 of file itkLevelSetContainerBase.h.

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

Definition at line 46 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
typedef LevelSetContainerBase itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Self

Definition at line 45 of file itkLevelSetContainerBase.h.

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

Definition at line 48 of file itkLevelSetContainerBase.h.

Constructor & Destructor Documentation

template<typename TIdentifier, typename TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerBase ( )
protected

Default Constructor.

template<typename TIdentifier, typename TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::~LevelSetContainerBase ( )
protected

Default Destructor.

template<typename TIdentifier, typename TLevelSet>
itk::LevelSetContainerBase< TIdentifier, TLevelSet >::LevelSetContainerBase ( const Self )
private

Member Function Documentation

template<typename TIdentifier, typename 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<typename TIdentifier, typename TLevelSet>
Iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Begin ( )
template<typename TIdentifier, typename TLevelSet>
ConstIterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Begin ( ) const
template<typename TIdentifier, typename TLevelSet>
Iterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::End ( )
template<typename TIdentifier, typename TLevelSet>
ConstIterator itk::LevelSetContainerBase< TIdentifier, TLevelSet >::End ( ) const
template<typename TIdentifier, typename TLevelSet>
const LevelSetContainerType& itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetContainer ( ) const
protected
template<typename TIdentifier, typename TLevelSet>
virtual const DomainMapImageFilterType* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetDomainMapFilter ( ) const
virtual

Set/Get the domain map image filter.

template<typename TIdentifier, typename TLevelSet>
virtual const HeavisideType* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetHeaviside ( ) const
virtual
Todo:
add documentation
template<typename TIdentifier, typename 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 ITK_NULLPTR.
template<typename TIdentifier, typename TLevelSet>
virtual DomainMapImageFilterType* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetModifiableDomainMapFilter ( )
virtual

Set/Get the domain map image filter.

template<typename TIdentifier, typename TLevelSet>
virtual const char* itk::LevelSetContainerBase< TIdentifier, TLevelSet >::GetNameOfClass ( ) const
virtual
template<typename TIdentifier, typename TLevelSet>
bool itk::LevelSetContainerBase< TIdentifier, TLevelSet >::HasDomainMap ( ) const

Does the level set container have a domain map?

template<typename TIdentifier, typename TLevelSet>
void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::operator= ( const Self )
private
template<typename TIdentifier, typename 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<typename TIdentifier, typename TLevelSet>
void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::SetContainer ( const LevelSetContainerType iContainer)
protected
template<typename TIdentifier, typename TLevelSet>
virtual void itk::LevelSetContainerBase< TIdentifier, TLevelSet >::SetDomainMapFilter ( DomainMapImageFilterType _arg)
virtual

Set/Get the domain map image filter.

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

Get the number of LevelSets in the container.

Friends And Related Function Documentation

template<typename TIdentifier, typename TLevelSet>
friend class Iterator
friend

Definition at line 92 of file itkLevelSetContainerBase.h.

Member Data Documentation

template<typename TIdentifier, typename TLevelSet>
const unsigned int itk::LevelSetContainerBase< TIdentifier, TLevelSet >::Dimension = LevelSetType::Dimension
static

Definition at line 73 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
LevelSetContainerType itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_Container
private

Definition at line 292 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
DomainMapImageFilterPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_DomainMapFilter
private

Definition at line 291 of file itkLevelSetContainerBase.h.

template<typename TIdentifier, typename TLevelSet>
HeavisideConstPointer itk::LevelSetContainerBase< TIdentifier, TLevelSet >::m_Heaviside
private

Definition at line 290 of file itkLevelSetContainerBase.h.


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