SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::FastMarchingUpwindGradientImageFilter Class Reference

Generates the upwind gradient field of fast marching arrival times. More...

#include <sitkFastMarchingUpwindGradientImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef FastMarchingUpwindGradientImageFilter 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

SelfAddTargetPoint (const std::vector< unsigned int > &point)
 Add TargetPoints point. More...
 
SelfAddTrialPoint (const std::vector< unsigned int > &point)
 Add TrialPoints point. More...
 
SelfClearTargetPoints ()
 Remove all TargetPoints points. More...
 
SelfClearTrialPoints ()
 Remove all TrialPoints points. More...
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< std::vector< unsigned int > > &trialPoints, unsigned int numberOfTargets, const std::vector< std::vector< unsigned int > > &targetPoints, double targetOffset, double normalizationFactor)
 
 FastMarchingUpwindGradientImageFilter ()
 
Image GetGradientImage () const
 
std::string GetName () const
 
double GetNormalizationFactor () const
 
unsigned int GetNumberOfTargets () const
 
double GetTargetOffset () const
 
std::vector< std::vector< unsigned int > > GetTargetPoints () const
 
double GetTargetValue () const
 
std::vector< std::vector< unsigned int > > GetTrialPoints () const
 
SelfSetNormalizationFactor (double NormalizationFactor)
 
SelfSetNumberOfTargets (unsigned int NumberOfTargets)
 
SelfSetTargetOffset (double TargetOffset)
 
SelfSetTargetPoints (const std::vector< std::vector< unsigned int > > &TargetPoints)
 
SelfSetTrialPoints (const std::vector< std::vector< unsigned int > > &TrialPoints)
 
std::string ToString () const
 
virtual ~FastMarchingUpwindGradientImageFilter ()
 
- 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

Image m_GradientImage
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
double m_NormalizationFactor
 
unsigned int m_NumberOfTargets
 
double m_TargetOffset
 
std::vector< std::vector< unsigned int > > m_TargetPoints
 
double m_TargetValue
 
std::vector< std::vector< unsigned int > > m_TrialPoints
 

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

Generates the upwind gradient field of fast marching arrival times.

This filter adds some extra functionality to its base class. While the solution T(x) of the Eikonal equation is being generated by the base class with the fast marching method, the filter generates the upwind gradient vectors of T(x), storing them in an image.

Since the Eikonal equation generates the arrival times of a wave travelling at a given speed, the generated gradient vectors can be interpreted as the slowness (1/velocity) vectors of the front (the quantity inside the modulus operator in the Eikonal equation).

Gradient vectors are computed using upwind finite differences, that is, information only propagates from points where the wavefront has already passed. This is consistent with how the fast marching method works.

One more extra feature is the possibility to define a set of Target points where the propagation stops. This can be used to avoid computing the Eikonal solution for the whole domain. The front can be stopped either when one Target point is reached or all Target points are reached. The propagation can stop after a time TargetOffset has passed since the stop condition is met. This way the solution is computed a bit downstream the Target points, so that the level sets of T(x) corresponding to the Target are smooth.

For an alternative implementation, see itk::FastMarchingUpwindGradientImageFilterBase .

Author
Luca Antiga Ph.D. Biomedical Technologies Laboratory, Bioengineering Department, Mario Negri Institute, Italy.
See also
itk::simple::FastMarchingUpwindGradient for the procedural interface
itk::FastMarchingUpwindGradientImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkFastMarchingUpwindGradientImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 158 of file sitkFastMarchingUpwindGradientImageFilter.h.

Define the pixels types supported by this filter

Definition at line 64 of file sitkFastMarchingUpwindGradientImageFilter.h.

Definition at line 54 of file sitkFastMarchingUpwindGradientImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::FastMarchingUpwindGradientImageFilter::~FastMarchingUpwindGradientImageFilter ( )
virtual

Destructor

itk::simple::FastMarchingUpwindGradientImageFilter::FastMarchingUpwindGradientImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Self& itk::simple::FastMarchingUpwindGradientImageFilter::AddTargetPoint ( const std::vector< unsigned int > &  point)
inline

Add TargetPoints point.

Definition at line 100 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::AddTrialPoint ( const std::vector< unsigned int > &  point)
inline

Add TrialPoints point.

Definition at line 76 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::ClearTargetPoints ( )
inline

