#include <itkFastMarchingUpwindGradientImageFilter.h>

Inheritance diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:

Collaboration diagram for itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >:

Detailed Description

template<class TLevelSet, class TSpeedImage = Image< float, TLevelSet ::ImageDimension >>
class itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >

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.

Author: Luca Antiga Ph.D. Biomedical Technologies Laboratory, Bioengineering Department, Mario Negri Institute, Italy.

Definition at line 61 of file itkFastMarchingUpwindGradientImageFilter.h.

Public Types
enum	{ NoTargets, OneTarget, SomeTargets, AllTargets }

typedef Superclass::AxisNodeType	AxisNodeType

typedef SmartPointer< const Self >	ConstPointer

typedef GradientImageType::Pointer	GradientImagePointer

typedef Image < GradientPixelType, itkGetStaticConstMacro(SetDimension) >	GradientImageType

typedef CovariantVector < PixelType, itkGetStaticConstMacro(SetDimension) >	GradientPixelType

typedef Superclass::IndexType	IndexType

typedef Superclass::LabelImageType	LabelImageType

typedef Superclass::LevelSetImageType	LevelSetImageType

typedef Superclass::LevelSetIndexType	LevelSetIndexType

typedef Superclass::LevelSetPointer	LevelSetPointer

typedef Superclass::LevelSetType	LevelSetType

typedef Superclass::NodeContainer	NodeContainer

typedef Superclass::NodeContainerPointer	NodeContainerPointer

typedef Superclass::NodeType	NodeType

typedef Superclass::OutputSpacingType	OutputSpacingType

typedef Superclass::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef Superclass::OutputPointType	PointType

typedef FastMarchingUpwindGradientImageFilter	Self

typedef Superclass::SpeedImageConstPointer	SpeedImageConstPointer

typedef Superclass::SpeedImageType	SpeedImageType

typedef FastMarchingImageFilter < TLevelSet, TSpeedImage >	Superclass

Public Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Index < itkGetStaticConstMacro(SetDimension) >	IndexType

typedef LabelImageType::Pointer	LabelImagePointer

typedef Image< unsigned char, itkGetStaticConstMacro(SetDimension) >	LabelImageType

enum	LabelType { FarPoint = 0, AlivePoint, TrialPoint, InitialTrialPoint, OutsidePoint }

typedef LevelSetType::LevelSetImageType	LevelSetImageType

typedef LevelSetType::LevelSetPointer	LevelSetPointer

typedef LevelSetTypeDefault < TLevelSet >	LevelSetType

typedef LevelSetType::NodeContainer	NodeContainer

typedef LevelSetType::NodeContainerPointer	NodeContainerPointer

typedef NodeType::IndexType	NodeIndexType

typedef LevelSetType::NodeType	NodeType

typedef LevelSetImageType::DirectionType	OutputDirectionType

typedef LevelSetImageType::PointType	OutputPointType

typedef LevelSetImageType::RegionType	OutputRegionType

typedef LevelSetImageType::SizeType	OutputSizeType

typedef LevelSetImageType::SpacingType	OutputSpacingType

typedef LevelSetType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef FastMarchingImageFilter	Self

typedef SpeedImageType::ConstPointer	SpeedImageConstPointer

typedef SpeedImageType::Pointer	SpeedImagePointer

typedef TSpeedImage	SpeedImageType

typedef ImageSource< TLevelSet >	Superclass

Public Types inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TSpeedImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TLevelSet >	Superclass

Public Types inherited from itk::ImageSource< TLevelSet >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TLevelSet	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

GradientImagePointer	GetGradientImage () const

virtual const char *	GetNameOfClass () const

virtual const SizeValueType &	GetNumberOfTargets ()

NodeContainerPointer	GetReachedTargetPoints ()

virtual const double &	GetTargetOffset ()

NodeContainerPointer	GetTargetPoints ()

virtual const double &	GetTargetValue ()

virtual void	SetGenerateGradientImage (bool _arg)

virtual void	SetTargetOffset (double _arg)

void	SetTargetReachedModeToAllTargets ()

	typedef (Concept::DivisionOperators< typename TLevelSet::PixelType, double >) LevelSetDoubleDivisionOperatorsCheck

	typedef (Concept::DivisionAndAssignOperators< typename TLevelSet::PixelType, double >) LevelSetDoubleDivisionAndAssignOperatorsCheck


void	SetTargetPoints (NodeContainer *points)


virtual const bool &	GetGenerateGradientImage ()

virtual void	GenerateGradientImageOn ()

virtual void	GenerateGradientImageOff ()


virtual void	SetTargetReachedMode (int _arg)

virtual const int &	GetTargetReachedMode ()

void	SetTargetReachedModeToNoTargets ()

void	SetTargetReachedModeToOneTarget ()

void	SetTargetReachedModeToSomeTargets (SizeValueType numberOfTargets)

