itk::simple::ThresholdSegmentationLevelSetImageFilter Class Reference

Segments structures in images based on intensity values. More...

#include <sitkThresholdSegmentationLevelSetImageFilter.h>

Inheritance diagram for itk::simple::ThresholdSegmentationLevelSetImageFilter:

Collaboration diagram for itk::simple::ThresholdSegmentationLevelSetImageFilter:

Detailed Description

Segments structures in images based on intensity values.

IMPORTANT

The SegmentationLevelSetImageFilter class and the ThresholdSegmentationLevelSetFunction class contain additional information necessary to the full understanding of how to use this filter.

OVERVIEW

This class is a level set method segmentation filter. It constructs a speed function which is close to zero at the upper and lower bounds of an intensity window, effectively locking the propagating front onto those edges. Elsewhere, the front will propagate quickly.

INPUTS

This filter requires two inputs. The first input is a seed image. This seed image must contain an isosurface that you want to use as the seed for your segmentation. It can be a binary, graylevel, or floating point image. The only requirement is that it contain a closed isosurface that you will identify as the seed by setting the IsosurfaceValue parameter of the filter. For a binary image you will want to set your isosurface value halfway between your on and off values (i.e. for 0's and 1's, use an isosurface value of 0.5).

The second input is the feature image. This is the image from which the speed function will be calculated. For most applications, this is the image that you want to segment. The desired isosurface in your seed image should lie within the region of your feature image that you are trying to segment. Note that this filter does no preprocessing of the feature image before thresholding.

See SegmentationLevelSetImageFilter for more information on Inputs.

OUTPUTS

The filter outputs a single, scalar, real-valued image. Positive values in the output image are inside the segmented region and negative values in the image are outside of the inside region. The zero crossings of the image correspond to the position of the level set front.

See SparseFieldLevelSetImageFilter and SegmentationLevelSetImageFilter for more information.

PARAMETERS

In addition to parameters described in SegmentationLevelSetImageFilter , this filter adds the UpperThreshold and LowerThreshold. See ThresholdSegmentationLevelSetFunction for a description of how these values affect the segmentation.

See also

SegmentationLevelSetImageFilter

ThresholdSegmentationLevelSetFunction ,

SparseFieldLevelSetImageFilter

itk::simple::ThresholdSegmentationLevelSet for the procedural interface

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

Definition at line 95 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Public Types
using	PixelIDTypeList = RealPixelIDTypeList
using	Self = ThresholdSegmentationLevelSetImageFilter
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 &initialImage, const Image &featureImage)
Image	Execute (Image &&initialImage, const Image &featureImage)
double	GetCurvatureScaling () const
uint32_t	GetElapsedIterations () const
	Number of iterations run.
double	GetLowerThreshold () const
double	GetMaximumRMSError () const
std::string	GetName () const
uint32_t	GetNumberOfIterations () const
double	GetPropagationScaling () const
bool	GetReverseExpansionDirection () const
double	GetRMSChange () const
	The Root Mean Square of the levelset upon termination.
double	GetUpperThreshold () const
void	ReverseExpansionDirectionOff ()
void	ReverseExpansionDirectionOn ()
void	SetCurvatureScaling (double CurvatureScaling)
void	SetLowerThreshold (double LowerThreshold)
void	SetMaximumRMSError (double MaximumRMSError)
void	SetNumberOfIterations (uint32_t NumberOfIterations)
void	SetPropagationScaling (double PropagationScaling)
void	SetReverseExpansionDirection (bool ReverseExpansionDirection)
void	SetUpperThreshold (double UpperThreshold)
	ThresholdSegmentationLevelSetImageFilter ()
std::string	ToString () const
virtual	~ThresholdSegmentationLevelSetImageFilter ()
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

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image *initialImage, const Image *featureImage)

Static Private Member Functions
static const detail::MemberFunctionFactory< MemberFunctionType > &	GetMemberFunctionFactory ()

