ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer > Class Template Reference

#include <itkLevelSetEquationOverlapPenaltyTerm.h>

+ Inheritance diagram for itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >:
+ Collaboration diagram for itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >:

Detailed Description

template<typename TInput, typename TLevelSetContainer>
class itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >

Class to represent the overlap penalty among many level-sets.

\[ \sum_{i \neq j } \left(H_{\epsilon}\left(\phi_j \left( p \right) \right)\right) \]

Template Parameters
TInputInput Image Type
TLevelSetContainerLevel set function container type

Definition at line 47 of file itkLevelSetEquationOverlapPenaltyTerm.h.

Public Types

typedef Superclass::CacheImageType CacheImageType
 
typedef CompensatedSummation
< LevelSetOutputRealType
CompensatedSummationType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DomainMapImageFilterType 
DomainMapImageFilterType
 
typedef
Superclass::HeavisideConstPointer 
HeavisideConstPointer
 
typedef Superclass::HeavisideType HeavisideType
 
typedef
LevelSetContainerType::IdListConstIterator 
IdListConstIterator
 
typedef
LevelSetContainerType::IdListIterator 
IdListIterator
 
typedef
LevelSetContainerType::IdListType 
IdListType
 
typedef
Superclass::InputImagePointer 
InputImagePointer
 
typedef Superclass::InputImageType InputImageType
 
typedef
Superclass::InputPixelRealType 
InputPixelRealType
 
typedef Superclass::InputPixelType InputPixelType
 
typedef
Superclass::LevelSetContainerPointer 
LevelSetContainerPointer
 
typedef
Superclass::LevelSetContainerType 
LevelSetContainerType
 
typedef
Superclass::LevelSetDataType 
LevelSetDataType
 
typedef
Superclass::LevelSetGradientType 
LevelSetGradientType
 
typedef
Superclass::LevelSetHessianType 
LevelSetHessianType
 
typedef
Superclass::LevelSetIdentifierType 
LevelSetIdentifierType
 
typedef
Superclass::LevelSetInputIndexType 
LevelSetInputIndexType
 
typedef
Superclass::LevelSetOutputPixelType 
LevelSetOutputPixelType
 
typedef
Superclass::LevelSetOutputRealType 
LevelSetOutputRealType
 
typedef Superclass::LevelSetPointer LevelSetPointer
 
typedef Superclass::LevelSetType LevelSetType
 
typedef SmartPointer< SelfPointer
 
typedef
LevelSetEquationOverlapPenaltyTerm 
Self
 
typedef
LevelSetEquationTermBase
< TInput, TLevelSetContainer > 
Superclass
 
- Public Types inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
typedef
LevelSetContainerType::CacheImageType 
CacheImageType
 
typedef SmartPointer< const SelfConstPointer
 
typedef
LevelSetContainerType::DomainMapImageFilterType 
DomainMapImageFilterType
 
typedef HeavisideType::ConstPointer HeavisideConstPointer
 
typedef
HeavisideStepFunctionBase
< LevelSetOutputRealType,
LevelSetOutputRealType
HeavisideType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef TInput InputImageType
 
typedef NumericTraits
< InputPixelType >::RealType 
InputPixelRealType
 
typedef InputImageType::PixelType InputPixelType
 
typedef
LevelSetContainerType::Pointer 
LevelSetContainerPointer
 
typedef TLevelSetContainer LevelSetContainerType
 
typedef
LevelSetContainerType::LevelSetDataType 
LevelSetDataType
 
typedef
LevelSetContainerType::GradientType 
LevelSetGradientType
 
typedef
LevelSetContainerType::HessianType 
LevelSetHessianType
 
typedef
LevelSetContainerType::LevelSetIdentifierType 
LevelSetIdentifierType
 
typedef
LevelSetContainerType::InputIndexType 
LevelSetInputIndexType
 
typedef
LevelSetContainerType::OutputType 
LevelSetOutputPixelType
 
