ITK  5.0.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer > Class Template Reference

#include <itkLevelSetEquationTermContainer.h>

+ Inheritance diagram for itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >:
+ Collaboration diagram for itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >:

Detailed Description

template<typename TInputImage, typename TLevelSetContainer>
class itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >

Class for container holding the terms of a given level set update equation.

Template Parameters
TInputImageInput image or speed image or feature image for segmentation
TLevelSetContainerContainer holding the all the level set functions
Examples:
SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, and SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx.

Definition at line 43 of file itkLevelSetEquationTermContainer.h.

Classes

class  ConstIterator
 
class  Iterator
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using LevelSetContainerPointer = typename LevelSetContainerType::Pointer
 
using LevelSetContainerType = TLevelSetContainer
 
using LevelSetDataType = typename LevelSetContainerType::LevelSetDataType
 
using LevelSetGradientType = typename LevelSetContainerType::GradientType
 
using LevelSetHessianType = typename LevelSetContainerType::HessianType
 
using LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType
 
using LevelSetInputIndexType = typename LevelSetContainerType::InputIndexType
 
using LevelSetOutputPixelType = typename LevelSetContainerType::OutputType
 
using LevelSetOutputRealType = typename LevelSetContainerType::OutputRealType
 
using LevelSetPointer = typename LevelSetContainerType::LevelSetPointer
 
using LevelSetType = typename LevelSetContainerType::LevelSetType
 
using Pointer = SmartPointer< Self >
 
using Self = LevelSetEquationTermContainer
 
using Superclass = Object
 
using TermIdType = unsigned int
 
using TermPointer = typename TermType::Pointer
 
using TermType = LevelSetEquationTermBase< InputImageType, LevelSetContainerType >
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void AddTerm (const TermIdType &iId, TermType *iTerm)
 
Iterator Begin ()
 
ConstIterator Begin () const
 
LevelSetOutputRealType ComputeCFLContribution () const
 
void ComputeRequiredData (const LevelSetInputIndexType &iP, LevelSetDataType &ioData)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
Iterator End ()
 
ConstIterator End () const
 
LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP)
 
LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)
 
virtual LevelSetIdentifierType GetCurrentLevelSetId ()
 
virtual const
LevelSetContainerType
GetLevelSetContainer () const
 
virtual LevelSetContainerTypeGetModifiableLevelSetContainer ()
 
virtual const char * GetNameOfClass () const
 
TermTypeGetTerm (const TermIdType &iId)
 
TermTypeGetTerm (const std::string &iName)
 
void Initialize (const LevelSetInputIndexType &iP)
 
void InitializeParameters ()
 
void PushTerm (TermType *iTerm)
 
virtual void SetCurrentLevelSetId (LevelSetIdentifierType _arg)
 
virtual void SetLevelSetContainer (LevelSetContainerType *_arg)
 
void Update ()
 
void UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue)
 
virtual void SetInput (InputImageType *_arg)
 
virtual InputImageTypeGetModifiableInput ()
 
virtual const InputImageTypeGetInput () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 Member Functions

static Pointer New ()
 
- 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 Types

using HashMapStringTermContainerType = itksys::hash_map< std::string, TermPointer >
 
using MapCFLContainerConstIterator = typename MapCFLContainerType::const_iterator
 
using MapCFLContainerIterator = typename MapCFLContainerType::iterator
 
using MapCFLContainerType = std::map< TermIdType, LevelSetOutputRealType >
 
using MapTermContainerConstIteratorType = typename MapTermContainerType::const_iterator
 
using MapTermContainerIteratorType = typename MapTermContainerType::iterator
 
using MapTermContainerType = std::map< TermIdType, TermPointer >
 
using RequiredDataType = typename TermType::RequiredDataType
 

Protected Member Functions

 LevelSetEquationTermContainer ()
 
 ~LevelSetEquationTermContainer () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~Object () override
 
- 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 ()
 

Protected Attributes

MapTermContainerType m_Container
 
LevelSetIdentifierType m_CurrentLevelSetId
 
InputImagePointer m_Input
 
LevelSetContainerPointer m_LevelSetContainer
 
HashMapStringTermContainerType m_NameContainer
 
RequiredDataType m_RequiredData
 
MapCFLContainerType m_TermContribution
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Friends

class Iterator
 

Member Typedef Documentation

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::ConstPointer = SmartPointer< const Self >

Definition at line 50 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::HashMapStringTermContainerType = itksys::hash_map< std::string, TermPointer >
protected

Definition at line 283 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::InputImagePointer = typename InputImageType::Pointer

Definition at line 63 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::InputImageType = TInputImage

Definition at line 62 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetContainerPointer = typename LevelSetContainerType::Pointer

Definition at line 66 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetContainerType = TLevelSetContainer

Definition at line 65 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetDataType = typename LevelSetContainerType::LevelSetDataType

Definition at line 74 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetGradientType = typename LevelSetContainerType::GradientType

Definition at line 76 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetHessianType = typename LevelSetContainerType::HessianType

Definition at line 77 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType

Definition at line 71 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetInputIndexType = typename LevelSetContainerType::InputIndexType

Definition at line 75 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetOutputPixelType = typename LevelSetContainerType::OutputType

Definition at line 72 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetOutputRealType = typename LevelSetContainerType::OutputRealType

Definition at line 73 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetPointer = typename LevelSetContainerType::LevelSetPointer

Definition at line 69 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetType = typename LevelSetContainerType::LevelSetType

Definition at line 68 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapCFLContainerConstIterator = typename MapCFLContainerType::const_iterator
protected

Definition at line 294 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapCFLContainerIterator = typename MapCFLContainerType::iterator
protected

Definition at line 293 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapCFLContainerType = std::map< TermIdType, LevelSetOutputRealType >
protected

