ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer > Class Template Referenceabstract
Group Segmentation » Module ITKLevelSetsv4

#include <itkLevelSetEquationTermBase.h>

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

Public Types

using CacheImageType = typename LevelSetContainerType::CacheImageType
 
using ConstPointer = SmartPointer< const Self >
 
using DomainMapImageFilterType = typename LevelSetContainerType::DomainMapImageFilterType
 
using HeavisideConstPointer = typename HeavisideType::ConstPointer
 
using HeavisideType = HeavisideStepFunctionBase< LevelSetOutputRealType, LevelSetOutputRealType >
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputPixelRealType = typename NumericTraits< InputPixelType >::RealType
 
using InputPixelType = typename InputImageType::PixelType
 
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 = LevelSetEquationTermBase
 
using Superclass = Object
 
- 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

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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 noexcept override
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
using RequiredDataType = std::unordered_set< std::string >
 
InputImagePointer m_Input
 
LevelSetContainerPointer m_LevelSetContainer
 
LevelSetIdentifierType m_CurrentLevelSetId
 
LevelSetPointer m_CurrentLevelSetPointer
 
LevelSetOutputRealType m_Coefficient
 
LevelSetOutputRealType m_CFLContribution
 
HeavisideConstPointer m_Heaviside
 
std::string m_TermName
 
RequiredDataType m_RequiredData
 
virtual void SetInput (InputImageType *_arg)
 
virtual InputImageType * GetModifiableInput ()
 
virtual const InputImageType * GetInput () const
 
virtual void SetCoefficient (LevelSetOutputRealType _arg)
 
virtual LevelSetOutputRealType GetCoefficient ()
 
virtual void SetCurrentLevelSetId (LevelSetIdentifierType _arg)
 
virtual LevelSetIdentifierType GetCurrentLevelSetId ()
 
virtual LevelSetType * GetModifiableCurrentLevelSetPointer ()
 
virtual const LevelSetType * GetCurrentLevelSetPointer () const
 
virtual void SetLevelSetContainer (LevelSetContainerType *iContainer)
 
virtual LevelSetContainerType * GetModifiableLevelSetContainer ()
 
virtual const LevelSetContainerType * GetLevelSetContainer () const
 
virtual LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP)
 
virtual LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)
 
virtual void Initialize (const LevelSetInputIndexType &iP)=0
 
virtual void InitializeParameters ()=0
 
virtual void UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue)=0
 
virtual LevelSetOutputRealType GetCFLContribution () const
 
virtual void SetTermName (const char *_arg)
 
virtual const char * GetTermName () const
 
virtual void Update ()=0
 
const RequiredDataType & GetRequiredData () const
 
 LevelSetEquationTermBase ()
 
 ~LevelSetEquationTermBase () override=default
 
void SetUp ()
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &iP)=0
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)=0
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

Abstract class to represents a term in the level-set evolution PDE.

Template Parameters
TInputInput Image Type
TLevelSetContainerLevel set function container type

Evolving single level-set function $ \phi $ can be expressed as follows:

\[ \frac{\partial \phi(p)}{\partial \tau} = \sum\limits_{i=1}^{N} \alpha_{i} \cdot \omega_i(p) \]

where $\omega_i$ is a term which could depend on the level-set function, the input image; and $\alpha_i$ is a weight to balance the contribution of each term in the PDE.

See also
LevelSetEquationContainer

Definition at line 49 of file itkLevelSetEquationTermBase.h.

Member Typedef Documentation

◆ CacheImageType

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

Definition at line 82 of file itkLevelSetEquationTermBase.h.

◆ ConstPointer

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

Definition at line 57 of file itkLevelSetEquationTermBase.h.

◆ DomainMapImageFilterType

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

Definition at line 81 of file itkLevelSetEquationTermBase.h.

◆ HeavisideConstPointer

template<typename TInputImage, typename TLevelSetContainer>
using itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::HeavisideConstPointer = typename HeavisideType::ConstPointer

Definition at line 86 of file itkLevelSetEquationTermBase.h.

◆ HeavisideType

template<typename TInputImage, typename TLevelSetContainer>
using itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::HeavisideType = HeavisideStepFunctionBase<LevelSetOutputRealType, LevelSetOutputRealType>

Definition at line 84 of file itkLevelSetEquationTermBase.h.

◆ InputImagePointer

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

Definition at line 64 of file itkLevelSetEquationTermBase.h.

◆ InputImageType

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

