Detailed Description

template<typename TInput, typename TOutput>
class itk::FastMarchingImageFilterBase< TInput, TOutput >

Apply the Fast Marching method to solve an Eikonal equation on an image.

The speed function can be specified as a speed image or a speed constant. The speed image is set using the method SetInput(). If the speed image is ITK_NULLPTR, a constant speed function is used and is specified using method the SetSpeedConstant().

If the speed function is constant and of value one, fast marching results is an approximate distance function from the initial alive points.

There are two ways to specify the output image information (LargestPossibleRegion, Spacing, Origin):

it is copied directly from the input speed image
it is specified by the user. Default values are used if the user does not specify all the information.

The output information is computed as follows.

If the speed image is ITK_NULLPTR or if the OverrideOutputInformation is set to true, the output information is set from user specified parameters. These parameters can be specified using methods

Else the output information is copied from the input speed image.

Implementation of this class is based on Chapter 8 of "Level Set Methods and Fast Marching Methods", J.A. Sethian, Cambridge Press, Second edition, 1999.

For an alternative implementation, see itk::FastMarchingImageFilter.

Template Parameters

TTraits traits

See Also: FastMarchingImageFilter; ImageFastMarchingTraits; ImageFastMarchingTraits2

Examples:: SphinxExamples/src/Filtering/FastMarching/CreateDistanceMapFromSeeds/Code.cxx.

Definition at line 75 of file itkFastMarchingImageFilterBase.h.

Public Types
typedef ConnectedComponentImageType::Pointer	ConnectedComponentImagePointer

typedef Image< unsigned int, ImageDimension >	ConnectedComponentImageType

typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::InputDomainPointer	InputImagePointer

typedef Superclass::InputDomainType	InputImageType

typedef Superclass::InputPixelType	InputPixelType

typedef FixedArray < InternalNodeStructure, ImageDimension >	InternalNodeStructureArray

typedef LabelImageType::Pointer	LabelImagePointer

typedef Image< unsigned char, ImageDimension >	LabelImageType

typedef Superclass::LabelType	LabelType

typedef NeighborhoodIterator < LabelImageType >	NeighborhoodIteratorType

typedef NeighborhoodIteratorType::RadiusType	NeighborhoodRadiusType

typedef Traits::NodePairContainerConstIterator	NodePairContainerConstIterator

typedef Traits::NodePairContainerPointer	NodePairContainerPointer

typedef Traits::NodePairContainerType	NodePairContainerType

typedef Traits::NodePairType	NodePairType

typedef Traits::NodeType	NodeType

typedef OutputImageType::DirectionType	OutputDirectionType

typedef Superclass::OutputDomainPointer	OutputImagePointer

typedef Superclass::OutputDomainType	OutputImageType

typedef Superclass::OutputPixelType	OutputPixelType

typedef OutputImageType::PointType	OutputPointType

typedef OutputImageType::RegionType	OutputRegionType

typedef OutputImageType::SizeType	OutputSizeType

typedef OutputImageType::SpacingType	OutputSpacingType

typedef SmartPointer< Self >	Pointer

typedef FastMarchingImageFilterBase	Self

typedef FastMarchingBase < TInput, TOutput >	Superclass

typedef Superclass::Traits	Traits

Public Types inherited from itk::FastMarchingBase< TInput, TOutput >
typedef SmartPointer< const Self >	ConstPointer

typedef Traits::InputDomainPointer	InputDomainPointer

typedef Traits::InputDomainType	InputDomainType

typedef Traits::InputPixelType	InputPixelType

typedef Traits::LabelType	LabelType

typedef Traits::NodePairContainerConstIterator	NodePairContainerConstIterator

typedef Traits::NodePairContainerPointer	NodePairContainerPointer

typedef Traits::NodePairContainerType	NodePairContainerType

typedef Traits::NodePairType	NodePairType

typedef Traits::NodeType	NodeType

typedef Traits::OutputDomainPointer	OutputDomainPointer

typedef Traits::OutputDomainType	OutputDomainType

typedef Traits::OutputPixelType	OutputPixelType

typedef SmartPointer< Self >	Pointer

typedef FastMarchingBase	Self

typedef StoppingCriterionType::Pointer	StoppingCriterionPointer

typedef FastMarchingStoppingCriterionBase < TInput, TOutput >	StoppingCriterionType

typedef SuperclassType	Superclass

typedef Traits::SuperclassType	SuperclassType

enum	TopologyCheckType { Nothing = 0, NoHandles, Strict }

typedef FastMarchingTraits < TInput, TOutput >	Traits

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

virtual const LabelImageType *	GetLabelImage () const

virtual LabelImageType *	GetModifiableLabelImage ()

virtual const char *	GetNameOfClass () const


virtual void	SetOutputSize (const OutputSizeType &size)

virtual OutputSizeType	GetOutputSize () const

virtual void	SetOutputRegion (OutputRegionType _arg)

virtual const OutputRegionType &	GetOutputRegion () const

virtual void	SetOutputSpacing (OutputSpacingType _arg)

virtual const OutputSpacingType &	GetOutputSpacing () const

virtual void	SetOutputDirection (OutputDirectionType _arg)

virtual const OutputDirectionType &	GetOutputDirection () const

virtual void	SetOutputOrigin (OutputPointType _arg)

virtual const OutputPointType &	GetOutputOrigin () const

virtual void	SetOverrideOutputInformation (bool _arg)

virtual const bool &	GetOverrideOutputInformation () const

virtual void	OverrideOutputInformationOn ()

virtual void	OverrideOutputInformationOff ()

