SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &initialImage, const Image &featureImage)
 
Image Execute (const Image &initialImage, const Image &featureImage, 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
 
SelfReverseExpansionDirectionOff ()
 
SelfReverseExpansionDirectionOn ()
 
SelfSetCurvatureScaling (double CurvatureScaling)
 
SelfSetLowerThreshold (double LowerThreshold)
 
SelfSetMaximumRMSError (double MaximumRMSError)
 
SelfSetNumberOfIterations (uint32_t NumberOfIterations)
 
SelfSetPropagationScaling (double PropagationScaling)
 
SelfSetReverseExpansionDirection (bool ReverseExpansionDirection)
 
SelfSetUpperThreshold (double UpperThreshold)
 
 ThresholdSegmentationLevelSetImageFilter ()
 
std::string ToString () const
 
virtual ~ThresholdSegmentationLevelSetImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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 *initialImage, const Image *featureImage)
 

Private Member Functions

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

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::ProcessObjectGetActiveProcess ()
 
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< 0 >
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::EventObjectGetITKEventObject (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 *initialImage, const Image *featureImage)
private

Setup for member function dispatching

Definition at line 180 of file sitkThresholdSegmentationLevelSetImageFilter.h.

Define the pixels types supported by this filter

Definition at line 82 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 initialImage,
const Image featureImage 
)

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ThresholdSegmentationLevelSetImageFilter::ExecuteInternal ( const Image initialImage,
const Image featureImage 
)
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetCurvatureScaling ( ) const
inline
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
double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetMaximumRMSError ( ) const
inline
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
double itk::simple::ThresholdSegmentationLevelSetImageFilter::GetPropagationScaling ( ) const
inline
bool itk::simple::ThresholdSegmentationLevelSetImageFilter::GetReverseExpansionDirection ( ) const
inline
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
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::ReverseExpansionDirectionOff ( )
inline
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
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetLowerThreshold ( double  LowerThreshold)
inline
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetMaximumRMSError ( double  MaximumRMSError)
inline
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetNumberOfIterations ( uint32_t  NumberOfIterations)
inline
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetPropagationScaling ( double  PropagationScaling)
inline
Self& itk::simple::ThresholdSegmentationLevelSetImageFilter::SetReverseExpansionDirection ( bool  ReverseExpansionDirection)
inline
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

Member Data Documentation

double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_CurvatureScaling
private
uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ElapsedIterations
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_LowerThreshold
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_MaximumRMSError
private
nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ThresholdSegmentationLevelSetImageFilter::m_MemberFactory
private
uint32_t itk::simple::ThresholdSegmentationLevelSetImageFilter::m_NumberOfIterations
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_PropagationScaling
private
bool itk::simple::ThresholdSegmentationLevelSetImageFilter::m_ReverseExpansionDirection
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_RMSChange
private
double itk::simple::ThresholdSegmentationLevelSetImageFilter::m_UpperThreshold
private

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