Definition at line 63 of file itkLevelSetEquationTermBase.h.

◆ InputPixelRealType

template<typename TInputImage, typename TLevelSetContainer>
using itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::InputPixelRealType = typename NumericTraits<InputPixelType>::RealType

Definition at line 66 of file itkLevelSetEquationTermBase.h.

◆ InputPixelType

template<typename TInputImage, typename TLevelSetContainer>
using itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::InputPixelType = typename InputImageType::PixelType

Definition at line 65 of file itkLevelSetEquationTermBase.h.

◆ LevelSetContainerPointer

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

Definition at line 71 of file itkLevelSetEquationTermBase.h.

◆ LevelSetContainerType

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

Level-set function container type

Definition at line 69 of file itkLevelSetEquationTermBase.h.

◆ LevelSetDataType

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

Definition at line 79 of file itkLevelSetEquationTermBase.h.

◆ LevelSetGradientType

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

Definition at line 77 of file itkLevelSetEquationTermBase.h.

◆ LevelSetHessianType

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

Definition at line 78 of file itkLevelSetEquationTermBase.h.

◆ LevelSetIdentifierType

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

Definition at line 70 of file itkLevelSetEquationTermBase.h.

◆ LevelSetInputIndexType

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

Definition at line 76 of file itkLevelSetEquationTermBase.h.

◆ LevelSetOutputPixelType

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

Definition at line 74 of file itkLevelSetEquationTermBase.h.

◆ LevelSetOutputRealType

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

Definition at line 75 of file itkLevelSetEquationTermBase.h.

◆ LevelSetPointer

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

Definition at line 73 of file itkLevelSetEquationTermBase.h.

◆ LevelSetType

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

Definition at line 72 of file itkLevelSetEquationTermBase.h.

◆ Pointer

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

Definition at line 56 of file itkLevelSetEquationTermBase.h.

◆ RequiredDataType

template<typename TInputImage, typename TLevelSetContainer>
using itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::RequiredDataType = std::unordered_set<std::string>

Input image

Definition at line 140 of file itkLevelSetEquationTermBase.h.

◆ Self

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

Definition at line 55 of file itkLevelSetEquationTermBase.h.

◆ Superclass

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

Definition at line 58 of file itkLevelSetEquationTermBase.h.

Constructor & Destructor Documentation

◆ LevelSetEquationTermBase()

template<typename TInputImage, typename TLevelSetContainer>
itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::LevelSetEquationTermBase ( )
protected

Default Constructor

◆ ~LevelSetEquationTermBase()

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

Destructor

Member Function Documentation

◆ Evaluate() [1/2]

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Evaluate ( const LevelSetInputIndexType &  iP)
virtual

Returns the weighted term contribution at the given location iP, i.e. $ \alpha_i \cdot \omega_i( p ) $

◆ Evaluate() [2/2]

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Evaluate ( const LevelSetInputIndexType &  iP,
const LevelSetDataType &  iData 
)
virtual

Input image

◆ GetCFLContribution()

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetCFLContribution ( ) const
virtual

Get the CFL contribution for the given term

◆ GetCoefficient()

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetCoefficient ( )
virtual

Input image

◆ GetCurrentLevelSetId()

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetIdentifierType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetCurrentLevelSetId ( )
virtual

Input image

◆ GetCurrentLevelSetPointer()

template<typename TInputImage, typename TLevelSetContainer>
virtual const LevelSetType* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetCurrentLevelSetPointer ( ) const
virtual

Input image

◆ GetInput()

template<typename TInputImage, typename TLevelSetContainer>
virtual const InputImageType* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetInput ( ) const
virtual

Input image

◆ GetLevelSetContainer()

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

Input image

◆ GetModifiableCurrentLevelSetPointer()

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetType* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetModifiableCurrentLevelSetPointer ( )
virtual

Input image

◆ GetModifiableInput()

template<typename TInputImage, typename TLevelSetContainer>
virtual InputImageType* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetModifiableInput ( )
virtual

Input image

◆ GetModifiableLevelSetContainer()

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetContainerType* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetModifiableLevelSetContainer ( )
virtual

Input image

◆ GetNameOfClass()

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

Run-time type information

Reimplemented from itk::Object.

Reimplemented in itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationCurvatureTerm< TInput, TLevelSetContainer, TCurvatureImage >, itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >, itk::LevelSetEquationLaplacianTerm< TInput, TLevelSetContainer >, and itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >.

◆ GetRequiredData()

