#include <itkFastMarchingImageFilter.h>

Detailed Description

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

Solve an Eikonal equation using Fast Marching.

Fast marching solves an Eikonal equation where the speed is always non-negative and depends on the position only. Starting from an initial position on the front, fast marching systematically moves the front forward one grid point at a time.

Updates are performed using an entropy satisfy scheme where only "upwind" neighborhoods are used. This implementation of Fast Marching uses a std::priority_queue to locate the next proper grid position to update.

Fast Marching sweeps through N grid points in (N log N) steps to obtain the arrival time value as the front propagates through the grid.

Implementation of this class is based on [107].

This class is templated over the level set image type and the speed image type. The initial front is specified by two containers: one containing the known points and one containing the trial points. Alive points are those that are already part of the object, and trial points are considered for inclusion. In order for the filter to evolve, at least some trial points must be specified. These can for instance be specified as the layer of pixels around the alive points.

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 in an approximate distance function from the initial alive points. FastMarchingImageFilter is used in the ReinitializeLevelSetImageFilter object to create a signed distance function from the zero level set.

The algorithm can be terminated early by setting an appropriate stopping value. The algorithm terminates when the current arrival time being processed is greater than the stopping value.

There are two ways to specify the output image information ( LargestPossibleRegion, Spacing, Origin): (a) it is copied directly from the input speed image or (b) 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 SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

For an alternative implementation, see itk::FastMarchingImageFilter.

Possible Improvements: In the current implementation, std::priority_queue only allows taking nodes out from the front and putting nodes in from the back. To update a value already on the heap, a new node is added to the heap. The defunct old node is left on the heap. When it is removed from the top, it will be recognized as invalid and not used. Future implementations can implement the heap in a different way allowing the values to be updated. This will generally require some sift-up and sift-down functions and an image of back-pointers going from the image to heap in order to locate the node which is to be updated.

See also: FastMarchingImageFilterBase; LevelSetTypeDefault

Examples: Examples/Iterators/NeighborhoodIterators6.cxx, Examples/Segmentation/CurvesLevelSetImageFilter.cxx, Examples/Segmentation/FastMarchingImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourImageFilter.cxx, Examples/Segmentation/GeodesicActiveContourShapePriorLevelSetImageFilter.cxx, Examples/Segmentation/ShapeDetectionLevelSetFilter.cxx, and Examples/Segmentation/ThresholdSegmentationLevelSetImageFilter.cxx.

Definition at line 133 of file itkFastMarchingImageFilter.h.

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

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

Classes
class	AxisNodeType

Public Types
using	ConstPointer = SmartPointer<const Self>

using	IndexType = Index<Self::SetDimension>

using	LabelEnum = FastMarchingImageFilterEnums::Label

using	LabelImagePointer = typename LabelImageType::Pointer

using	LabelImageType = Image<LabelEnum, Self::SetDimension>

using	LevelSetImageType = typename LevelSetType::LevelSetImageType

using	LevelSetPointer = typename LevelSetType::LevelSetPointer

using	LevelSetType = LevelSetTypeDefault<TLevelSet>

using	NodeContainer = typename LevelSetType::NodeContainer

using	NodeContainerPointer = typename LevelSetType::NodeContainerPointer

using	NodeIndexType = typename NodeType::IndexType

using	NodeType = typename LevelSetType::NodeType

using	OutputDirectionType = typename LevelSetImageType::DirectionType

using	OutputPointType = typename LevelSetImageType::PointType

using	OutputRegionType = typename LevelSetImageType::RegionType

using	OutputSizeType = typename LevelSetImageType::SizeType

using	OutputSpacingType = typename LevelSetImageType::SpacingType

using	PixelType = typename LevelSetType::PixelType

using	Pointer = SmartPointer<Self>

using	Self = FastMarchingImageFilter

using	SpeedImageConstPointer = typename SpeedImageType::ConstPointer

using	SpeedImagePointer = typename SpeedImageType::Pointer

using	SpeedImageType = TSpeedImage

using	Superclass = ImageToImageFilter<TSpeedImage, TLevelSet>

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	OutputImagePixelType

using	OutputImageRegionType

using	Pointer = SmartPointer<Self>