Public Member Functions inherited from itk::FastMarchingBase< TInput, TOutput >
virtual StoppingCriterionType *	GetModifiableStoppingCriterion ()

virtual double	GetNormalizationFactor ()

virtual double	GetSpeedConstant ()

virtual const StoppingCriterionType *	GetStoppingCriterion () const

virtual OutputPixelType	GetTargetReachedValue ()

virtual void	SetCollectPoints (bool _arg)

virtual void	SetNormalizationFactor (double _arg)

virtual void	SetSpeedConstant (double _arg)

virtual void	SetStoppingCriterion (StoppingCriterionType *_arg)

virtual void	SetTopologyCheck (TopologyCheckType _arg)

virtual const TopologyCheckType &	GetTopologyCheck () const

virtual void	SetTrialPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableTrialPoints ()

virtual const NodePairContainerType *	GetTrialPoints () const

virtual void	SetAlivePoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableAlivePoints ()

virtual const NodePairContainerType *	GetAlivePoints () const

virtual void	SetProcessedPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableProcessedPoints ()

virtual const NodePairContainerType *	GetProcessedPoints () const

virtual void	SetForbiddenPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableForbiddenPoints ()

virtual const NodePairContainerType *	GetForbiddenPoints () const

virtual const bool &	GetCollectPoints () const

virtual void	CollectPointsOn ()

virtual void	CollectPointsOff ()

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Traits::ImageDimension

Protected Member Functions
bool	DoesVoxelChangeViolateStrictTopology (const NodeType &) const

bool	DoesVoxelChangeViolateWellComposedness (const NodeType &) const

virtual void	EnlargeOutputRequestedRegion (DataObject *output) override

	FastMarchingImageFilterBase ()

virtual void	GenerateOutputInformation () override

void	GetInternalNodesUsed (OutputImageType *oImage, const NodeType &iNode, InternalNodeStructureArray &ioNodesUsed)

unsigned char	GetLabelValueForGivenNode (const NodeType &iNode) const override

const OutputPixelType	GetOutputValue (OutputImageType *oImage, const NodeType &iNode) const override

IdentifierType	GetTotalNumberOfNodes () const override

void	InitializeIndices2D ()

void	InitializeIndices3D ()

bool	IsChangeWellComposed2D (const NodeType &) const

bool	IsChangeWellComposed3D (const NodeType &) const

bool	IsCriticalC1Configuration2D (const std::bitset< 9 > &) const

bool	IsCriticalC1Configuration3D (const std::bitset< 8 > &) const

bool	IsCriticalC2Configuration2D (const std::bitset< 9 > &) const

unsigned int	IsCriticalC2Configuration3D (const std::bitset< 8 > &) const

bool	IsCriticalC3Configuration2D (const std::bitset< 9 > &) const

bool	IsCriticalC4Configuration2D (const std::bitset< 9 > &) const

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

void	SetLabelValueForGivenNode (const NodeType &iNode, const LabelType &iLabel) override

void	SetOutputValue (OutputImageType *oDomain, const NodeType &iNode, const OutputPixelType &iValue) override

double	Solve (OutputImageType *oImage, const NodeType &iNode, InternalNodeStructureArray &ioNeighbors) const

virtual void	UpdateNeighbors (OutputImageType *oImage, const NodeType &iNode) override

virtual void	UpdateValue (OutputImageType *oImage, const NodeType &iValue) override

virtual	~FastMarchingImageFilterBase () override


bool	CheckTopology (OutputImageType *oImage, const NodeType &iNode) override

void	InitializeOutput (OutputImageType *oImage) override

Protected Member Functions inherited from itk::FastMarchingBase< TInput, TOutput >
	FastMarchingBase ()

void	GenerateData () override

void	Initialize (OutputDomainType *oDomain)

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

virtual	~FastMarchingBase () override

Protected Attributes
OutputRegionType	m_BufferedRegion

Array< unsigned char >	m_C1Indices [12]

Array< unsigned char >	m_C2Indices [8]

ConnectedComponentImagePointer	m_ConnectedComponentImage

const InputImageType *	m_InputCache

LabelImagePointer	m_LabelImage

NodeType	m_LastIndex

OutputDirectionType	m_OutputDirection

OutputPointType	m_OutputOrigin

OutputRegionType	m_OutputRegion

OutputSpacingType	m_OutputSpacing

bool	m_OverrideOutputInformation

Array< unsigned char >	m_ReflectionIndices [2]

Array< unsigned char >	m_RotationIndices [4]

NodeType	m_StartIndex

Protected Attributes inherited from itk::FastMarchingBase< TInput, TOutput >
NodePairContainerPointer	m_AlivePoints

bool	m_CollectPoints

NodePairContainerPointer	m_ForbiddenPoints

PriorityQueueType	m_Heap

double	m_InverseSpeed

OutputPixelType	m_LargeValue

double	m_NormalizationFactor

NodePairContainerPointer	m_ProcessedPoints

double	m_SpeedConstant

StoppingCriterionPointer	m_StoppingCriterion

OutputPixelType	m_TargetReachedValue

TopologyCheckType	m_TopologyCheck

OutputPixelType	m_TopologyValue

NodePairContainerPointer	m_TrialPoints

Additional Inherited Members
Protected Types inherited from itk::FastMarchingBase< TInput, TOutput >
typedef std::vector< NodePairType >	HeapContainerType

typedef std::greater < NodePairType >	NodeComparerType

typedef std::priority_queue < NodePairType, HeapContainerType, NodeComparerType >	PriorityQueueType