template<typename TInputImage, typename TLevelSetContainer>
const RequiredDataType& itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetRequiredData ( ) const

Input image

◆ GetTermName()

template<typename TInputImage, typename TLevelSetContainer>
virtual const char* itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::GetTermName ( ) const
virtual

Input image

◆ Initialize()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Initialize ( const LevelSetInputIndexType &  iP)
pure virtual
Todo:
to be documented.

◆ InitializeParameters()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::InitializeParameters ( )
pure virtual

Initialize the parameters in the terms prior to an iteration

Implemented in itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationCurvatureTerm< TInput, TLevelSetContainer, TCurvatureImage >, itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >, itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationLaplacianTerm< TInput, TLevelSetContainer >, and itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >.

◆ SetCoefficient()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::SetCoefficient ( LevelSetOutputRealType  _arg)
virtual

Input image

◆ SetCurrentLevelSetId()

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

Input image

◆ SetInput()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::SetInput ( InputImageType *  _arg)
virtual

Set/Get the image to be segmented

◆ SetLevelSetContainer()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::SetLevelSetContainer ( LevelSetContainerType *  iContainer)
virtual

Input image

◆ SetTermName()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::SetTermName ( const char *  _arg)
virtual

Set/Get the term name

◆ SetUp()

template<typename TInputImage, typename TLevelSetContainer>
void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::SetUp ( )
protected

Input image

◆ Update()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Update ( )
pure virtual

Update the term parameter values at end of iteration

Implemented in itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationCurvatureTerm< TInput, TLevelSetContainer, TCurvatureImage >, itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >, itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >, itk::LevelSetEquationLaplacianTerm< TInput, TLevelSetContainer >, and itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >.

◆ UpdatePixel()

template<typename TInputImage, typename TLevelSetContainer>
virtual void itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::UpdatePixel ( const LevelSetInputIndexType &  iP,
const LevelSetOutputRealType &  oldValue,
const LevelSetOutputRealType &  newValue 
)
pure virtual

Supply updates at pixels to keep the term parameters always updated

◆ Value() [1/2]

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Value ( const LevelSetInputIndexType &  iP)
protectedpure virtual

Returns the term contribution for a given location iP, i.e. $ \omega_i( p ) $. This method must be implemented in all class which inherits from this class.

◆ Value() [2/2]

template<typename TInputImage, typename TLevelSetContainer>
virtual LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::Value ( const LevelSetInputIndexType &  iP,
const LevelSetDataType &  iData 
)
protectedpure virtual

Input image

Member Data Documentation

◆ m_CFLContribution

template<typename TInputImage, typename TLevelSetContainer>
LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::m_CFLContribution
protected

Contribution to the CFL condition (which will be used to compute the the time step at the next iteration

Definition at line 182 of file itkLevelSetEquationTermBase.h.

◆ m_Coefficient

template<typename TInputImage, typename TLevelSetContainer>
LevelSetOutputRealType itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::m_Coefficient
protected

Coefficient $ \alpha_i $

Definition at line 177 of file itkLevelSetEquationTermBase.h.

◆ m_CurrentLevelSetId

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

Id of the current level-set function

Definition at line 172 of file itkLevelSetEquationTermBase.h.

◆ m_CurrentLevelSetPointer

template<typename TInputImage, typename TLevelSetContainer>
LevelSetPointer itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::m_CurrentLevelSetPointer
protected

Input image

Definition at line 174 of file itkLevelSetEquationTermBase.h.

◆ m_Heaviside

template<typename TInputImage, typename TLevelSetContainer>
HeavisideConstPointer itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::m_Heaviside
protected

Heaviside function to be used. Depending on the term expression, this one may need to be provided

Definition at line 187 of file itkLevelSetEquationTermBase.h.

◆ m_Input

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

Input image

Definition at line 166 of file itkLevelSetEquationTermBase.h.

◆ m_LevelSetContainer

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

Container of level-set function

Definition at line 169 of file itkLevelSetEquationTermBase.h.

◆ m_RequiredData

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

Input image

Definition at line 194 of file itkLevelSetEquationTermBase.h.

◆ m_TermName

template<typename TInputImage, typename TLevelSetContainer>
std::string itk::LevelSetEquationTermBase< TInputImage, TLevelSetContainer >::m_TermName
protected

Name to be given to the term. Note by default, one name is provided, but end-users may rename differently each term.

Definition at line 192 of file itkLevelSetEquationTermBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:27:09 for ITK by   doxygen 1.8.16