itk::simple::ReinitializeLevelSetImageFilter Class Reference

Reinitialize the level set to the signed distance function. More...

#include <sitkReinitializeLevelSetImageFilter.h>

Inheritance diagram for itk::simple::ReinitializeLevelSetImageFilter:

Collaboration diagram for itk::simple::ReinitializeLevelSetImageFilter:

Detailed Description

Reinitialize the level set to the signed distance function.

ReinitializeLevelSetImageFilter reinitializes the input level set to the approximated signed distance function from a particular level set. The output is a level set of the same type as the input.

For some level set algorithms, it is useful to periodically reinitialize the level set function to prevent numerical accuracy problems in computing derivatives and curvature values where level sets are densely bunched together.

This class is templated over the image type which represents the level set.

This class supports narrowbanding. If the input narrowband is provided, the algorithm will only locate the level set within the input narrowband. For the output, the reinitialize level set is only valid for a distance of OutputNarrowBandwidth / 2 of either side of the level set of interest.

Implementation of this class is based on Chapter 11 of "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Second edition, 1999.

See also

itk::simple::ReinitializeLevelSet for the procedural interface

itk::ReinitializeLevelSetImageFilter for the Doxygen on the original ITK class.

Definition at line 49 of file sitkReinitializeLevelSetImageFilter.h.

Public Types
using	PixelIDTypeList = RealPixelIDTypeList
using	Self = ReinitializeLevelSetImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)
double	GetInputNarrowBandwidth () const
double	GetLevelSetValue () const
std::string	GetName () const
bool	GetNarrowBanding () const
double	GetOutputNarrowBandwidth () const
Self &	NarrowBandingOff ()
Self &	NarrowBandingOn ()
void	NarrowBandwidth (double value)
	ReinitializeLevelSetImageFilter ()
Self &	SetInputNarrowBandwidth (double InputNarrowBandwidth)
Self &	SetLevelSetValue (double LevelSetValue)
Self &	SetNarrowBanding (bool NarrowBanding)
Self &	SetOutputNarrowBandwidth (double OutputNarrowBandwidth)
std::string	ToString () const
virtual	~ReinitializeLevelSetImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.
virtual float	GetProgress () const
	An Active Measurement of the progress of execution.
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands.
virtual	~ProcessObject ()
virtual void	DebugOn ()
virtual void	DebugOff ()
virtual bool	GetDebug () const
virtual void	SetDebug (bool debugFlag)
virtual void	SetNumberOfThreads (unsigned int n)
virtual unsigned int	GetNumberOfThreads () const
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( const Image& image1 )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image &image1)

