SimpleITK  1.2.4
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ObjectnessMeasureImageFilter Class Reference

Enhance M-dimensional objects in N-dimensional images. More...

#include <sitkObjectnessMeasureImageFilter.h>

+ Inheritance diagram for itk::simple::ObjectnessMeasureImageFilter:
+ Collaboration diagram for itk::simple::ObjectnessMeasureImageFilter:

Public Types

typedef RealPixelIDTypeList PixelIDTypeList
 
typedef ObjectnessMeasureImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

SelfBrightObjectOff ()
 
SelfBrightObjectOn ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, double alpha, double beta, double gamma, bool scaleObjectnessMeasure, unsigned int objectDimension, bool brightObject)
 
double GetAlpha () const
 
double GetBeta () const
 
bool GetBrightObject () const
 
double GetGamma () const
 
std::string GetName () const
 
unsigned int GetObjectDimension () const
 
bool GetScaleObjectnessMeasure () const
 
 ObjectnessMeasureImageFilter ()
 
SelfScaleObjectnessMeasureOff ()
 
SelfScaleObjectnessMeasureOn ()
 
SelfSetAlpha (double Alpha)
 
SelfSetBeta (double Beta)
 
SelfSetBrightObject (bool BrightObject)
 
SelfSetGamma (double Gamma)
 
SelfSetObjectDimension (unsigned int ObjectDimension)
 
SelfSetScaleObjectnessMeasure (bool ScaleObjectnessMeasure)
 
std::string ToString () const
 
virtual ~ObjectnessMeasureImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 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)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

double m_Alpha
 
double m_Beta
 
bool m_BrightObject
 
double m_Gamma
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
unsigned int m_ObjectDimension
 
bool m_ScaleObjectnessMeasure
 

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< 1 >
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

Enhance M-dimensional objects in N-dimensional images.

This filter is a generalization of Frangi's vesselness measurement for detecting M-dimensional object in N-dimensional space. For example a vessel is a 1-D object in 3-D space. The filter can enhance blob-like structures (M=0), vessel-like structures (M=1), 2D plate-like structures (M=2), hyper-plate-like structures (M=3) in N-dimensional images, with M<N.

This filter takes a scalar image as input and produces a real valued image as output which contains the objectness measure at each pixel. Internally, it computes a Hessian via discrete central differences. Before applying this filter it is expected that a Gaussian smoothing filter at an appropriate scale (sigma) was applied to the input image.

The enhancement is based on the eigenvalues of the Hessian matrix. For the Frangi's vesselness case were M=1 and N=3 we have the 3 eigenvalues such that $ | \lambda_1 | < | \lambda_2 | < |\lambda_3 | $ . The formula follows:

\[ R_A = \frac{|\lambda_2|}{|\lambda_3|}, \; R_B = \frac{|\lambda_2|}{|\lambda_2\lambda_3|}, \; S = \sqrt{\lambda_1^2+\lambda_2^2+\lambda_3^2} \]

\[ V_{\sigma}= \begin{cases} (1-e^{-\frac{R_A^2}{2\alpha^2}}) \cdot e^{\frac{R_B^2}{2\beta^2}} \cdot (1-e^{-\frac{S^2}{2\gamma^2}}) & \text{if } \lambda_2<0 \text{ and } \lambda_3<0 \text{,}\\ 0 & \text{otherwise} \end{cases} \]

References
Antiga, L. Generalizing vesselness with respect to dimensionality and shape. https://hdl.handle.net/1926/576
Frangi, AF, Niessen, WJ, Vincken, KL, & Viergever, MA (1998). Multiscale Vessel Enhancement Filtering. In Wells, WM, Colchester, A, & Delp, S, Editors, MICCAI '98 Medical Image Computing and Computer-Assisted Intervention, Lecture Notes in Computer Science, pages 130-137, Springer Verlag, 1998.
See also
itk::HessianToObjectnessMeasureImageFilter
itk::simple::ObjectnessMeasure for the procedural interface
itk::ObjectnessMeasureImageFilter for the Doxygen on the original ITK class.

Definition at line 56 of file sitkObjectnessMeasureImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ObjectnessMeasureImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 157 of file sitkObjectnessMeasureImageFilter.h.

Define the pixels types supported by this filter

Definition at line 68 of file sitkObjectnessMeasureImageFilter.h.

Definition at line 58 of file sitkObjectnessMeasureImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::ObjectnessMeasureImageFilter::~ObjectnessMeasureImageFilter ( )
virtual

Destructor

itk::simple::ObjectnessMeasureImageFilter::ObjectnessMeasureImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Self& itk::simple::ObjectnessMeasureImageFilter::BrightObjectOff ( )
inline

Definition at line 133 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::BrightObjectOn ( )
inline

Set the value of BrightObject to true or false respectfully.

Definition at line 132 of file sitkObjectnessMeasureImageFilter.h.