Remove all TargetPoints points.

Definition at line 102 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::ClearTrialPoints ( )
inline

Remove all TrialPoints points.

Definition at line 78 of file sitkFastMarchingUpwindGradientImageFilter.h.

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

Execute the filter on the input image

Image itk::simple::FastMarchingUpwindGradientImageFilter::Execute ( const Image image1,
const std::vector< std::vector< unsigned int > > &  trialPoints,
unsigned int  numberOfTargets,
const std::vector< std::vector< unsigned int > > &  targetPoints,
double  targetOffset,
double  normalizationFactor 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::FastMarchingUpwindGradientImageFilter::ExecuteInternal ( const Image image1)
private
Image itk::simple::FastMarchingUpwindGradientImageFilter::GetGradientImage ( ) const
inline

Get the gradient image.

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 130 of file sitkFastMarchingUpwindGradientImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 141 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::GetNormalizationFactor ( ) const
inline

Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed.

Definition at line 123 of file sitkFastMarchingUpwindGradientImageFilter.h.

unsigned int itk::simple::FastMarchingUpwindGradientImageFilter::GetNumberOfTargets ( ) const
inline

Get the number of targets.

Definition at line 88 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetOffset ( ) const
inline

Get the TargetOffset ivar.

Definition at line 113 of file sitkFastMarchingUpwindGradientImageFilter.h.

std::vector< std::vector< unsigned int > > itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetPoints ( ) const
inline

Get the container of Target Points.

Definition at line 98 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::GetTargetValue ( ) const
inline

Get the arrival time corresponding to the last reached target. If TargetReachedMode is set to NoTargets, TargetValue contains the last (aka largest) Eikonal solution value generated.

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 138 of file sitkFastMarchingUpwindGradientImageFilter.h.

std::vector< std::vector< unsigned int > > itk::simple::FastMarchingUpwindGradientImageFilter::GetTrialPoints ( ) const
inline

Definition at line 74 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::SetNormalizationFactor ( double  NormalizationFactor)
inline

Set/Get the Normalization Factor for the Speed Image . The values in the Speed Image is divided by this factor. This allows the use of images with integer pixel types to represent the speed.

Definition at line 118 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::SetNumberOfTargets ( unsigned int  NumberOfTargets)
inline

Definition at line 83 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetOffset ( double  TargetOffset)
inline

Set how long (in terms of arrival times) after targets are reached the front must stop. This is useful to ensure that the level set of target arrival time is smooth.

Definition at line 108 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::SetTargetPoints ( const std::vector< std::vector< unsigned int > > &  TargetPoints)
inline

Set the container of Target Points. If a target point is reached, the propagation stops. Trial points are represented as a VectorContainer of LevelSetNodes.

Definition at line 93 of file sitkFastMarchingUpwindGradientImageFilter.h.

Self& itk::simple::FastMarchingUpwindGradientImageFilter::SetTrialPoints ( const std::vector< std::vector< unsigned int > > &  TrialPoints)
inline

Definition at line 70 of file sitkFastMarchingUpwindGradientImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 162 of file sitkFastMarchingUpwindGradientImageFilter.h.

Member Data Documentation

Image itk::simple::FastMarchingUpwindGradientImageFilter::m_GradientImage
private

Definition at line 173 of file sitkFastMarchingUpwindGradientImageFilter.h.

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

Definition at line 164 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::m_NormalizationFactor
private

Definition at line 171 of file sitkFastMarchingUpwindGradientImageFilter.h.

unsigned int itk::simple::FastMarchingUpwindGradientImageFilter::m_NumberOfTargets
private

Definition at line 168 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetOffset
private

Definition at line 170 of file sitkFastMarchingUpwindGradientImageFilter.h.

std::vector< std::vector<unsigned int> > itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetPoints
private

Definition at line 169 of file sitkFastMarchingUpwindGradientImageFilter.h.

double itk::simple::FastMarchingUpwindGradientImageFilter::m_TargetValue
private

Definition at line 175 of file sitkFastMarchingUpwindGradientImageFilter.h.

std::vector< std::vector<unsigned int> > itk::simple::FastMarchingUpwindGradientImageFilter::m_TrialPoints
private

Definition at line 167 of file sitkFastMarchingUpwindGradientImageFilter.h.


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