ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType > Class Template Reference

#include <itkVectorThresholdSegmentationLevelSetFunction.h>

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

Detailed Description

template<typename TImageType, typename TFeatureImageType>
class itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >

This function is used in VectorThresholdSegmentationLevelSetImageFilter to segment structures in images based on the Mahalanobis distance.

CREDITS
This class was contributed to ITK by Stefan Lindenau http://www.itk.org/pipermail/insight-users/2003-December/005969.html
SegmentationLevelSetFunction is a subclass of the generic LevelSetFunction.
It 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.
Image $ f(x) $ is thresholded pixel by pixel using threshold $T$ according to the following formula.

\[ f(x) = T - MahalanobisDistance(x) \]

See Also
SegmentationLevelSetImageFunction
ThresholdSegmentationLevelSetImageFilter
MahalanobisDistanceMembershipFunction

Definition at line 58 of file itkVectorThresholdSegmentationLevelSetFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
MahalanobisFunctionType::CovarianceMatrixType 
CovarianceMatrixType
 
typedef FeatureImageType::PixelType FeatureImagePixelType
 
typedef TFeatureImageType FeatureImageType
 
typedef
Superclass::FeatureScalarType 
FeatureScalarType
 
typedef Superclass::ImageType ImageType
 
typedef
MahalanobisFunctionType::Pointer 
MahalanobisFunctionPointer
 
typedef
Statistics::MahalanobisDistanceMembershipFunction
< FeatureScalarType
MahalanobisFunctionType
 
typedef
MahalanobisFunctionType::MeanVectorType 
MeanVectorType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef Superclass::ScalarValueType ScalarValueType
 
typedef
VectorThresholdSegmentationLevelSetFunction 
Self
 
typedef
SegmentationLevelSetFunction
< TImageType,
TFeatureImageType > 
Superclass
 
- Public Types inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
InterpolatorType::ContinuousIndexType 
ContinuousIndexType
 
typedef TFeatureImageType FeatureImageType
 
typedef FeatureImageType::PixelType FeatureScalarType
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef
Superclass::GlobalDataStruct 
GlobalDataStruct
 
typedef Superclass::ImageType ImageType
 
typedef ImageType::IndexType IndexType
 
typedef
LinearInterpolateImageFunction
< ImageType
InterpolatorType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef Superclass::PixelRealType PixelRealType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef Superclass::ScalarValueType ScalarValueType
 
typedef
SegmentationLevelSetFunction 
Self
 
typedef LevelSetFunction
< TImageType > 
Superclass
 
typedef Image< VectorType,
itkGetStaticConstMacro(ImageDimension) > 
VectorImageType
 
typedef
VectorLinearInterpolateImageFunction
< VectorImageType
VectorInterpolatorType
 
typedef Superclass::VectorType VectorType
 
- Public Types inherited from itk::LevelSetFunction< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef Superclass::ImageType ImageType
 
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef Superclass::PixelRealType PixelRealType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef PixelType ScalarValueType
 
typedef LevelSetFunction Self
 
typedef
FiniteDifferenceFunction
< TImageType > 
Superclass
 
typedef double TimeStepType
 
typedef FixedArray
< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) > 
VectorType
 
- Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
 
typedef Vector< float,
itkGetStaticConstMacro(ImageDimension) > 
FloatOffsetType
 
typedef TImageType ImageType
 
typedef Vector< PixelRealType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodScalesType
 
typedef
ConstNeighborhoodIterator
< TImageType,
DefaultBoundaryConditionType
NeighborhoodType
 
typedef double PixelRealType
 
typedef ImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
ConstNeighborhoodIterator
< TImageType >::RadiusType 
RadiusType
 
typedef FiniteDifferenceFunction Self
 
typedef LightObject Superclass
 
typedef double TimeStepType
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void CalculateSpeedImage () override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const CovarianceMatrixTypeGetCovariance () const
 
virtual const char * GetNameOfClass () const
 
ScalarValueType GetThreshold ()
 
virtual void Initialize (const RadiusType &r) override
 
void SetCovariance (const CovarianceMatrixType &cov)
 
void SetThreshold (ScalarValueType thr)
 
void SetMean (const MeanVectorType &mean)
 
const MeanVectorTypeGetMean () const
 
- Public Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual void AllocateAdvectionImage ()
 
virtual void AllocateSpeedImage ()
 