Private Attributes
double	m_CurvatureScaling { 1.0 }
uint32_t	m_ElapsedIterations { 0 }
bool	m_InPlace {false}
double	m_LowerThreshold { 0.0 }
double	m_MaximumRMSError { 0.02 }
uint32_t	m_NumberOfIterations { 1000u }
double	m_PropagationScaling { 1.0 }
bool	m_ReverseExpansionDirection { false }
double	m_RMSChange { 0.0 }
double	m_UpperThreshold { 255.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::ThresholdSegmentationLevelSetImageFilter::MemberFunctionType

private

Initial value:

 Image (Self::*)(const Image *
    initialImage, const Image *
    featureImage)

Setup for member function dispatching

Definition at line 226 of file sitkThresholdSegmentationLevelSetImageFilter.h.

PixelIDTypeList

using itk::simple::ThresholdSegmentationLevelSetImageFilter::PixelIDTypeList = RealPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 107 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self

using itk::simple::ThresholdSegmentationLevelSetImageFilter::Self = ThresholdSegmentationLevelSetImageFilter

Definition at line 97 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

~ThresholdSegmentationLevelSetImageFilter()

virtual itk::simple::ThresholdSegmentationLevelSetImageFilter::~ThresholdSegmentationLevelSetImageFilter ( )

virtual

Destructor

ThresholdSegmentationLevelSetImageFilter()

itk::simple::ThresholdSegmentationLevelSetImageFilter::ThresholdSegmentationLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute() [1/2]

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::Execute	(	const Image &	initialImage,
		const Image &	featureImage )

Execute() [2/2]

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::Execute	(	Image &&	initialImage,
		const Image &	featureImage )

Execute the filter on the input image

ExecuteInternal()

template<class TImageType>

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::ExecuteInternal ( const Image * initialImage, const Image * featureImage )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

GetCurvatureScaling()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetCurvatureScaling ( ) const

inline

Definition at line 165 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_CurvatureScaling.

GetElapsedIterations()

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::GetElapsedIterations ( ) const

inline

Number of iterations run.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 201 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_ElapsedIterations.

GetLowerThreshold()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetLowerThreshold ( ) const

inline

Definition at line 120 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_LowerThreshold.

GetMaximumRMSError()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetMaximumRMSError ( ) const

inline

Definition at line 143 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_MaximumRMSError.

GetMemberFunctionFactory()

static const detail::MemberFunctionFactory< MemberFunctionType > & itk::simple::ThresholdSegmentationLevelSetImageFilter::GetMemberFunctionFactory ( )

staticprivate

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 211 of file sitkThresholdSegmentationLevelSetImageFilter.h.

GetNumberOfIterations()

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::GetNumberOfIterations ( ) const

inline

Definition at line 176 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_NumberOfIterations.

GetPropagationScaling()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetPropagationScaling ( ) const

inline

Definition at line 154 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_PropagationScaling.

GetReverseExpansionDirection()

bool itk::simple::ThresholdSegmentationLevelSetImageFilter::GetReverseExpansionDirection ( ) const

inline

Definition at line 193 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_ReverseExpansionDirection.

GetRMSChange()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetRMSChange ( ) const

inline

The Root Mean Square of the levelset upon termination.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 208 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_RMSChange.

GetUpperThreshold()

double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetUpperThreshold ( ) const

inline

Definition at line 132 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_UpperThreshold.

ReverseExpansionDirectionOff()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::ReverseExpansionDirectionOff ( )

inline

Definition at line 189 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References SetReverseExpansionDirection().

ReverseExpansionDirectionOn()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::ReverseExpansionDirectionOn ( )

inline

Set the value of ReverseExpansionDirection to true or false respectfully.

Definition at line 187 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References SetReverseExpansionDirection().

SetCurvatureScaling()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetCurvatureScaling ( double CurvatureScaling )

inline

Definition at line 160 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_CurvatureScaling.

SetLowerThreshold()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetLowerThreshold ( double LowerThreshold )

inline

Definition at line 115 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_LowerThreshold.

SetMaximumRMSError()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetMaximumRMSError ( double MaximumRMSError )

inline

Definition at line 138 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_MaximumRMSError.

SetNumberOfIterations()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetNumberOfIterations ( uint32_t NumberOfIterations )

inline

Definition at line 171 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_NumberOfIterations.

SetPropagationScaling()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetPropagationScaling ( double PropagationScaling )

inline

Definition at line 149 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_PropagationScaling.

SetReverseExpansionDirection()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetReverseExpansionDirection ( bool ReverseExpansionDirection )

inline

Definition at line 182 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_ReverseExpansionDirection.

Referenced by ReverseExpansionDirectionOff(), and ReverseExpansionDirectionOn().

SetUpperThreshold()

void itk::simple::ThresholdSegmentationLevelSetImageFilter::SetUpperThreshold ( double UpperThreshold )

inline

Get/Set the threshold values that will be used to calculate the speed function.

Definition at line 127 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References m_UpperThreshold.

ToString()

std::string itk::simple::ThresholdSegmentationLevelSetImageFilter::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 229 of file sitkThresholdSegmentationLevelSetImageFilter.h.

References ExecuteInternal().

Member Data Documentation

m_CurvatureScaling

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_CurvatureScaling { 1.0 }

private

Definition at line 247 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetCurvatureScaling(), and SetCurvatureScaling().

m_ElapsedIterations

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ElapsedIterations { 0 }

private

Definition at line 257 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetElapsedIterations().

m_InPlace

bool itk::simple::ThresholdSegmentationLevelSetImageFilter::m_InPlace {false}

private

Definition at line 263 of file sitkThresholdSegmentationLevelSetImageFilter.h.

m_LowerThreshold

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_LowerThreshold { 0.0 }

private

Definition at line 236 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetLowerThreshold(), and SetLowerThreshold().

m_MaximumRMSError

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_MaximumRMSError { 0.02 }

private

Definition at line 241 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetMaximumRMSError(), and SetMaximumRMSError().

m_NumberOfIterations

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_NumberOfIterations { 1000u }

private

Definition at line 250 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetNumberOfIterations(), and SetNumberOfIterations().

m_PropagationScaling

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_PropagationScaling { 1.0 }

private

Definition at line 244 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetPropagationScaling(), and SetPropagationScaling().

m_ReverseExpansionDirection

bool itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ReverseExpansionDirection { false }

private

Definition at line 253 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetReverseExpansionDirection(), and SetReverseExpansionDirection().

m_RMSChange

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_RMSChange { 0.0 }

private

Definition at line 258 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetRMSChange().

m_UpperThreshold

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_UpperThreshold { 255.0 }

private

Definition at line 238 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Referenced by GetUpperThreshold(), and SetUpperThreshold().

---

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

• sitkThresholdSegmentationLevelSetImageFilter.h