itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > > Class Template Reference

#include <itkLevelSetEvolution.h>

Detailed Description

template<typename TEquationContainer, typename TImage>
class itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >

Definition at line 52 of file itkLevelSetEvolution.h.

Inheritance diagram for itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >:

Collaboration diagram for itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	InputImageConstIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >
using	LevelSetImageConstIteratorType = ImageRegionConstIteratorWithIndex< LevelSetImageType >
using	LevelSetImageIteratorType = ImageRegionIteratorWithIndex< LevelSetImageType >
using	LevelSetImageType = typename LevelSetType::ImageType
using	LevelSetType = LevelSetDenseImage< TImage >
using	MaurerPointer = typename MaurerType::Pointer
using	MaurerType = SignedMaurerDistanceMapImageFilter< LevelSetImageType, LevelSetImageType >
using	Pointer = SmartPointer< Self >
using	Self = LevelSetEvolution
using	Superclass = LevelSetEvolutionBase< TEquationContainer, LevelSetType >
using	ThresholdFilterPointer = typename ThresholdFilterType::Pointer
using	ThresholdFilterType = BinaryThresholdImageFilter< LevelSetImageType, LevelSetImageType >
Public Types inherited from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
using	CacheImageType = typename LevelSetContainerType::CacheImageType
using	ConstPointer = SmartPointer< const Self >
using	DomainMapImageFilterType = typename LevelSetContainerType::DomainMapImageFilterType
using	EquationContainerPointer = typename EquationContainerType::Pointer
using	EquationContainerType = TEquationContainer
using	IdListConstIterator = typename LevelSetContainerType::IdListConstIterator
using	IdListImageType = typename LevelSetContainerType::IdListImageType
using	IdListIterator = typename LevelSetContainerType::IdListIterator
using	IdListType = typename LevelSetContainerType::IdListType
using	InputImageConstPointer = typename InputImageType::ConstPointer
using	InputImagePixelType = typename InputImageType::PixelType
using	InputImageRegionType = typename InputImageType::RegionType
using	InputImageType = typename TermContainerType::InputImageType
using	InputPixelRealType = typename NumericTraits< InputImagePixelType >::RealType
using	LevelSetContainerType = typename TermContainerType::LevelSetContainerType
using	LevelSetDataType = typename LevelSetType::LevelSetDataType
using	LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType
using	LevelSetInputType = typename LevelSetType::InputType
using	LevelSetOutputRealType = typename LevelSetType::OutputRealType
using	LevelSetOutputType = typename LevelSetType::OutputType
using	LevelSetType = LevelSetDenseImage< TImage >
using	Pointer = SmartPointer< Self >
using	Self = LevelSetEvolutionBase
using	StoppingCriterionPointer = typename StoppingCriterionType::Pointer
using	StoppingCriterionType = LevelSetEvolutionStoppingCriterion< LevelSetContainerType >
using	Superclass = Object
using	TermContainerPointer = typename TermContainerType::Pointer
using	TermContainerType = typename EquationContainerType::TermContainerType
using	TermPointer = typename TermType::Pointer
using	TermType = typename TermContainerType::TermType
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
const char *	GetNameOfClass () const override
ThreadIdType	GetNumberOfWorkUnits () const
void	SetNumberOfWorkUnits (const ThreadIdType numberOfThreads)
	~LevelSetEvolution () override=default
Public Member Functions inherited from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()
const char *	GetNameOfClass () const override
virtual IdentifierType	GetNumberOfIterations () const
virtual void	SetLevelSetContainer (LevelSetContainerType *_arg)
void	SetTimeStep (const LevelSetOutputRealType &iDt)
void	Update ()
virtual void	SetAlpha (LevelSetOutputRealType _arg)
virtual LevelSetOutputRealType	GetAlpha ()
virtual void	SetEquationContainer (EquationContainerType *_arg)
virtual EquationContainerType *	GetModifiableEquationContainer ()
virtual void	SetStoppingCriterion (StoppingCriterionType *_arg)
virtual StoppingCriterionType *	GetModifiableStoppingCriterion ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) 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
const char *	GetNameOfClass () const override
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) const
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 Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

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 val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
static constexpr unsigned int	ImageDimension

Protected Types
using	DomainMapConstIteratorType = typename DomainMapImageFilterType::DomainMapType::const_iterator
using	SplitDomainMapComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >
using	SplitLevelSetComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >
using	SplitLevelSetUpdateLevelSetsThreaderType = LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >
using	ThreadedDomainMapPartitionerType = ThreadedIteratorRangePartitioner< DomainMapConstIteratorType >

Protected Member Functions
void	AllocateUpdateBuffer () override
void	ComputeIteration () override
void	ComputeTimeStepForNextIteration () override
	LevelSetEvolution ()
