SimpleITK
2.0.0
|
Generates the upwind gradient field of fast marching arrival times. More...
#include <sitkFastMarchingUpwindGradientImageFilter.h>
Public Types | |
using | PixelIDTypeList = BasicPixelIDTypeList |
using | Self = FastMarchingUpwindGradientImageFilter |
Public Types inherited from itk::simple::ImageFilter | |
using | Self = ImageFilter |
Public Types inherited from itk::simple::ProcessObject | |
using | Self = ProcessObject |
Public Member Functions | |
Self & | AddTargetPoint (std::vector< unsigned int > point) |
Add TargetPoints point. More... | |
Self & | AddTrialPoint (std::vector< unsigned int > point) |
Add TrialPoints point. More... | |
Self & | ClearTargetPoints () |
Remove all TargetPoints points. More... | |
Self & | ClearTrialPoints () |
Remove all TrialPoints points. More... | |
Image | Execute (const Image &image1) |
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 |
Self & | SetNormalizationFactor (double NormalizationFactor) |
Self & | SetNumberOfTargets (unsigned int NumberOfTargets) |
Self & | SetTargetOffset (double TargetOffset) |
Self & | SetTargetPoints (std::vector< std::vector< unsigned int > > TargetPoints) |
Self & | SetTrialPoints (std::vector< std::vector< unsigned int > > TrialPoints) |
std::string | ToString () const |
virtual | ~FastMarchingUpwindGradientImageFilter () |
Public Member Functions inherited from itk::simple::ImageFilter | |
ImageFilter () | |
virtual | ~ImageFilter ()=0 |
Public Member Functions inherited from itk::simple::ProcessObject | |
virtual void | Abort () |
virtual int | AddCommand (itk::simple::EventEnum event, const std::function< void()> &func) |
Directly add a callback to observe an event. More... | |
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 |
virtual void | SetNumberOfWorkUnits (unsigned int n) |
virtual unsigned int | GetNumberOfWorkUnits () const |
Private Types | |
using | MemberFunctionType = Image(Self::*)(const Image &image1) |
Private Member Functions | |
template<class TImageType > | |
Image | ExecuteInternal (const Image &image1) |
Private Attributes | |
Image | m_GradientImage {Image()} |
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > | m_MemberFactory |
double | m_NormalizationFactor {1.0} |
unsigned int | m_NumberOfTargets {0u} |
double | m_TargetOffset {1.0} |
std::vector< std::vector< unsigned int > > | m_TargetPoints {std::vector< std::vector<unsigned int > >()} |
double | m_TargetValue {0.0} |
std::vector< std::vector< unsigned int > > | m_TrialPoints {std::vector< std::vector<unsigned int > >()} |
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 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... | |
static bool | SetGlobalDefaultThreader (const std::string &threader) |
Set/Get the default threader used for process objects. More... | |
static std::string | GetGlobalDefaultThreader () |
Set/Get the default threader used for process objects. More... | |
static void | SetGlobalDefaultNumberOfThreads (unsigned int n) |
static unsigned int | GetGlobalDefaultNumberOfThreads () |
Set/Get the default threader used for process objects. More... | |
Protected Member Functions inherited from itk::simple::ImageFilter | |
void | CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name) |
Protected Member Functions inherited from itk::simple::ProcessObject | |
virtual unsigned long | AddITKObserver (const itk::EventObject &, itk::Command *) |
virtual itk::ProcessObject * | GetActiveProcess () |
virtual void | OnActiveProcessDelete () |
virtual void | onCommandDelete (const itk::simple::Command *cmd) noexcept |
virtual void | PreUpdate (itk::ProcessObject *p) |
virtual void | RemoveITKObserver (EventCommand &e) |
Protected Member Functions inherited from itk::simple::NonCopyable | |
NonCopyable ()=default | |
NonCopyable (const NonCopyable &)=delete | |
NonCopyable & | operator= (const NonCopyable &)=delete |
Static Protected Member Functions inherited from itk::simple::ImageFilter | |
template<class TImageType > | |
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 TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector> | |
static Image | CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img) |
template<class TImageType > | |
static Image | CastITKToImage (TImageType *img) |
static const itk::EventObject & | GetITKEventObject (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) |
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 traveling 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 .
Definition at line 52 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 155 of file sitkFastMarchingUpwindGradientImageFilter.h.
Define the pixels types supported by this filter
Definition at line 64 of file sitkFastMarchingUpwindGradientImageFilter.h.
using itk::simple::FastMarchingUpwindGradientImageFilter::Self = FastMarchingUpwindGradientImageFilter |
Definition at line 54 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
virtual |
Destructor
itk::simple::FastMarchingUpwindGradientImageFilter::FastMarchingUpwindGradientImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
|
inline |
Add TargetPoints point.
Definition at line 99 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Add TrialPoints point.
Definition at line 75 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Remove all TargetPoints points.
Definition at line 101 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Remove all TrialPoints points.
Definition at line 77 of file sitkFastMarchingUpwindGradientImageFilter.h.
Execute the filter on the input image
|
private |
|
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 129 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 141 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
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 122 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Get the number of targets.
Definition at line 87 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Get the TargetOffset ivar.
Definition at line 112 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Get the container of Target Points.
Definition at line 97 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
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 137 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Definition at line 73 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
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 117 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Definition at line 82 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
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 107 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
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 92 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
inline |
Definition at line 69 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 159 of file sitkFastMarchingUpwindGradientImageFilter.h.
Definition at line 175 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 161 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 172 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 166 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 170 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 168 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 177 of file sitkFastMarchingUpwindGradientImageFilter.h.
|
private |
Definition at line 164 of file sitkFastMarchingUpwindGradientImageFilter.h.