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:

Public Types
typedef RealPixelIDTypeList	PixelIDTypeList
typedef ThresholdSegmentationLevelSetImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1, const Image &image2)
Image	Execute (const Image &image1, const Image &image2, double lowerThreshold, double upperThreshold, double maximumRMSError, double propagationScaling, double curvatureScaling, uint32_t numberOfIterations, bool reverseExpansionDirection)
double	GetCurvatureScaling () const
uint32_t	GetElapsedIterations () const
	Number of iterations run. More...
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. More...
double	GetUpperThreshold () const
Self &	ReverseExpansionDirectionOff ()
Self &	ReverseExpansionDirectionOn ()
Self &	SetCurvatureScaling (double CurvatureScaling)
Self &	SetLowerThreshold (double LowerThreshold)
Self &	SetMaximumRMSError (double MaximumRMSError)
Self &	SetNumberOfIterations (uint32_t NumberOfIterations)
Self &	SetPropagationScaling (double PropagationScaling)
Self &	SetReverseExpansionDirection (bool ReverseExpansionDirection)
Self &	SetUpperThreshold (double UpperThreshold)
	ThresholdSegmentationLevelSetImageFilter ()
std::string	ToString () const
virtual	~ThresholdSegmentationLevelSetImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	ImageFilter ()
virtual	~ImageFilter ()=0
Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()
virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...
virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...
virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...
	ProcessObject ()
virtual void	RemoveAllCommands ()
	Remove all registered commands. More...
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

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

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

Private Attributes
double	m_CurvatureScaling
uint32_t	m_ElapsedIterations
double	m_LowerThreshold
double	m_MaximumRMSError
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint32_t	m_NumberOfIterations
double	m_PropagationScaling
bool	m_ReverseExpansionDirection
double	m_RMSChange
double	m_UpperThreshold

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int	GetGlobalDefaultNumberOfThreads ()
static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...
static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...
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) SITK_NOEXCEPT
virtual void	PreUpdate (itk::ProcessObject *p)
virtual void	RemoveITKObserver (EventCommand &e)
Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()
Static Protected Member Functions inherited from itk::simple::ImageFilter< 2 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)
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)

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 segmentated 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 70 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ThresholdSegmentationLevelSetImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

private

Setup for member function dispatching

Definition at line 180 of file sitkThresholdSegmentationLevelSetImageFilter.h.

typedef RealPixelIDTypeList itk::simple::ThresholdSegmentationLevelSetImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 82 of file sitkThresholdSegmentationLevelSetImageFilter.h.

typedef ThresholdSegmentationLevelSetImageFilter itk::simple::ThresholdSegmentationLevelSetImageFilter::Self

Definition at line 72 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

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

virtual

Destructor

itk::simple::ThresholdSegmentationLevelSetImageFilter::ThresholdSegmentationLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

Execute the filter on the input images

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		double	lowerThreshold,
		double	upperThreshold,
		double	maximumRMSError,
		double	propagationScaling,
		double	curvatureScaling,
		uint32_t	numberOfIterations,
		bool	reverseExpansionDirection
	)

Execute the filter on the input images with the given parameters

template<class TImageType >

Image itk::simple::ThresholdSegmentationLevelSetImageFilter::ExecuteInternal ( const Image &  image1, const Image &  image2  )

private

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

inline

Definition at line 125 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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 152 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 92 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 109 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 163 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 133 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 117 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 145 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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 160 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 101 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::ReverseExpansionDirectionOff ( )

inline

Definition at line 141 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::ReverseExpansionDirectionOn ( )

inline

Set the value of ReverseExpansionDirection to true or false respectfully.

Definition at line 140 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetCurvatureScaling ( double  CurvatureScaling )

inline

Definition at line 121 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetLowerThreshold ( double  LowerThreshold )

inline

Definition at line 88 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetMaximumRMSError ( double  MaximumRMSError )

inline

Definition at line 105 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations )

inline

Definition at line 129 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetPropagationScaling ( double  PropagationScaling )

inline

Definition at line 113 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetReverseExpansionDirection ( bool  ReverseExpansionDirection )

inline

Definition at line 137 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetUpperThreshold ( double  UpperThreshold )

inline

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

Definition at line 97 of file sitkThresholdSegmentationLevelSetImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 184 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Member Data Documentation

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_CurvatureScaling

private

Definition at line 196 of file sitkThresholdSegmentationLevelSetImageFilter.h.

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ElapsedIterations

private

Definition at line 202 of file sitkThresholdSegmentationLevelSetImageFilter.h.

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_LowerThreshold

private

Definition at line 189 of file sitkThresholdSegmentationLevelSetImageFilter.h.

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_MaximumRMSError

private

Definition at line 192 of file sitkThresholdSegmentationLevelSetImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ThresholdSegmentationLevelSetImageFilter::m_MemberFactory

private

Definition at line 186 of file sitkThresholdSegmentationLevelSetImageFilter.h.

uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_NumberOfIterations

private

Definition at line 198 of file sitkThresholdSegmentationLevelSetImageFilter.h.

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_PropagationScaling

private

Definition at line 194 of file sitkThresholdSegmentationLevelSetImageFilter.h.

bool itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ReverseExpansionDirection

private

Definition at line 200 of file sitkThresholdSegmentationLevelSetImageFilter.h.

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_RMSChange

private

Definition at line 204 of file sitkThresholdSegmentationLevelSetImageFilter.h.

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_UpperThreshold

private

Definition at line 190 of file sitkThresholdSegmentationLevelSetImageFilter.h.

---

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

• sitkThresholdSegmentationLevelSetImageFilter.h