Private Attributes
double	m_InputNarrowBandwidth {12.0}
double	m_LevelSetValue {0.0}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
bool	m_NarrowBanding {false}
double	m_OutputNarrowBandwidth {12.0}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()
static void	GlobalDefaultDebugOff ()
static void	GlobalDefaultDebugOn ()
static void	SetGlobalDefaultDebug (bool debugFlag)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.
static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.
static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.
static void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.
Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObject *	GetActiveProcess ()
virtual void	OnActiveProcessDelete ()
virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)
Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)
template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)
template<class TImageType>
static Image	CastITKToImage (TImageType *img)
static const itk::EventObject &	GetITKEventObject (EventEnum e)
template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)
static std::ostream &	ToStringHelper (std::ostream &os, const char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

MemberFunctionType

using itk::simple::ReinitializeLevelSetImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 127 of file sitkReinitializeLevelSetImageFilter.h.

PixelIDTypeList

using itk::simple::ReinitializeLevelSetImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 61 of file sitkReinitializeLevelSetImageFilter.h.

Self

using itk::simple::ReinitializeLevelSetImageFilter::Self = ReinitializeLevelSetImageFilter

Definition at line 51 of file sitkReinitializeLevelSetImageFilter.h.

Constructor & Destructor Documentation

~ReinitializeLevelSetImageFilter()

virtual itk::simple::ReinitializeLevelSetImageFilter::~ReinitializeLevelSetImageFilter ( )

virtual

Destructor

ReinitializeLevelSetImageFilter()

itk::simple::ReinitializeLevelSetImageFilter::ReinitializeLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::ReinitializeLevelSetImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

Image itk::simple::ReinitializeLevelSetImageFilter::ExecuteInternal ( const Image & image1 )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetInputNarrowBandwidth()

double itk::simple::ReinitializeLevelSetImageFilter::GetInputNarrowBandwidth ( ) const

inline

Set/Get the input narrow bandwidth. The default value is 12.

Definition at line 96 of file sitkReinitializeLevelSetImageFilter.h.

References m_InputNarrowBandwidth.

GetLevelSetValue()

double itk::simple::ReinitializeLevelSetImageFilter::GetLevelSetValue ( ) const

inline

Set/Get the value of the level set to be located. The default value is 0.

Definition at line 72 of file sitkReinitializeLevelSetImageFilter.h.

References m_LevelSetValue.

GetName()

std::string itk::simple::ReinitializeLevelSetImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 109 of file sitkReinitializeLevelSetImageFilter.h.

GetNarrowBanding()

bool itk::simple::ReinitializeLevelSetImageFilter::GetNarrowBanding ( ) const

inline

Set/Get the narrowbanding flag. By default, narrowbanding is switched off.

Definition at line 86 of file sitkReinitializeLevelSetImageFilter.h.

References m_NarrowBanding.

GetOutputNarrowBandwidth()

double itk::simple::ReinitializeLevelSetImageFilter::GetOutputNarrowBandwidth ( ) const

inline

Set/Get the output narrow bandwidth. The default value is 12.

Definition at line 106 of file sitkReinitializeLevelSetImageFilter.h.

References m_OutputNarrowBandwidth.

NarrowBandingOff()

Self & itk::simple::ReinitializeLevelSetImageFilter::NarrowBandingOff ( )

inline

Definition at line 81 of file sitkReinitializeLevelSetImageFilter.h.

References SetNarrowBanding().

NarrowBandingOn()

Self & itk::simple::ReinitializeLevelSetImageFilter::NarrowBandingOn ( )

inline

Set the value of NarrowBanding to true or false respectfully.

Definition at line 80 of file sitkReinitializeLevelSetImageFilter.h.

References SetNarrowBanding().

NarrowBandwidth()

void itk::simple::ReinitializeLevelSetImageFilter::NarrowBandwidth

(

double

value

)

Set the bandwidth for both the input and output narrowband, By default, both the input and output are set to 12.

SetInputNarrowBandwidth()

Self & itk::simple::ReinitializeLevelSetImageFilter::SetInputNarrowBandwidth ( double InputNarrowBandwidth )

inline

Set/Get the input narrow bandwidth. The default value is 12.

Definition at line 91 of file sitkReinitializeLevelSetImageFilter.h.

References m_InputNarrowBandwidth.

SetLevelSetValue()

Self & itk::simple::ReinitializeLevelSetImageFilter::SetLevelSetValue ( double LevelSetValue )

inline

Set/Get the value of the level set to be located. The default value is 0.

Definition at line 67 of file sitkReinitializeLevelSetImageFilter.h.

References m_LevelSetValue.

SetNarrowBanding()

Self & itk::simple::ReinitializeLevelSetImageFilter::SetNarrowBanding ( bool NarrowBanding )

inline

Set/Get the narrowbanding flag. By default, narrowbanding is switched off.

Definition at line 77 of file sitkReinitializeLevelSetImageFilter.h.

References m_NarrowBanding.

Referenced by NarrowBandingOff(), and NarrowBandingOn().

SetOutputNarrowBandwidth()

Self & itk::simple::ReinitializeLevelSetImageFilter::SetOutputNarrowBandwidth ( double OutputNarrowBandwidth )

inline

Set/Get the output narrow bandwidth. The default value is 12.

Definition at line 101 of file sitkReinitializeLevelSetImageFilter.h.

References m_OutputNarrowBandwidth.

ToString()

std::string itk::simple::ReinitializeLevelSetImageFilter::ToString ( ) const

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Symbol Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 128 of file sitkReinitializeLevelSetImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_InputNarrowBandwidth

double itk::simple::ReinitializeLevelSetImageFilter::m_InputNarrowBandwidth {12.0}

private

Definition at line 143 of file sitkReinitializeLevelSetImageFilter.h.

Referenced by GetInputNarrowBandwidth(), and SetInputNarrowBandwidth().

m_LevelSetValue

double itk::simple::ReinitializeLevelSetImageFilter::m_LevelSetValue {0.0}

private

Definition at line 137 of file sitkReinitializeLevelSetImageFilter.h.

Referenced by GetLevelSetValue(), and SetLevelSetValue().

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ReinitializeLevelSetImageFilter::m_MemberFactory

private

Definition at line 133 of file sitkReinitializeLevelSetImageFilter.h.

m_NarrowBanding

bool itk::simple::ReinitializeLevelSetImageFilter::m_NarrowBanding {false}

private

Definition at line 140 of file sitkReinitializeLevelSetImageFilter.h.

Referenced by GetNarrowBanding(), and SetNarrowBanding().

m_OutputNarrowBandwidth

double itk::simple::ReinitializeLevelSetImageFilter::m_OutputNarrowBandwidth {12.0}

private

Definition at line 146 of file sitkReinitializeLevelSetImageFilter.h.

Referenced by GetOutputNarrowBandwidth(), and SetOutputNarrowBandwidth().

---

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

• sitkReinitializeLevelSetImageFilter.h