Public Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
NodeContainerPointer	GetAlivePoints ()

LabelImagePointer	GetLabelImage () const

NodeContainerPointer	GetProcessedPoints () const

virtual const double &	GetSpeedConstant ()

virtual const double &	GetStoppingValue ()

NodeContainerPointer	GetTrialPoints ()

template<typename TPixel >
void	SetBinaryMask (Image< TPixel, SetDimension > *iImage)

virtual void	SetCollectPoints (bool _arg)

virtual void	SetStoppingValue (double _arg)

	typedef (Concept::SameDimension< SetDimension, SpeedImageDimension >) SameDimensionCheck

	typedef (Concept::Convertible< typename TSpeedImage::PixelType, double >) SpeedConvertibleToDoubleCheck

	typedef (Concept::Convertible< double, PixelType >) DoubleConvertibleToLevelSetCheck

	typedef (Concept::OStreamWritable< PixelType >) LevelSetOStreamWritableCheck

void	SetOutsidePoints (NodeContainer *points)

void	SetAlivePoints (NodeContainer *points)

void	SetTrialPoints (NodeContainer *points)

void	SetSpeedConstant (double value)

virtual void	SetNormalizationFactor (double _arg)

virtual double	GetNormalizationFactor () const

virtual const bool &	GetCollectPoints ()

virtual void	CollectPointsOn ()

virtual void	CollectPointsOff ()

virtual void	SetOutputSize (const OutputSizeType &size)

virtual OutputSizeType	GetOutputSize () const

virtual void	SetOutputRegion (OutputRegionType _arg)

virtual const OutputRegionType &	GetOutputRegion ()

virtual void	SetOutputSpacing (OutputSpacingType _arg)

virtual const OutputSpacingType &	GetOutputSpacing ()

virtual void	SetOutputDirection (OutputDirectionType _arg)

virtual const OutputDirectionType &	GetOutputDirection ()

virtual void	SetOutputOrigin (OutputPointType _arg)

virtual const OutputPointType &	GetOutputOrigin ()

virtual void	SetOverrideOutputInformation (bool _arg)

virtual const bool &	GetOverrideOutputInformation ()

virtual void	OverrideOutputInformationOn ()

virtual void	OverrideOutputInformationOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TSpeedImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TLevelSet >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData ()

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress ()

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	SetProgress (float _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static Pointer	New ()

Static Public Attributes
static const unsigned int	SetDimension = Superclass::SetDimension

Static Public Attributes inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
static const unsigned int	SetDimension = LevelSetType::SetDimension

static const unsigned int	SpeedImageDimension = SpeedImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TLevelSet >
static const unsigned int	OutputImageDimension

Protected Member Functions
virtual void	ComputeGradient (const IndexType &index, const LevelSetImageType output, const LabelImageType labelImage, GradientImageType *gradientImage)

	FastMarchingUpwindGradientImageFilter ()

void	GenerateData ()

virtual void	Initialize (LevelSetImageType *)

void	PrintSelf (std::ostream &os, Indent indent) const

virtual void	UpdateNeighbors (const IndexType &index, const SpeedImageType , LevelSetImageType )

	~FastMarchingUpwindGradientImageFilter ()

Protected Member Functions inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
virtual void	EnlargeOutputRequestedRegion (DataObject *output)

	FastMarchingImageFilter ()

virtual void	GenerateOutputInformation ()

virtual const PixelType &	GetLargeValue ()

virtual const LevelSetIndexType &	GetLastIndex ()

const AxisNodeType &	GetNodeUsedInCalculation (unsigned int idx) const

virtual const LevelSetIndexType &	GetStartIndex ()

virtual double	UpdateValue (const IndexType &index, const SpeedImageType , LevelSetImageType )

	~FastMarchingImageFilter ()

Protected Member Functions inherited from itk::ImageToImageFilter< TSpeedImage, TLevelSet >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	GenerateInputRequestedRegion ()

	ImageToImageFilter ()

virtual void	VerifyInputInformation ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TLevelSet >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

virtual	~ImageSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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 ()

Private Member Functions
	FastMarchingUpwindGradientImageFilter (const Self &)

void	operator= (const Self &)

Private Attributes
bool	m_GenerateGradientImage

GradientImagePointer	m_GradientImage

SizeValueType	m_NumberOfTargets

NodeContainerPointer	m_ReachedTargetPoints

double	m_TargetOffset

NodeContainerPointer	m_TargetPoints

int	m_TargetReachedMode

double	m_TargetValue

Additional Inherited Members
Protected Types inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
typedef LevelSetImageType::IndexType	LevelSetIndexType

Static Protected Member Functions inherited from itk::ImageSource< TLevelSet >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >
OutputRegionType	m_BufferedRegion

LevelSetIndexType	m_LastIndex

LevelSetIndexType	m_StartIndex