typedef
LevelSetContainerType::OutputRealType 
LevelSetOutputRealType
 
typedef
LevelSetContainerType::LevelSetPointer 
LevelSetPointer
 
typedef
LevelSetContainerType::LevelSetType 
LevelSetType
 
typedef SmartPointer< SelfPointer
 
typedef itksys::hash_set
< std::string > 
RequiredDataType
 
typedef LevelSetEquationTermBase 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

virtual void ComputeSumTerm (const LevelSetInputIndexType &index, LevelSetOutputRealType &sum)
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
virtual void Initialize (const LevelSetInputIndexType &index) override
 
virtual void InitializeParameters () override
 
virtual void Update () override
 
virtual void UpdatePixel (const LevelSetInputIndexType &index, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue) override
 
- Public Member Functions inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
virtual LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP)
 
virtual LevelSetOutputRealType Evaluate (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)
 
virtual LevelSetOutputRealType GetCFLContribution () const
 
virtual LevelSetOutputRealType GetCoefficient ()
 
virtual LevelSetIdentifierType GetCurrentLevelSetId ()
 
virtual const LevelSetTypeGetCurrentLevelSetPointer () const
 
virtual const
LevelSetContainerType
GetLevelSetContainer () const
 
virtual LevelSetTypeGetModifiableCurrentLevelSetPointer ()
 
virtual LevelSetContainerTypeGetModifiableLevelSetContainer ()
 
const RequiredDataTypeGetRequiredData () const
 
virtual void Initialize (const LevelSetInputIndexType &iP)=0
 
virtual void SetCoefficient (LevelSetOutputRealType _arg)
 
virtual void SetCurrentLevelSetId (LevelSetIdentifierType _arg)
 
virtual void SetLevelSetContainer (LevelSetContainerType *ptr)
 
virtual void UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue)=0
 
virtual void SetInput (InputImageType *_arg)
 
virtual InputImageTypeGetModifiableInput ()
 
virtual const InputImageTypeGetInput () const
 
virtual void SetTermName (const char *_arg)
 
virtual const char * GetTermName () 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
 
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 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 Member Functions

 LevelSetEquationOverlapPenaltyTerm ()
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &index) override
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &index, const LevelSetDataType &data) override
 
virtual ~LevelSetEquationOverlapPenaltyTerm () override
 
- Protected Member Functions inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
 LevelSetEquationTermBase ()
 
void SetUp ()
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &iP)=0
 
virtual LevelSetOutputRealType Value (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)=0
 
virtual ~LevelSetEquationTermBase () override
 
- 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 () 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 ()
 

Private Attributes

CacheImageTypem_CacheImage
 
DomainMapImageFilterTypem_DomainMapImageFilter
 

Additional Inherited Members

- Protected Attributes inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
LevelSetOutputRealType m_CFLContribution
 
LevelSetOutputRealType m_Coefficient
 
LevelSetIdentifierType m_CurrentLevelSetId
 
LevelSetPointer m_CurrentLevelSetPointer
 
HeavisideConstPointer m_Heaviside
 
InputImagePointer m_Input
 
LevelSetContainerPointer m_LevelSetContainer
 
RequiredDataType m_RequiredData
 
std::string m_TermName
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::CacheImageType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::CacheImageType

Definition at line 84 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef CompensatedSummation<LevelSetOutputRealType> itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::CompensatedSummationType

Definition at line 90 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef SmartPointer< const Self > itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::ConstPointer

Definition at line 53 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::DomainMapImageFilterType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::DomainMapImageFilterType

Definition at line 83 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::HeavisideConstPointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::HeavisideConstPointer

Definition at line 79 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::HeavisideType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::HeavisideType

Definition at line 78 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef LevelSetContainerType::IdListConstIterator itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::IdListConstIterator

Definition at line 88 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef LevelSetContainerType::IdListIterator itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::IdListIterator