Definition at line 292 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapTermContainerConstIteratorType = typename MapTermContainerType::const_iterator
protected

Definition at line 136 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapTermContainerIteratorType = typename MapTermContainerType::iterator
protected

Definition at line 135 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::MapTermContainerType = std::map< TermIdType, TermPointer >
protected

Definition at line 134 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Pointer = SmartPointer< Self >

Definition at line 49 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::RequiredDataType = typename TermType::RequiredDataType
protected

Definition at line 287 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Self = LevelSetEquationTermContainer

Definition at line 48 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Superclass = Object

Definition at line 51 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::TermIdType = unsigned int

Definition at line 60 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::TermPointer = typename TermType::Pointer

Definition at line 81 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
using itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::TermType = LevelSetEquationTermBase< InputImageType, LevelSetContainerType >

Definition at line 80 of file itkLevelSetEquationTermContainer.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TLevelSetContainer >
itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::LevelSetEquationTermContainer ( )
protected
template<typename TInputImage , typename TLevelSetContainer >
itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::~LevelSetEquationTermContainer ( )
overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::AddTerm ( const TermIdType iId,
TermType iTerm 
)

Replace the pointer to the term with the given id

template<typename TInputImage , typename TLevelSetContainer >
Iterator itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Begin ( )
template<typename TInputImage , typename TLevelSetContainer >
ConstIterator itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Begin ( ) const
template<typename TInputImage , typename TLevelSetContainer >
LevelSetOutputRealType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::ComputeCFLContribution ( ) const

Return the CFL contribution of the current term

template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::ComputeRequiredData ( const LevelSetInputIndexType iP,
LevelSetDataType ioData 
)
template<typename TInputImage , typename TLevelSetContainer >
virtual::itk::LightObject::Pointer itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::CreateAnother ( ) const
virtual

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

template<typename TInputImage , typename TLevelSetContainer >
Iterator itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::End ( )
template<typename TInputImage , typename TLevelSetContainer >
ConstIterator itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::End ( ) const
template<typename TInputImage , typename TLevelSetContainer >
LevelSetOutputRealType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Evaluate ( const LevelSetInputIndexType iP)

Evaluate the term at a given pixel location

template<typename TInputImage , typename TLevelSetContainer >
LevelSetOutputRealType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Evaluate ( const LevelSetInputIndexType iP,
const LevelSetDataType iData 
)
template<typename TInputImage , typename TLevelSetContainer >
virtual LevelSetIdentifierType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetCurrentLevelSetId ( )
virtual
template<typename TInputImage , typename TLevelSetContainer >
virtual const InputImageType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetInput ( ) const
virtual

Set/Get the input image to be segmented.

template<typename TInputImage , typename TLevelSetContainer >
virtual const LevelSetContainerType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetLevelSetContainer ( ) const
virtual
template<typename TInputImage , typename TLevelSetContainer >
virtual InputImageType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetModifiableInput ( )
virtual

Set/Get the input image to be segmented.

template<typename TInputImage , typename TLevelSetContainer >
virtual LevelSetContainerType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetModifiableLevelSetContainer ( )
virtual
template<typename TInputImage , typename TLevelSetContainer >
virtual const char* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetNameOfClass ( ) const
virtual

Run-time type information

Reimplemented from itk::Object.

template<typename TInputImage , typename TLevelSetContainer >
TermType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetTerm ( const TermIdType iId)

Get the term with the given id

template<typename TInputImage , typename TLevelSetContainer >
TermType* itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::GetTerm ( const std::string &  iName)

Get the term with the given name

template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Initialize ( const LevelSetInputIndexType iP)
template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::InitializeParameters ( )

Initialize the term parameters prior to the start of an iteration

template<typename TInputImage , typename TLevelSetContainer >
static Pointer itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::New ( )
static

Method for creation through object factory

template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::PushTerm ( TermType iTerm)

Add a term to the end of the container

template<typename TInputImage , typename TLevelSetContainer >
virtual void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::SetCurrentLevelSetId ( LevelSetIdentifierType  _arg)
virtual
template<typename TInputImage , typename TLevelSetContainer >
virtual void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::SetInput ( InputImageType _arg)
virtual

Set/Get the input image to be segmented.

template<typename TInputImage , typename TLevelSetContainer >
virtual void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::SetLevelSetContainer ( LevelSetContainerType _arg)
virtual
template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::Update ( )

Update the term parameters at end of iteration

template<typename TInputImage , typename TLevelSetContainer >
void itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::UpdatePixel ( const LevelSetInputIndexType iP,
const LevelSetOutputRealType oldValue,
const LevelSetOutputRealType newValue 
)

Supply the update at a given pixel location to update the term parameters

Friends And Related Function Documentation

template<typename TInputImage , typename TLevelSetContainer >
friend class Iterator
friend

Definition at line 139 of file itkLevelSetEquationTermContainer.h.

Member Data Documentation

template<typename TInputImage , typename TLevelSetContainer >
MapTermContainerType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_Container
protected

Definition at line 290 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
LevelSetIdentifierType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_CurrentLevelSetId
protected

Definition at line 278 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
InputImagePointer itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_Input
protected

Definition at line 281 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
LevelSetContainerPointer itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_LevelSetContainer
protected

Definition at line 279 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
HashMapStringTermContainerType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_NameContainer
protected

Definition at line 285 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
RequiredDataType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_RequiredData
protected

Definition at line 288 of file itkLevelSetEquationTermContainer.h.

template<typename TInputImage , typename TLevelSetContainer >
MapCFLContainerType itk::LevelSetEquationTermContainer< TInputImage, TLevelSetContainer >::m_TermContribution
protected

Definition at line 296 of file itkLevelSetEquationTermContainer.h.


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