#include <itkFastMarchingImageFilterBase.h>

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

Inheritance diagram for itk::FastMarchingImageFilterBase< TInput, TOutput >:

Collaboration diagram for itk::FastMarchingImageFilterBase< TInput, TOutput >:

Public Types
using	ConnectedComponentImagePointer = typename ConnectedComponentImageType::Pointer

using	ConnectedComponentImageType = Image< unsigned int, ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	InputImagePointer = typename Superclass::InputDomainPointer

using	InputImageType = typename Superclass::InputDomainType

using	InternalNodeStructureArray = FixedArray< InternalNodeStructure, ImageDimension >

using	LabelImagePointer = typename LabelImageType::Pointer

using	LabelImageType = Image< unsigned char, ImageDimension >

using	NeighborhoodIteratorType = NeighborhoodIterator< LabelImageType >

using	NeighborhoodRadiusType = typename NeighborhoodIteratorType::RadiusType

using	NodePairContainerConstIterator = typename Traits::NodePairContainerConstIterator

using	NodePairContainerPointer = typename Traits::NodePairContainerPointer

using	NodePairContainerType = typename Traits::NodePairContainerType

using	NodePairType = typename Traits::NodePairType

using	NodeType = typename Traits::NodeType

using	OutputDirectionType = typename OutputImageType::DirectionType

using	OutputImagePointer = typename Superclass::OutputDomainPointer

using	OutputImageType = typename Superclass::OutputDomainType

using	OutputPointType = typename OutputImageType::PointType

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	OutputSpacingType = typename OutputImageType::SpacingType

using	Pointer = SmartPointer< Self >

using	Self = FastMarchingImageFilterBase

using	Superclass = FastMarchingBase< TInput, TOutput >

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

using	InputDomainPointer = typename Traits::InputDomainPointer

using	InputDomainType = typename Traits::InputDomainType

using	InputPixelType = typename Traits::InputPixelType

using	LabelType = typename Traits::LabelType

using	NodePairContainerConstIterator = typename Traits::NodePairContainerConstIterator

using	NodePairContainerPointer = typename Traits::NodePairContainerPointer

using	NodePairContainerType = typename Traits::NodePairContainerType

using	NodePairType = typename Traits::NodePairType

using	NodeType = typename Traits::NodeType

using	OutputDomainPointer = typename Traits::OutputDomainPointer

using	OutputDomainType = typename Traits::OutputDomainType

using	OutputPixelType = typename Traits::OutputPixelType

using	Pointer = SmartPointer< Self >

using	Self = FastMarchingBase

using	StoppingCriterionPointer = typename StoppingCriterionType::Pointer

using	StoppingCriterionType = FastMarchingStoppingCriterionBase< TInput, TOutput >

using	Superclass = typename FastMarchingTraits< TInput, TOutput >::SuperclassType

using	SuperclassType = typename Traits::SuperclassType

using	TopologyCheckEnum = FastMarchingTraitsEnums::TopologyCheck

using	Traits = FastMarchingTraits< TInput, TOutput >

Public Member Functions
virtual LabelImageType *	GetModifiableLabelImage ()

const char *	GetNameOfClass () const override


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

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

const char *	GetNameOfClass () const override

virtual double	GetNormalizationFactor ()

virtual double	GetSpeedConstant ()

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 (const TopologyCheckEnum _arg)

virtual const TopologyCheckEnum &	GetTopologyCheck () const

virtual void	SetTrialPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableTrialPoints ()

virtual void	SetAlivePoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableAlivePoints ()

virtual void	SetProcessedPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableProcessedPoints ()

virtual void	SetForbiddenPoints (NodePairContainerType *_arg)

virtual NodePairContainerType *	GetModifiableForbiddenPoints ()

virtual const bool &	GetCollectPoints () const

virtual void	CollectPointsOn ()

Static Public Member Functions
static Pointer	New ()

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

Protected Member Functions
bool	DoesVoxelChangeViolateStrictTopology (const NodeType &) const

bool	DoesVoxelChangeViolateWellComposedness (const NodeType &) const

void	EnlargeOutputRequestedRegion (DataObject *output) override

	FastMarchingImageFilterBase ()

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 *oImage, const NodeType &iNode, const OutputPixelType &iValue) override

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

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

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

	~FastMarchingImageFilterBase () override=default


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

void	InitializeOutput (OutputImageType *oImage) override

Protected Member Functions inherited from itk::FastMarchingBase< TInput, TOutput >
virtual bool	CheckTopology (OutputDomainType *oDomain, const NodeType &iNode)=0

	FastMarchingBase ()

void	GenerateData () override

virtual const OutputPixelType	GetOutputValue (OutputDomainType *oDomain, const NodeType &iNode) const =0

void	Initialize (OutputDomainType *oDomain)

virtual void	InitializeOutput (OutputDomainType *oDomain)=0

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

virtual void	SetOutputValue (OutputDomainType *oDomain, const NodeType &iNode, const OutputPixelType &iValue)=0

virtual void	UpdateNeighbors (OutputDomainType *oDomain, const NodeType &iNode)=0

virtual void	UpdateValue (OutputDomainType *oDomain, const NodeType &iNode)=0

	~FastMarchingBase () override=default

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 { false }

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 {}

TopologyCheckEnum	m_TopologyCheck {}

OutputPixelType	m_TopologyValue {}

NodePairContainerPointer	m_TrialPoints {}

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

using	NodeComparerType = std::greater< NodePairType >

using	PriorityQueueType = std::priority_queue< NodePairType, HeapContainerType, NodeComparerType >