ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkThresholdSegmentationLevelSetFunction.h>

+ Inheritance diagram for itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >:
+ Collaboration diagram for itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef TFeatureImageType FeatureImageType
typedef
Superclass::FeatureScalarType 
FeatureScalarType
typedef Superclass::ImageType ImageType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef Superclass::ScalarValueType ScalarValueType
typedef
ThresholdSegmentationLevelSetFunction 
Self
typedef
SegmentationLevelSetFunction
< TImageType,
TFeatureImageType > 
Superclass

Public Member Functions

virtual void CalculateSpeedImage ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
ScalarValueType GetEdgeWeight () const
virtual const char * GetNameOfClass () const
ScalarValueType GetSmoothingConductance () const
int GetSmoothingIterations () const
ScalarValueType GetSmoothingTimeStep () const
virtual void Initialize (const RadiusType &r)
void SetEdgeWeight (const ScalarValueType p)
void SetSmoothingConductance (const ScalarValueType p)
void SetSmoothingIterations (const int p)
void SetSmoothingTimeStep (const ScalarValueType i)
void SetUpperThreshold (FeatureScalarType f)
FeatureScalarType GetUpperThreshold () const
void SetLowerThreshold (FeatureScalarType f)
FeatureScalarType GetLowerThreshold () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension

Protected Member Functions

void operator= (const Self &)
void PrintSelf (std::ostream &os, Indent indent) const
 ThresholdSegmentationLevelSetFunction ()
 ThresholdSegmentationLevelSetFunction (const Self &)
virtual ~ThresholdSegmentationLevelSetFunction ()

Protected Attributes

ScalarValueType m_EdgeWeight
FeatureScalarType m_LowerThreshold
ScalarValueType m_SmoothingConductance
int m_SmoothingIterations
ScalarValueType m_SmoothingTimeStep
FeatureScalarType m_UpperThreshold

Detailed Description

template<class TImageType, class TFeatureImageType = TImageType>
class itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >

This function is used in ThresholdSegmentationLevelSetImageFilter to segment structures in images based on intensity values.

SegmentationLevelSetFunction is a subclass of the generic LevelSetFunction.
It is useful for segmentations based on intensity values in an image. It works by constructing a speed term (feature image) with positive values inside an intensity window (between a low and high threshold) and negative values outside that intensity window. The evolving level set front will lock onto regions that are at the edges of the intensity window.

You may optionally add a Laplacian calculation on the image to the threshold-based speed term by setting the EdgeWeight parameter to a non-zero value. The Laplacian term will cause the evolving surface to be more strongly attracted to image edges. Several parameters control a preprocessing FeatureImage smoothing stage applied only to the Laplacian calculation.

Image $ f $ is thresholded pixel by pixel using upper threshold $ U $ and lower threshold $ L $ according to the following formula.
$ f(x) = \left\{ \begin{array}{ll} g(x) - L & \mbox{if $(g)x < (U-L)/2 + L$} \\ U - g(x) & \mbox{otherwise} \end{array} \right. $
See also:
SegmentationLevelSetImageFunction
ThresholdSegmentationLevelSetImageFilter

Definition at line 56 of file itkThresholdSegmentationLevelSetFunction.h.


Member Typedef Documentation

template<class TImageType , class TFeatureImageType = TImageType>
typedef SmartPointer< const Self > itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer
template<class TImageType , class TFeatureImageType = TImageType>
typedef TFeatureImageType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType
template<class TImageType , class TFeatureImageType = TImageType>
typedef Superclass::FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType
template<class TImageType , class TFeatureImageType = TImageType>
typedef Superclass::ImageType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageType

Extract some parameters from the superclass.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 72 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
typedef SmartPointer< Self > itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer
template<class TImageType , class TFeatureImageType = TImageType>
typedef Superclass::RadiusType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::RadiusType
template<class TImageType , class TFeatureImageType = TImageType>
typedef Superclass::ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType
template<class TImageType , class TFeatureImageType = TImageType>
typedef ThresholdSegmentationLevelSetFunction itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Self

Standard class typedefs.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 61 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
typedef SegmentationLevelSetFunction< TImageType, TFeatureImageType > itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Superclass

Constructor & Destructor Documentation

template<class TImageType , class TFeatureImageType = TImageType>
itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ThresholdSegmentationLevelSetFunction ( ) [inline, protected]

Definition at line 158 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::~ThresholdSegmentationLevelSetFunction ( ) [inline, protected, virtual]

Definition at line 171 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ThresholdSegmentationLevelSetFunction ( const Self ) [protected]

Member Function Documentation

template<class TImageType , class TFeatureImageType = TImageType>
virtual void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( ) [virtual]

This method must be defined in a subclass to implement a working function object. This method is called before the solver begins its work to produce the speed image used as the level set function's Propagation speed term. See LevelSetFunction for more information.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType , class TFeatureImageType = TImageType>
virtual::itk::LightObject::Pointer itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetEdgeWeight ( ) const [inline]

Definition at line 113 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetLowerThreshold ( ) const [inline]

Set/Get threshold values

Definition at line 91 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual const char* itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods)

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingConductance ( ) const [inline]

Definition at line 126 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
int itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingIterations ( ) const [inline]

Definition at line 139 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetSmoothingTimeStep ( ) const [inline]

Definition at line 152 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetUpperThreshold ( ) const [inline]

Set/Get threshold values

Definition at line 87 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
virtual void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r) [inline, virtual]

This method creates the appropriate member variable operators for the level-set calculations. The argument to this function is a the radius necessary for performing the level-set calculations.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 97 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
static Pointer itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::operator= ( const Self ) [protected]

Laplacean smoothing term

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [inline, protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 178 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetEdgeWeight ( const ScalarValueType  p) [inline]

Set/Get the weight applied to the edge (Laplacian) attractor in the speed term function. Zero will turn this term off.

Definition at line 108 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetLowerThreshold ( FeatureScalarType  f) [inline]

Set/Get threshold values

Definition at line 89 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingConductance ( const ScalarValueType  p) [inline]

Anisotropic diffusion is applied to the FeatureImage before calculatign the Laplacian (edge) term. This method sets/gets the smoothing conductance.

Definition at line 121 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingIterations ( const int  p) [inline]

Anisotropic diffusion is applied to the FeatureImage before calculating the Laplacian (edge) term. This method sets/gets the number of diffusion iterations.

Definition at line 134 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetSmoothingTimeStep ( const ScalarValueType  i) [inline]

Anisotropic diffusion is applied to the FeatureImage before calculating the Laplacian (edge) term. This method sets/gets the diffusion time step.

Definition at line 147 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
void itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetUpperThreshold ( FeatureScalarType  f) [inline]

Set/Get threshold values

Definition at line 85 of file itkThresholdSegmentationLevelSetFunction.h.


Member Data Documentation

template<class TImageType , class TFeatureImageType = TImageType>
const unsigned int itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension [static]

Extract some parameters from the superclass.

Reimplemented from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 82 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_EdgeWeight [protected]

Definition at line 191 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_LowerThreshold [protected]

Definition at line 190 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingConductance [protected]

Definition at line 192 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
int itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingIterations [protected]

Definition at line 193 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
ScalarValueType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_SmoothingTimeStep [protected]

Definition at line 194 of file itkThresholdSegmentationLevelSetFunction.h.

template<class TImageType , class TFeatureImageType = TImageType>
FeatureScalarType itk::ThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_UpperThreshold [protected]

Definition at line 189 of file itkThresholdSegmentationLevelSetFunction.h.


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