using	Self = ImageToImageFilter

using	Superclass = ImageSource<TOutputImage>

Public Types inherited from itk::ImageSource< TOutputImage >
using	ConstPointer = SmartPointer<const Self>

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer<Self>

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector<DataObjectPointer>

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	NameArray = std::vector<DataObjectIdentifierType>

using	Pointer = SmartPointer<Self>

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer<Self>

using	Self = LightObject

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

NodeContainerPointer	GetAlivePoints ()

LabelImagePointer	GetLabelImage () const

virtual const char *	GetNameOfClass () const

NodeContainerPointer	GetProcessedPoints () const

virtual const double &	GetSpeedConstant () const

virtual const double &	GetStoppingValue () const

NodeContainerPointer	GetTrialPoints ()

void	SetAlivePoints (NodeContainer *points)

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

virtual void	SetCollectPoints (bool _arg)

void	SetOutsidePoints (NodeContainer *points)

void	SetSpeedConstant (double value)

virtual void	SetStoppingValue (double _arg)

void	SetTrialPoints (NodeContainer *points)


virtual void	SetNormalizationFactor (double _arg)

virtual double	GetNormalizationFactor () const


virtual const bool &	GetCollectPoints () const

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 () 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::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *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< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

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

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

virtual void	GraftOutput (DataObject *graft)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

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

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderBase *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderBase *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

	itkVirtualSetClampMacro (NumberOfWorkUnits, ThreadIdType, 1, ITK_MAX_THREADS)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	SetDimension = LevelSetType::SetDimension

static constexpr unsigned int	SpeedImageDimension = SpeedImageType::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
using	LevelSetIndexType = typename LevelSetImageType::IndexType

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *output) override

	FastMarchingImageFilter ()

void	GenerateData () override

void	GenerateOutputInformation () override

virtual const PixelType &	GetLargeValue () const

virtual const LevelSetIndexType &	GetLastIndex () const

const AxisNodeType &	GetNodeUsedInCalculation (unsigned int idx) const

virtual const LevelSetIndexType &	GetStartIndex () const

virtual void	Initialize (LevelSetImageType *)

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

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

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

	~FastMarchingImageFilter () override=default

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

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

	~ImageSource () override=default

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions () const

	~ProcessObject () override

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

Protected Attributes
OutputRegionType	m_BufferedRegion {}

LevelSetIndexType	m_LastIndex {}