void	ReinitializeToSignedDistance ()
void	UpdateEquations () override
void	UpdateLevelSets () override
Protected Member Functions inherited from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
virtual void	AllocateUpdateBuffer ()
void	CheckSetUp ()
virtual void	ComputeIteration ()
virtual void	ComputeTimeStepForNextIteration ()
void	Evolve ()
void	InitializeIteration ()
	LevelSetEvolutionBase ()
virtual void	UpdateEquations ()=0
virtual void	UpdateLevelSets ()=0
	~LevelSetEvolutionBase () 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 &timeStamp)
	~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	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
const IdListType *	m_IdListToProcessWhenThreading {}
SplitDomainMapComputeIterationThreaderType::Pointer	m_SplitDomainMapComputeIterationThreader {}
SplitLevelSetComputeIterationThreaderType::Pointer	m_SplitLevelSetComputeIterationThreader {}
SplitLevelSetUpdateLevelSetsThreaderType::Pointer	m_SplitLevelSetUpdateLevelSetsThreader {}
LevelSetContainerType::Pointer	m_UpdateBuffer {}
Protected Attributes inherited from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
LevelSetOutputRealType	m_Alpha
LevelSetOutputRealType	m_Dt
EquationContainerPointer	m_EquationContainer
LevelSetContainerType::Pointer	m_LevelSetContainer
LevelSetContainerType::Iterator	m_LevelSetContainerIteratorToProcessWhenThreading
LevelSetContainerType::Iterator	m_LevelSetUpdateContainerIteratorToProcessWhenThreading
IdentifierType	m_NumberOfIterations
LevelSetOutputRealType	m_RMSChangeAccumulator
StoppingCriterionPointer	m_StoppingCriterion
bool	m_UserGloballyDefinedTimeStep
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Friends
class	LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >
class	LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >
class	LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >

Member Typedef Documentation

ConstPointer

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ConstPointer = SmartPointer<const Self>

Definition at line 62 of file itkLevelSetEvolution.h.

DomainMapConstIteratorType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::DomainMapConstIteratorType = typename DomainMapImageFilterType::DomainMapType::const_iterator

protected

Definition at line 168 of file itkLevelSetEvolution.h.

InputImageConstIteratorType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::InputImageConstIteratorType = ImageRegionConstIteratorWithIndex<InputImageType>

Definition at line 117 of file itkLevelSetEvolution.h.

LevelSetImageConstIteratorType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::LevelSetImageConstIteratorType = ImageRegionConstIteratorWithIndex<LevelSetImageType>

Definition at line 115 of file itkLevelSetEvolution.h.

LevelSetImageIteratorType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::LevelSetImageIteratorType = ImageRegionIteratorWithIndex<LevelSetImageType>

Definition at line 113 of file itkLevelSetEvolution.h.

LevelSetImageType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::LevelSetImageType = typename LevelSetType::ImageType

Definition at line 91 of file itkLevelSetEvolution.h.

LevelSetType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::LevelSetType = LevelSetDenseImage<TImage>

Definition at line 58 of file itkLevelSetEvolution.h.

MaurerPointer

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::MaurerPointer = typename MaurerType::Pointer

Definition at line 111 of file itkLevelSetEvolution.h.

MaurerType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::MaurerType = SignedMaurerDistanceMapImageFilter<LevelSetImageType, LevelSetImageType>

Definition at line 110 of file itkLevelSetEvolution.h.

Pointer

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::Pointer = SmartPointer<Self>

Definition at line 61 of file itkLevelSetEvolution.h.

Self

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::Self = LevelSetEvolution

Definition at line 60 of file itkLevelSetEvolution.h.

SplitDomainMapComputeIterationThreaderType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::SplitDomainMapComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader<LevelSetType, ThreadedDomainMapPartitionerType, Self>

protected

Definition at line 171 of file itkLevelSetEvolution.h.

SplitLevelSetComputeIterationThreaderType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::SplitLevelSetComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader<LevelSetType, ThreadedImageRegionPartitioner<TImage::ImageDimension>, Self>

protected

Definition at line 162 of file itkLevelSetEvolution.h.

SplitLevelSetUpdateLevelSetsThreaderType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::SplitLevelSetUpdateLevelSetsThreaderType = LevelSetEvolutionUpdateLevelSetsThreader<LevelSetType, ThreadedImageRegionPartitioner<TImage::ImageDimension>, Self>

protected

Definition at line 178 of file itkLevelSetEvolution.h.

Superclass

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::Superclass = LevelSetEvolutionBase<TEquationContainer, LevelSetType>

Definition at line 63 of file itkLevelSetEvolution.h.