Definition at line 87 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef LevelSetContainerType::IdListType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::IdListType

Definition at line 86 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::InputImagePointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InputImagePointer

Definition at line 63 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::InputImageType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InputImageType

Definition at line 60 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::InputPixelRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InputPixelRealType

Definition at line 65 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::InputPixelType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InputPixelType

Definition at line 64 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetContainerPointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetContainerPointer

Definition at line 68 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetContainerType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetContainerType

Definition at line 67 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetDataType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetDataType

Definition at line 81 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetGradientType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetGradientType

Definition at line 74 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetHessianType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetHessianType

Definition at line 75 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetIdentifierType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetIdentifierType

Definition at line 76 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetInputIndexType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetInputIndexType

Definition at line 73 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetOutputPixelType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetOutputPixelType

Definition at line 71 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetOutputRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetOutputRealType

Definition at line 72 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetPointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetPointer

Definition at line 70 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef Superclass::LevelSetType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetType

Definition at line 69 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef SmartPointer< Self > itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Pointer

Definition at line 52 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef LevelSetEquationOverlapPenaltyTerm itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Self

Definition at line 51 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
typedef LevelSetEquationTermBase< TInput, TLevelSetContainer > itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Superclass

Definition at line 54 of file itkLevelSetEquationOverlapPenaltyTerm.h.

Constructor & Destructor Documentation

template<typename TInput , typename TLevelSetContainer >
itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::LevelSetEquationOverlapPenaltyTerm ( )
protected
template<typename TInput , typename TLevelSetContainer >
virtual itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::~LevelSetEquationOverlapPenaltyTerm ( )
overrideprotectedvirtual

Member Function Documentation

template<typename TInput , typename TLevelSetContainer >
virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::ComputeSumTerm ( const LevelSetInputIndexType index,
LevelSetOutputRealType sum 
)
virtual

Compute the sum of Heaviside functions in the multi-levelset cases except the current levelset

template<typename TInput , typename TLevelSetContainer >
virtual::itk::LightObject::Pointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, 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 TInput , typename TLevelSetContainer >
virtual const char* itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::GetNameOfClass ( ) const
virtual

Run-time type information

Reimplemented from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

template<typename TInput , typename TLevelSetContainer >
virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Initialize ( const LevelSetInputIndexType index)
overridevirtual

Initialize term parameters in the dense case by computing for each pixel location

template<typename TInput , typename TLevelSetContainer >
virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InitializeParameters ( )
overridevirtual

Initialize parameters in the terms prior to an iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

template<typename TInput , typename TLevelSetContainer >
static Pointer itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::New ( )
static

Method for creation through object factory

template<typename TInput , typename TLevelSetContainer >
virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Update ( )
overridevirtual

Update the term parameter values at end of iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

template<typename TInput , typename TLevelSetContainer >
virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::UpdatePixel ( const LevelSetInputIndexType index,
const LevelSetOutputRealType oldValue,
const LevelSetOutputRealType newValue 
)
overridevirtual

Supply updates at pixels to keep the term parameters always updated

template<typename TInput , typename TLevelSetContainer >
virtual LevelSetOutputRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Value ( const LevelSetInputIndexType index)
overrideprotectedvirtual

Returns the term contribution for a given location index

template<typename TInput , typename TLevelSetContainer >
virtual LevelSetOutputRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Value ( const LevelSetInputIndexType index,
const LevelSetDataType data 
)
overrideprotectedvirtual

Returns the term contribution for a given location index

Member Data Documentation

template<typename TInput , typename TLevelSetContainer >
CacheImageType* itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::m_CacheImage
private

Definition at line 129 of file itkLevelSetEquationOverlapPenaltyTerm.h.

template<typename TInput , typename TLevelSetContainer >
DomainMapImageFilterType* itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::m_DomainMapImageFilter
private

Definition at line 126 of file itkLevelSetEquationOverlapPenaltyTerm.h.


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