Image itk::simple::ObjectnessMeasureImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::ObjectnessMeasureImageFilter::Execute ( const Image image1,
double  alpha,
double  beta,
double  gamma,
bool  scaleObjectnessMeasure,
unsigned int  objectDimension,
bool  brightObject 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ObjectnessMeasureImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::ObjectnessMeasureImageFilter::GetAlpha ( ) const
inline

Set/Get Alpha, the weight corresponding to R_A (the ratio of the smallest eigenvalue that has to be large to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

Definition at line 80 of file sitkObjectnessMeasureImageFilter.h.

double itk::simple::ObjectnessMeasureImageFilter::GetBeta ( ) const
inline

Set/Get Beta, the weight corresponding to R_B (the ratio of the largest eigenvalue that has to be small to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

Definition at line 90 of file sitkObjectnessMeasureImageFilter.h.

bool itk::simple::ObjectnessMeasureImageFilter::GetBrightObject ( ) const
inline

Enhance bright structures on a dark background if true, the opposite if false.

Definition at line 138 of file sitkObjectnessMeasureImageFilter.h.

double itk::simple::ObjectnessMeasureImageFilter::GetGamma ( ) const
inline

Set/Get Gamma, the weight corresponding to S (the Frobenius norm of the Hessian matrix, or second-order structureness)

Definition at line 100 of file sitkObjectnessMeasureImageFilter.h.

std::string itk::simple::ObjectnessMeasureImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 140 of file sitkObjectnessMeasureImageFilter.h.

unsigned int itk::simple::ObjectnessMeasureImageFilter::GetObjectDimension ( ) const
inline

Set/Get the dimensionality of the object (0: points (blobs), 1: lines (vessels), 2: planes (plate-like structures), 3: hyper-planes. ObjectDimension must be smaller than ImageDimension.

Definition at line 124 of file sitkObjectnessMeasureImageFilter.h.

bool itk::simple::ObjectnessMeasureImageFilter::GetScaleObjectnessMeasure ( ) const
inline

Toggle scaling the objectness measure with the magnitude of the largest absolute eigenvalue

Definition at line 114 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::ScaleObjectnessMeasureOff ( )
inline

Definition at line 109 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::ScaleObjectnessMeasureOn ( )
inline

Set the value of ScaleObjectnessMeasure to true or false respectfully.

Definition at line 108 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetAlpha ( double  Alpha)
inline

Set/Get Alpha, the weight corresponding to R_A (the ratio of the smallest eigenvalue that has to be large to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

Definition at line 75 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetBeta ( double  Beta)
inline

Set/Get Beta, the weight corresponding to R_B (the ratio of the largest eigenvalue that has to be small to the larger ones). Smaller values lead to increased sensitivity to the object dimensionality.

Definition at line 85 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetBrightObject ( bool  BrightObject)
inline

Enhance bright structures on a dark background if true, the opposite if false.

Definition at line 129 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetGamma ( double  Gamma)
inline

Set/Get Gamma, the weight corresponding to S (the Frobenius norm of the Hessian matrix, or second-order structureness)

Definition at line 95 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetObjectDimension ( unsigned int  ObjectDimension)
inline

Set/Get the dimensionality of the object (0: points (blobs), 1: lines (vessels), 2: planes (plate-like structures), 3: hyper-planes. ObjectDimension must be smaller than ImageDimension.

Definition at line 119 of file sitkObjectnessMeasureImageFilter.h.

Self& itk::simple::ObjectnessMeasureImageFilter::SetScaleObjectnessMeasure ( bool  ScaleObjectnessMeasure)
inline

Toggle scaling the objectness measure with the magnitude of the largest absolute eigenvalue

Definition at line 105 of file sitkObjectnessMeasureImageFilter.h.

std::string itk::simple::ObjectnessMeasureImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 161 of file sitkObjectnessMeasureImageFilter.h.

Member Data Documentation

double itk::simple::ObjectnessMeasureImageFilter::m_Alpha
private

Definition at line 166 of file sitkObjectnessMeasureImageFilter.h.

double itk::simple::ObjectnessMeasureImageFilter::m_Beta
private

Definition at line 168 of file sitkObjectnessMeasureImageFilter.h.

bool itk::simple::ObjectnessMeasureImageFilter::m_BrightObject
private

Definition at line 172 of file sitkObjectnessMeasureImageFilter.h.

double itk::simple::ObjectnessMeasureImageFilter::m_Gamma
private

Definition at line 169 of file sitkObjectnessMeasureImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ObjectnessMeasureImageFilter::m_MemberFactory
private

Definition at line 163 of file sitkObjectnessMeasureImageFilter.h.

unsigned int itk::simple::ObjectnessMeasureImageFilter::m_ObjectDimension
private

Definition at line 171 of file sitkObjectnessMeasureImageFilter.h.

bool itk::simple::ObjectnessMeasureImageFilter::m_ScaleObjectnessMeasure
private

Definition at line 170 of file sitkObjectnessMeasureImageFilter.h.


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