virtual void CalculateAdvectionImage ()
 
virtual void ReverseExpansionDirection ()
 
virtual const FeatureImageTypeGetFeatureImage () const
 
virtual void SetFeatureImage (const FeatureImageType *f)
 
virtual ImageTypeGetSpeedImage ()
 
void SetSpeedImage (ImageType *s)
 
virtual VectorImageTypeGetAdvectionImage () const
 
void SetAdvectionImage (VectorImageType *s)
 
- Public Member Functions inherited from itk::LevelSetFunction< TImageType >
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void * GetGlobalDataPointer () const override
 
bool GetUseMinimalCurvature () const
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void ReleaseGlobalDataPointer (void *GlobalData) const override
 
void SetUseMinimalCurvature (bool b)
 
void UseMinimalCurvatureOff ()
 
void UseMinimalCurvatureOn ()
 
virtual void SetAdvectionWeight (const ScalarValueType a)
 
ScalarValueType GetAdvectionWeight () const
 
virtual void SetPropagationWeight (const ScalarValueType p)
 
ScalarValueType GetPropagationWeight () const
 
virtual void SetCurvatureWeight (const ScalarValueType c)
 
ScalarValueType GetCurvatureWeight () const
 
void SetLaplacianSmoothingWeight (const ScalarValueType c)
 
ScalarValueType GetLaplacianSmoothingWeight () const
 
void SetEpsilonMagnitude (const ScalarValueType e)
 
ScalarValueType GetEpsilonMagnitude () const
 
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
const RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
virtual void InitializeIteration ()
 
void SetRadius (const RadiusType &r)
 
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LevelSetFunction< TImageType >
static double GetMaximumCurvatureTimeStep ()
 
static double GetMaximumPropagationTimeStep ()
 
static Pointer New ()
 
static void SetMaximumCurvatureTimeStep (double n)
 
static void SetMaximumPropagationTimeStep (double n)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
static const unsigned int NumberOfComponents = FeatureImagePixelType::Dimension
 
- Static Public Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::LevelSetFunction< TImageType >
static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
static const unsigned int ImageDimension = ImageType::ImageDimension
 

Protected Member Functions

void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorThresholdSegmentationLevelSetFunction ()
 
 VectorThresholdSegmentationLevelSetFunction (const Self &)
 
virtual ~VectorThresholdSegmentationLevelSetFunction ()
 
- Protected Member Functions inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd) const override
 
 SegmentationLevelSetFunction ()
 
virtual ~SegmentationLevelSetFunction ()
 
- Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
 LevelSetFunction ()
 
virtual ~LevelSetFunction ()
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
 FiniteDifferenceFunction ()
 
 ~FiniteDifferenceFunction ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

MahalanobisFunctionPointer m_Mahalanobis
 
ScalarValueType m_Threshold
 
- Protected Attributes inherited from itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >
VectorImageType::Pointer m_AdvectionImage
 
FeatureImageType::ConstPointer m_FeatureImage
 
InterpolatorType::Pointer m_Interpolator
 
ImageType::Pointer m_SpeedImage
 
Functor::VectorCast< typename
VectorInterpolatorType::OutputType,
VectorType
m_VectorCast
 
VectorInterpolatorType::Pointer m_VectorInterpolator
 
- Protected Attributes inherited from itk::LevelSetFunction< TImageType >
ScalarValueType m_AdvectionWeight
 
OffsetValueType m_Center
 
ScalarValueType m_CurvatureWeight
 
ScalarValueType m_EpsilonMagnitude
 
ScalarValueType m_LaplacianSmoothingWeight
 
ScalarValueType m_PropagationWeight
 
bool m_UseMinimalCurvature
 
OffsetValueType m_xStride [itkGetStaticConstMacro(ImageDimension)]
 
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]
 
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType m_Radius
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- Static Protected Attributes inherited from itk::LevelSetFunction< TImageType >
static double m_DT
 
static double m_WaveDT
 
static VectorType m_ZeroVectorConstant
 

Member Typedef Documentation

template<typename TImageType , typename TFeatureImageType >
typedef SmartPointer< const Self > itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ConstPointer
template<typename TImageType , typename TFeatureImageType >
typedef MahalanobisFunctionType::CovarianceMatrixType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CovarianceMatrixType
template<typename TImageType , typename TFeatureImageType >
typedef FeatureImageType::PixelType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImagePixelType

Extract the number of components in the vector pixel type .

Definition at line 87 of file itkVectorThresholdSegmentationLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType >
typedef TFeatureImageType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureImageType
template<typename TImageType , typename TFeatureImageType >
typedef Superclass::FeatureScalarType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::FeatureScalarType
template<typename TImageType , typename TFeatureImageType >
typedef Superclass::ImageType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageType

Extract some parameters from the superclass.

Definition at line 74 of file itkVectorThresholdSegmentationLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType >
typedef MahalanobisFunctionType::Pointer itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MahalanobisFunctionPointer
template<typename TImageType , typename TFeatureImageType >
typedef Statistics::MahalanobisDistanceMembershipFunction< FeatureScalarType > itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MahalanobisFunctionType
template<typename TImageType , typename TFeatureImageType >
typedef MahalanobisFunctionType::MeanVectorType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::MeanVectorType
template<typename TImageType , typename TFeatureImageType >
typedef SmartPointer< Self > itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Pointer
template<typename TImageType , typename TFeatureImageType >
typedef Superclass::RadiusType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::RadiusType
template<typename TImageType , typename TFeatureImageType >
typedef Superclass::ScalarValueType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ScalarValueType
template<typename TImageType , typename TFeatureImageType >
typedef VectorThresholdSegmentationLevelSetFunction itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Self

Standard class typedefs.

Definition at line 63 of file itkVectorThresholdSegmentationLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType >
typedef SegmentationLevelSetFunction< TImageType, TFeatureImageType > itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Superclass

Constructor & Destructor Documentation

template<typename TImageType , typename TFeatureImageType >
itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorThresholdSegmentationLevelSetFunction ( )
inlineprotected
template<typename TImageType , typename TFeatureImageType >
virtual itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::~VectorThresholdSegmentationLevelSetFunction ( )
inlineprotectedvirtual
template<typename TImageType , typename TFeatureImageType >
itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::VectorThresholdSegmentationLevelSetFunction ( const Self )
protected

Member Function Documentation

template<typename TImageType , typename TFeatureImageType >
virtual void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage ( )
overridevirtual

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<typename TImageType , typename TFeatureImageType >
virtual::itk::LightObject::Pointer itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CreateAnother ( ) 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<typename TImageType , typename TFeatureImageType >
const CovarianceMatrixType& itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetCovariance ( ) const
inline
template<typename TImageType , typename TFeatureImageType >
const MeanVectorType& itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetMean ( ) const
inline
template<typename TImageType , typename TFeatureImageType >
virtual const char* itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

template<typename TImageType , typename TFeatureImageType >
ScalarValueType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::GetThreshold ( )
inline
template<typename TImageType , typename TFeatureImageType >
virtual void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize ( const RadiusType r)
inlineoverridevirtual

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 117 of file itkVectorThresholdSegmentationLevelSetFunction.h.

References itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >::Initialize(), itk::LevelSetFunction< TImageType >::SetAdvectionWeight(), itk::LevelSetFunction< TImageType >::SetCurvatureWeight(), and itk::LevelSetFunction< TImageType >::SetPropagationWeight().

template<typename TImageType , typename TFeatureImageType >
static Pointer itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::New ( )
static

Method for creation through the object factory.

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::operator= ( const Self )
protected
template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

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

References itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Mahalanobis, itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Threshold, and itk::LevelSetFunction< TImageType >::PrintSelf().

template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetCovariance ( const CovarianceMatrixType cov)
inline
template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetMean ( const MeanVectorType mean)
inline
template<typename TImageType , typename TFeatureImageType >
void itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::SetThreshold ( ScalarValueType  thr)
inline

Member Data Documentation

template<typename TImageType , typename TFeatureImageType >
const unsigned int itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::ImageDimension = Superclass::ImageDimension
static

Extract some parameters from the superclass.

Definition at line 84 of file itkVectorThresholdSegmentationLevelSetFunction.h.

template<typename TImageType , typename TFeatureImageType >
MahalanobisFunctionPointer itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Mahalanobis
protected
template<typename TImageType , typename TFeatureImageType >
ScalarValueType itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::m_Threshold
protected
template<typename TImageType , typename TFeatureImageType >
const unsigned int itk::VectorThresholdSegmentationLevelSetFunction< TImageType, TFeatureImageType >::NumberOfComponents = FeatureImagePixelType::Dimension
static

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