itk::simple::LaplacianSegmentationLevelSetImageFilter Class Reference

Segments structures in images based on a second derivative image features. More...

#include <sitkLaplacianSegmentationLevelSetImageFilter.h>

Inheritance diagram for itk::simple::LaplacianSegmentationLevelSetImageFilter:

Collaboration diagram for itk::simple::LaplacianSegmentationLevelSetImageFilter:

Public Types
typedef RealPixelIDTypeList	PixelIDTypeList
typedef LaplacianSegmentationLevelSetImageFilter	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 maximumRMSError, double propagationScaling, double curvatureScaling, uint32_t numberOfIterations, bool reverseExpansionDirection)
double	GetCurvatureScaling () const
uint32_t	GetElapsedIterations () const
	Number of iterations run. More...
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...
	LaplacianSegmentationLevelSetImageFilter ()
Self &	ReverseExpansionDirectionOff ()
Self &	ReverseExpansionDirectionOn ()
Self &	SetCurvatureScaling (double CurvatureScaling)
Self &	SetMaximumRMSError (double MaximumRMSError)
Self &	SetNumberOfIterations (uint32_t NumberOfIterations)
Self &	SetPropagationScaling (double PropagationScaling)
Self &	SetReverseExpansionDirection (bool ReverseExpansionDirection)
std::string	ToString () const
	~LaplacianSegmentationLevelSetImageFilter ()
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_MaximumRMSError
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
uint32_t	m_NumberOfIterations
double	m_PropagationScaling
bool	m_ReverseExpansionDirection
double	m_RMSChange

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) throw ()
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 a second derivative image features.

IMPORTANT

The SegmentationLevelSetImageFilter class and the LaplacianSegmentationLevelSetFunction 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 zero at image edges as detected by a Laplacian filter. The evolving level set front will therefore tend to lock onto zero crossings in the image. The level set front moves fastest near edges.

The Laplacian segmentation filter is intended primarily as a tool for refining existing segmentations. The initial isosurface (as given in the seed input image) should ideally be very close to the segmentation boundary of interest. The idea is that a rough segmentation can be refined by allowing the isosurface to deform slightly to achieve a better fit to the edge features of an image. One example of such an application is to refine the output of a hand segmented image.

Because values in the Laplacian feature image will tend to be low except near edge features, this filter is not effective for segmenting large image regions from small seed surfaces.

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. Because second derivative calculations are highly sensitive to noise, isotropic or anisotropic smoothing of the feature image can dramatically improve the results.

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

This filter has no parameters other than those described in SegmentationLevelSetImageFilter .

See also

SegmentationLevelSetImageFilter

LaplacianSegmentationLevelSetFunction ,

SparseFieldLevelSetImageFilter

itk::simple::LaplacianSegmentationLevelSet for the procedural interface

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

Definition at line 78 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 172 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

typedef RealPixelIDTypeList itk::simple::LaplacianSegmentationLevelSetImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 90 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

typedef LaplacianSegmentationLevelSetImageFilter itk::simple::LaplacianSegmentationLevelSetImageFilter::Self

Definition at line 80 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

Constructor & Destructor Documentation

itk::simple::LaplacianSegmentationLevelSetImageFilter::LaplacianSegmentationLevelSetImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::LaplacianSegmentationLevelSetImageFilter::~LaplacianSegmentationLevelSetImageFilter

(

)

Destructor

Member Function Documentation

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

Execute the filter on the input images

Image itk::simple::LaplacianSegmentationLevelSetImageFilter::Execute	(	const Image &	image1,
		const Image &	image2,
		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::LaplacianSegmentationLevelSetImageFilter::ExecuteInternal ( const Image &  image1, const Image &  image2  )

private

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

inline

Definition at line 116 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

uint32_t itk::simple::LaplacianSegmentationLevelSetImageFilter::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 143 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 100 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 154 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 124 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 108 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 136 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

double itk::simple::LaplacianSegmentationLevelSetImageFilter::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 151 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 132 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Set the value of ReverseExpansionDirection to true or false respectfully.

Definition at line 131 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 112 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 96 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 120 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 104 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

inline

Definition at line 128 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

std::string itk::simple::LaplacianSegmentationLevelSetImageFilter::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 177 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

Member Data Documentation

double itk::simple::LaplacianSegmentationLevelSetImageFilter::m_CurvatureScaling

private

Definition at line 187 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

uint32_t itk::simple::LaplacianSegmentationLevelSetImageFilter::m_ElapsedIterations

private

Definition at line 193 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

double itk::simple::LaplacianSegmentationLevelSetImageFilter::m_MaximumRMSError

private

Definition at line 183 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

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

private

Definition at line 179 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

uint32_t itk::simple::LaplacianSegmentationLevelSetImageFilter::m_NumberOfIterations

private

Definition at line 189 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

double itk::simple::LaplacianSegmentationLevelSetImageFilter::m_PropagationScaling

private

Definition at line 185 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

bool itk::simple::LaplacianSegmentationLevelSetImageFilter::m_ReverseExpansionDirection

private

Definition at line 191 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

double itk::simple::LaplacianSegmentationLevelSetImageFilter::m_RMSChange

private

Definition at line 195 of file sitkLaplacianSegmentationLevelSetImageFilter.h.

---

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

• sitkLaplacianSegmentationLevelSetImageFilter.h