ThreadedDomainMapPartitionerType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ThreadedDomainMapPartitionerType = ThreadedIteratorRangePartitioner<DomainMapConstIteratorType>

protected

Definition at line 169 of file itkLevelSetEvolution.h.

ThresholdFilterPointer

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ThresholdFilterPointer = typename ThresholdFilterType::Pointer

Definition at line 108 of file itkLevelSetEvolution.h.

ThresholdFilterType

template<typename TEquationContainer , typename TImage >

using itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ThresholdFilterType = BinaryThresholdImageFilter<LevelSetImageType, LevelSetImageType>

Definition at line 107 of file itkLevelSetEvolution.h.

Constructor & Destructor Documentation

~LevelSetEvolution()

template<typename TEquationContainer , typename TImage >

itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::~LevelSetEvolution ( )

overridedefault

LevelSetEvolution()

template<typename TEquationContainer , typename TImage >

itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::LevelSetEvolution ( )

protected

Member Function Documentation

AllocateUpdateBuffer()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::AllocateUpdateBuffer ( )

overrideprotectedvirtual

Initialize the update buffers for all level sets to hold the updates of equations in each iteration

Reimplemented from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >.

ComputeIteration()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ComputeIteration ( )

overrideprotectedvirtual

Computer the update at each pixel and store in the update buffer

Reimplemented from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >.

ComputeTimeStepForNextIteration()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ComputeTimeStepForNextIteration ( )

overrideprotectedvirtual

Compute the time-step for the next iteration

Reimplemented from itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >.

GetNameOfClass()

template<typename TEquationContainer , typename TImage >

const char * itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::Object.

GetNumberOfWorkUnits()

template<typename TEquationContainer , typename TImage >

ThreadIdType itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::GetNumberOfWorkUnits

(

)

const

Set the maximum number of threads to be used.

New()

template<typename TEquationContainer , typename TImage >

static Pointer itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::New ( )

static

Method for creation through object factory

ReinitializeToSignedDistance()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ReinitializeToSignedDistance ( )

protected

Reinitialize the level set functions to a signed distance function

SetNumberOfWorkUnits()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::SetNumberOfWorkUnits

(

const ThreadIdType

numberOfThreads

)

Set the maximum number of threads to be used.

UpdateEquations()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::UpdateEquations ( )

overrideprotectedvirtual

Update the equations at the end of 1 iteration

Implements itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >.

UpdateLevelSets()

template<typename TEquationContainer , typename TImage >

void itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::UpdateLevelSets ( )

overrideprotectedvirtual

Update the levelset by 1 iteration from the computed updates

Implements itk::LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >.

Friends And Related Function Documentation

LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >

template<typename TEquationContainer , typename TImage >

friend class LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >

friend

Definition at line 166 of file itkLevelSetEvolution.h.

LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >

template<typename TEquationContainer , typename TImage >

friend class LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >

friend

Definition at line 157 of file itkLevelSetEvolution.h.

LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >

template<typename TEquationContainer , typename TImage >

friend class LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >

friend

Definition at line 173 of file itkLevelSetEvolution.h.

Member Data Documentation

ImageDimension

template<typename TEquationContainer , typename TImage >

constexpr unsigned int itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Definition at line 85 of file itkLevelSetEvolution.h.

m_IdListToProcessWhenThreading

template<typename TEquationContainer , typename TImage >

const IdListType* itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::m_IdListToProcessWhenThreading {}

protected

Helper variable for threading.

Definition at line 185 of file itkLevelSetEvolution.h.

m_SplitDomainMapComputeIterationThreader

template<typename TEquationContainer , typename TImage >

SplitDomainMapComputeIterationThreaderType::Pointer itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::m_SplitDomainMapComputeIterationThreader {}

protected

Definition at line 173 of file itkLevelSetEvolution.h.

m_SplitLevelSetComputeIterationThreader

template<typename TEquationContainer , typename TImage >

SplitLevelSetComputeIterationThreaderType::Pointer itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::m_SplitLevelSetComputeIterationThreader {}

protected

Definition at line 166 of file itkLevelSetEvolution.h.

m_SplitLevelSetUpdateLevelSetsThreader

template<typename TEquationContainer , typename TImage >

SplitLevelSetUpdateLevelSetsThreaderType::Pointer itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::m_SplitLevelSetUpdateLevelSetsThreader {}

protected

Definition at line 182 of file itkLevelSetEvolution.h.

m_UpdateBuffer

template<typename TEquationContainer , typename TImage >

LevelSetContainerType::Pointer itk::LevelSetEvolution< TEquationContainer, LevelSetDenseImage< TImage > >::m_UpdateBuffer {}

protected

Definition at line 157 of file itkLevelSetEvolution.h.

---

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

• itkLevelSetEvolution.h