LevelSetIndexType	m_StartIndex {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Types
using	HeapContainer = std::vector<AxisNodeType>

using	HeapType = std::priority_queue<AxisNodeType, HeapContainer, NodeComparer>

using	NodeComparer = std::greater<AxisNodeType>

Private Attributes
NodeContainerPointer	m_AlivePoints {}

bool	m_CollectPoints {}

double	m_InverseSpeed {}

LabelImagePointer	m_LabelImage {}

LevelSetImageType::PixelType	m_LargeValue {}

AxisNodeType	m_NodesUsed [SetDimension] {}

double	m_NormalizationFactor {}

OutputDirectionType	m_OutputDirection {}

OutputPointType	m_OutputOrigin {}

OutputRegionType	m_OutputRegion {}

OutputSpacingType	m_OutputSpacing {}

NodeContainerPointer	m_OutsidePoints {}

bool	m_OverrideOutputInformation {}

NodeContainerPointer	m_ProcessedPoints {}

double	m_SpeedConstant {}

double	m_StoppingValue {}

HeapType	m_TrialHeap {}

NodeContainerPointer	m_TrialPoints {}

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject>
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Member Typedef Documentation

◆ ConstPointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::ConstPointer = SmartPointer<const Self>

Definition at line 142 of file itkFastMarchingImageFilter.h.

◆ HeapContainer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::HeapContainer = std::vector<AxisNodeType>

private

Trial points are stored in a min-heap. This allow efficient access to the trial point with minimum value which is the next grid point the algorithm processes.

Definition at line 457 of file itkFastMarchingImageFilter.h.

◆ HeapType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::HeapType = std::priority_queue<AxisNodeType, HeapContainer, NodeComparer>

private

Definition at line 459 of file itkFastMarchingImageFilter.h.

◆ IndexType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::IndexType = Index<Self::SetDimension>

Index type alias support

Definition at line 202 of file itkFastMarchingImageFilter.h.

◆ LabelEnum

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelEnum = FastMarchingImageFilterEnums::Label

Definition at line 204 of file itkFastMarchingImageFilter.h.

◆ LabelImagePointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImagePointer = typename LabelImageType::Pointer

LabelImagePointer type alias support

Definition at line 218 of file itkFastMarchingImageFilter.h.

◆ LabelImageType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LabelImageType = Image<LabelEnum, Self::SetDimension>

LabelImage type alias support

Definition at line 215 of file itkFastMarchingImageFilter.h.

◆ LevelSetImageType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetImageType = typename LevelSetType::LevelSetImageType

Definition at line 152 of file itkFastMarchingImageFilter.h.

◆ LevelSetIndexType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetIndexType = typename LevelSetImageType::IndexType

protected

Definition at line 424 of file itkFastMarchingImageFilter.h.

◆ LevelSetPointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetPointer = typename LevelSetType::LevelSetPointer

Definition at line 153 of file itkFastMarchingImageFilter.h.

◆ LevelSetType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::LevelSetType = LevelSetTypeDefault<TLevelSet>

Typedef support of level set method types.

Definition at line 151 of file itkFastMarchingImageFilter.h.

◆ NodeComparer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeComparer = std::greater<AxisNodeType>

private

Definition at line 458 of file itkFastMarchingImageFilter.h.

◆ NodeContainer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainer = typename LevelSetType::NodeContainer

Definition at line 157 of file itkFastMarchingImageFilter.h.

◆ NodeContainerPointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeContainerPointer = typename LevelSetType::NodeContainerPointer

Definition at line 158 of file itkFastMarchingImageFilter.h.

◆ NodeIndexType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeIndexType = typename NodeType::IndexType

Definition at line 156 of file itkFastMarchingImageFilter.h.

◆ NodeType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::NodeType = typename LevelSetType::NodeType

Definition at line 155 of file itkFastMarchingImageFilter.h.

◆ OutputDirectionType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputDirectionType = typename LevelSetImageType::DirectionType

Definition at line 162 of file itkFastMarchingImageFilter.h.

◆ OutputPointType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputPointType = typename LevelSetImageType::PointType

Definition at line 163 of file itkFastMarchingImageFilter.h.

◆ OutputRegionType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputRegionType = typename LevelSetImageType::RegionType

Definition at line 160 of file itkFastMarchingImageFilter.h.

◆ OutputSizeType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputSizeType = typename LevelSetImageType::SizeType

Definition at line 159 of file itkFastMarchingImageFilter.h.

◆ OutputSpacingType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OutputSpacingType = typename LevelSetImageType::SpacingType

Definition at line 161 of file itkFastMarchingImageFilter.h.

◆ PixelType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::PixelType = typename LevelSetType::PixelType

Definition at line 154 of file itkFastMarchingImageFilter.h.

◆ Pointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Pointer = SmartPointer<Self>

Definition at line 141 of file itkFastMarchingImageFilter.h.

◆ Self

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Self = FastMarchingImageFilter

Standard class typedefs.

Definition at line 139 of file itkFastMarchingImageFilter.h.

◆ SpeedImageConstPointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageConstPointer = typename SpeedImageType::ConstPointer

Definition at line 195 of file itkFastMarchingImageFilter.h.

◆ SpeedImagePointer

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImagePointer = typename SpeedImageType::Pointer

SpeedImagePointer type alias support

Definition at line 194 of file itkFastMarchingImageFilter.h.

◆ SpeedImageType

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageType = TSpeedImage

SpeedImage type alias support

Definition at line 191 of file itkFastMarchingImageFilter.h.

◆ Superclass

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

using itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Superclass = ImageToImageFilter<TSpeedImage, TLevelSet>

Definition at line 140 of file itkFastMarchingImageFilter.h.

Constructor & Destructor Documentation

◆ FastMarchingImageFilter()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter ( )

protected

◆ ~FastMarchingImageFilter()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::~FastMarchingImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CollectPointsOff()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::CollectPointsOff ( )

virtual

Get the Const Collect Points flag.

◆ CollectPointsOn()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::CollectPointsOn ( )

virtual

Get the Const Collect Points flag.

◆ CreateAnother()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual::itk::LightObject::Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >, itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >, and itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >.

◆ EnlargeOutputRequestedRegion()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::EnlargeOutputRequestedRegion ( DataObject * output )

overrideprotectedvirtual

Give the process object a chance to indicate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateData ( )

overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >, itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >, and itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >.

◆ GenerateOutputInformation()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

Generate the output image meta information.

Reimplemented from itk::ProcessObject.

◆ GetAlivePoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetAlivePoints ( )

inline

Get the container of Alive Points representing the initial front.

Definition at line 270 of file itkFastMarchingImageFilter.h.

◆ GetCollectPoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const bool & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetCollectPoints ( ) const

virtual

Get the Const Collect Points flag.

◆ GetLabelImage()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

LabelImagePointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLabelImage ( ) const

inline

Get the point type label image.

Definition at line 293 of file itkFastMarchingImageFilter.h.

◆ GetLargeValue()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const PixelType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLargeValue ( ) const

protectedvirtual

Get Large Value. This value is used to represent the concept of infinity for the time assigned to pixels that have not been visited. This value is set by default to half the max() of the pixel type used to represent the time-crossing map.

◆ GetLastIndex()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const LevelSetIndexType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetLastIndex ( ) const

protectedvirtual

◆ GetNameOfClass()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const char * itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >, itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >, itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >, itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >, itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >, and itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >.

◆ GetNodeUsedInCalculation()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

const AxisNodeType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNodeUsedInCalculation ( unsigned int idx ) const

inlineprotected

Definition at line 402 of file itkFastMarchingImageFilter.h.

◆ GetNormalizationFactor()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetNormalizationFactor ( ) const

virtual

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.

◆ GetOutputDirection()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const OutputDirectionType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputDirection ( ) const

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ GetOutputOrigin()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const OutputPointType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputOrigin ( ) const

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ GetOutputRegion()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const OutputRegionType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputRegion ( ) const

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ GetOutputSize()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual OutputSizeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputSize ( ) const

inlinevirtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

Definition at line 364 of file itkFastMarchingImageFilter.h.

◆ GetOutputSpacing()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const OutputSpacingType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOutputSpacing ( ) const

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ GetOverrideOutputInformation()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const bool & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetOverrideOutputInformation ( ) const

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ GetProcessedPoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetProcessedPoints ( ) const

inline

Get the container of Processed Points. If the CollectPoints flag is set, the algorithm collects a container of all processed nodes. This is useful for defining creating Narrowbands for level set algorithms that supports narrow banding.

Definition at line 346 of file itkFastMarchingImageFilter.h.

◆ GetSpeedConstant()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const double & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetSpeedConstant ( ) const

virtual

Get the Speed Constant.

◆ GetStartIndex()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const LevelSetIndexType & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetStartIndex ( ) const

protectedvirtual

◆ GetStoppingValue()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual const double & itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetStoppingValue ( ) const

virtual

Get the Fast Marching algorithm Stopping Value.

◆ GetTrialPoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::GetTrialPoints ( )

inline

Get the container of Trial Points representing the initial front.

Definition at line 286 of file itkFastMarchingImageFilter.h.

◆ Initialize()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::Initialize ( LevelSetImageType * )

protectedvirtual

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >, itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >, itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >, itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >, and itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >.

◆ New()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

static Pointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::New ( )

static

Method for creation through the object factory.

◆ OverrideOutputInformationOff()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OverrideOutputInformationOff ( )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ OverrideOutputInformationOn()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::OverrideOutputInformationOn ( )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ PrintSelf()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::LightObject.

Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >, itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >, and itk::FastMarchingUpwindGradientImageFilter< LevelSetImageType, SpeedImageType >.

◆ SetAlivePoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetAlivePoints ( NodeContainer * points )

inline

Set the container of Alive Points representing the initial front. Alive points are represented as a VectorContainer of LevelSetNodes.

Definition at line 262 of file itkFastMarchingImageFilter.h.

◆ SetBinaryMask()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

template<typename TPixel>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask ( Image< TPixel, SetDimension > * iImage )

inline

Definition at line 222 of file itkFastMarchingImageFilter.h.

◆ SetCollectPoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetCollectPoints ( bool _arg )

virtual

Set the Collect Points flag. Instrument the algorithm to collect a container of all nodes which it has visited. Useful for creating Narrowbands for level set algorithms that supports narrow banding.

◆ SetNormalizationFactor()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetNormalizationFactor ( double _arg )

virtual

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.

◆ SetOutputDirection()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputDirection ( OutputDirectionType _arg )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ SetOutputOrigin()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputOrigin ( OutputPointType _arg )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ SetOutputRegion()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputRegion ( OutputRegionType _arg )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ SetOutputSize()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputSize ( const OutputSizeType & size )

inlinevirtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

Definition at line 359 of file itkFastMarchingImageFilter.h.

◆ SetOutputSpacing()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutputSpacing ( OutputSpacingType _arg )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ SetOutsidePoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutsidePoints ( NodeContainer * points )

inline

Set the container of points that are not meant to be evaluated.

Definition at line 253 of file itkFastMarchingImageFilter.h.

◆ SetOverrideOutputInformation()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOverrideOutputInformation ( bool _arg )

virtual

The output largest possible, spacing and origin is computed as follows. If the speed image is nullptr or if the OverrideOutputInformation is true, the output information is set from user specified parameters. These parameters can be specified using methods SetOutputRegion(), SetOutputSpacing(), SetOutputDirection(), and SetOutputOrigin(). Else if the speed image is not nullptr, the output information is copied from the input speed image.

◆ SetSpeedConstant()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetSpeedConstant ( double value )

inline

Set the Speed Constant. If the Speed Image is nullptr, the SpeedConstant value is used for the whole level set. By default, the SpeedConstant is set to 1.0.

Definition at line 302 of file itkFastMarchingImageFilter.h.

◆ SetStoppingValue()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetStoppingValue ( double _arg )

virtual

Set the Fast Marching algorithm Stopping Value. The Fast Marching algorithm is terminated when the value of the smallest trial point is greater than the stopping value.

◆ SetTrialPoints()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetTrialPoints ( NodeContainer * points )

inline

Set the container of Trial Points representing the initial front. Trial points are represented as a VectorContainer of LevelSetNodes.

Definition at line 278 of file itkFastMarchingImageFilter.h.

◆ UpdateNeighbors()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual void itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateNeighbors	(	const IndexType &	index,
		const SpeedImageType *	,
		LevelSetImageType *	)

protectedvirtual

Reimplemented in itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >.

◆ UpdateValue()

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

virtual double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::UpdateValue	(	const IndexType &	index,
		const SpeedImageType *	,
		LevelSetImageType *	)

protectedvirtual

Reimplemented in itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >, and itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, SpeedImageType >.

Member Data Documentation

◆ m_AlivePoints

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_AlivePoints {}

private

Definition at line 432 of file itkFastMarchingImageFilter.h.

◆ m_BufferedRegion

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

OutputRegionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_BufferedRegion {}

protected

Definition at line 423 of file itkFastMarchingImageFilter.h.

◆ m_CollectPoints

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

bool itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_CollectPoints {}

private

Definition at line 442 of file itkFastMarchingImageFilter.h.

◆ m_InverseSpeed

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_InverseSpeed {}

private

Definition at line 439 of file itkFastMarchingImageFilter.h.

◆ m_LabelImage

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

LabelImagePointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_LabelImage {}

private

Definition at line 436 of file itkFastMarchingImageFilter.h.

◆ m_LargeValue

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

LevelSetImageType::PixelType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_LargeValue {}

private

Definition at line 451 of file itkFastMarchingImageFilter.h.

◆ m_LastIndex

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

LevelSetIndexType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_LastIndex {}

protected

Definition at line 426 of file itkFastMarchingImageFilter.h.

◆ m_NodesUsed

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

AxisNodeType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_NodesUsed[SetDimension] {}

private

Definition at line 452 of file itkFastMarchingImageFilter.h.

◆ m_NormalizationFactor

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_NormalizationFactor {}

private

Definition at line 463 of file itkFastMarchingImageFilter.h.

◆ m_OutputDirection

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

OutputDirectionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OutputDirection {}

private

Definition at line 448 of file itkFastMarchingImageFilter.h.

◆ m_OutputOrigin

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

OutputPointType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OutputOrigin {}

private

Definition at line 446 of file itkFastMarchingImageFilter.h.

◆ m_OutputRegion

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

OutputRegionType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OutputRegion {}

private

Definition at line 445 of file itkFastMarchingImageFilter.h.

◆ m_OutputSpacing

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

OutputSpacingType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OutputSpacing {}

private

Definition at line 447 of file itkFastMarchingImageFilter.h.

◆ m_OutsidePoints

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OutsidePoints {}

private

Definition at line 434 of file itkFastMarchingImageFilter.h.

◆ m_OverrideOutputInformation

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

bool itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_OverrideOutputInformation {}

private

Definition at line 449 of file itkFastMarchingImageFilter.h.

◆ m_ProcessedPoints

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_ProcessedPoints {}

private

Definition at line 443 of file itkFastMarchingImageFilter.h.

◆ m_SpeedConstant

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_SpeedConstant {}

private

Definition at line 438 of file itkFastMarchingImageFilter.h.

◆ m_StartIndex

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

LevelSetIndexType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_StartIndex {}

protected

Definition at line 425 of file itkFastMarchingImageFilter.h.

◆ m_StoppingValue

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

double itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_StoppingValue {}

private

Definition at line 440 of file itkFastMarchingImageFilter.h.

◆ m_TrialHeap

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

HeapType itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_TrialHeap {}

private

Definition at line 461 of file itkFastMarchingImageFilter.h.

◆ m_TrialPoints

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

NodeContainerPointer itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::m_TrialPoints {}

private

Definition at line 433 of file itkFastMarchingImageFilter.h.

◆ SetDimension

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

unsigned int itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetDimension = LevelSetType::SetDimension

staticconstexpr

Dimension of the level set and the speed image.

Definition at line 198 of file itkFastMarchingImageFilter.h.

◆ SpeedImageDimension

template<typename TLevelSet, typename TSpeedImage = Image<float, TLevelSet::ImageDimension>>

unsigned int itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SpeedImageDimension = SpeedImageType::ImageDimension

staticconstexpr

Definition at line 199 of file itkFastMarchingImageFilter.h.

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

itkFastMarchingImageFilter.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ HeapContainer

◆ HeapType

◆ IndexType

◆ LabelEnum

◆ LabelImagePointer

◆ LabelImageType

◆ LevelSetImageType

◆ LevelSetIndexType

◆ LevelSetPointer

◆ LevelSetType

◆ NodeComparer

◆ NodeContainer

◆ NodeContainerPointer

◆ NodeIndexType

◆ NodeType

◆ OutputDirectionType

◆ OutputPointType

◆ OutputRegionType

◆ OutputSizeType

◆ OutputSpacingType

◆ PixelType

◆ Pointer

◆ Self

◆ SpeedImageConstPointer

◆ SpeedImagePointer

◆ SpeedImageType

◆ Superclass

Constructor & Destructor Documentation

◆ FastMarchingImageFilter()

◆ ~FastMarchingImageFilter()

Member Function Documentation

◆ CollectPointsOff()

◆ CollectPointsOn()

◆ CreateAnother()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetAlivePoints()

◆ GetCollectPoints()

◆ GetLabelImage()

◆ GetLargeValue()

◆ GetLastIndex()

◆ GetNameOfClass()

◆ GetNodeUsedInCalculation()

◆ GetNormalizationFactor()

◆ GetOutputDirection()

◆ GetOutputOrigin()

◆ GetOutputRegion()

◆ GetOutputSize()

◆ GetOutputSpacing()

◆ GetOverrideOutputInformation()

◆ GetProcessedPoints()

◆ GetSpeedConstant()

◆ GetStartIndex()

◆ GetStoppingValue()

◆ GetTrialPoints()

◆ Initialize()

◆ New()

◆ OverrideOutputInformationOff()

◆ OverrideOutputInformationOn()

◆ PrintSelf()

◆ SetAlivePoints()

◆ SetBinaryMask()

◆ SetCollectPoints()

◆ SetNormalizationFactor()

◆ SetOutputDirection()