#include <itkFastMarchingImageToNodePairContainerAdaptor.h>

Detailed Description

template<typename TInput, typename TOutput, typename TImage>
class itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >

Convenient adaptor class which converts Image into FastMarching::NodePairContainerType used for initializing the FastMarching.

One provides images by means of SetAliveImage, SetTrialImage, SetForbiddenImage and get corresponding containers by means of GetAlivePoints, GetTrialPoints, GetForbiddenPoints.

One can globally set the associated value for all FastMarchingTraitsBase::Alive points by means of SetAliveValue; and for all FastMarchingTraitsBase::Trial points by means of SetTrialValue.

To restrict the evolution of the front in certain area, one can use SetForbiddenImage and SetIsForbiddenImageBinaryMask depending on the input image.

See also: FastMarchingTraitsBase; FastMarchingBase

Definition at line 50 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

Inheritance diagram for itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >:

Collaboration diagram for itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	ImageConstPointer = typename ImageType::ConstPointer

using	ImagePixelType = typename ImageType::PixelType

using	ImagePointer = typename ImageType::Pointer

using	ImageType = TImage

using	LabelType = typename Traits::LabelType

using	NodePairContainerPointer = typename Traits::NodePairContainerPointer

using	NodePairContainerType = typename Traits::NodePairContainerType

using	NodePairType = typename Traits::NodePairType

using	OutputPixelType = typename Traits::OutputPixelType

using	Pointer = SmartPointer<Self>

using	Self = FastMarchingImageToNodePairContainerAdaptor

using	Superclass = Object

using	Traits = FastMarchingTraits<TInput, TOutput>

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

virtual const ImageType *	GetAliveImage () const

NodePairContainerType *	GetAlivePoints ()

virtual OutputPixelType	GetAliveValue () const

virtual const ImageType *	GetForbiddenImage () const

NodePairContainerType *	GetForbiddenPoints ()

virtual bool	GetIsForbiddenImageBinaryMask () const

const char *	GetNameOfClass () const override

virtual const ImageType *	GetTrialImage () const

NodePairContainerType *	GetTrialPoints ()

virtual OutputPixelType	GetTrialValue () const

virtual void	IsForbiddenImageBinaryMaskOff ()

virtual void	IsForbiddenImageBinaryMaskOn ()

void	SetAliveImage (const ImageType *iImage)

virtual void	SetAliveValue (OutputPixelType _arg)

void	SetForbiddenImage (const ImageType *iImage)

virtual void	SetIsForbiddenImageBinaryMask (bool _arg)

void	SetTrialImage (const ImageType *iImage)

virtual void	SetTrialValue (OutputPixelType _arg)

void	Update ()

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

const char *	GetNameOfClass () const override

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::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	ImageDimension = Traits::ImageDimension

Protected Member Functions
	FastMarchingImageToNodePairContainerAdaptor ()

virtual void	GenerateData ()

void	SetPointsFromImage (const ImageType *image, const LabelType &iLabel, const OutputPixelType &iValue)

	~FastMarchingImageToNodePairContainerAdaptor () override=default

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

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

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

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

NodePairContainerPointer	m_AlivePoints {}

OutputPixelType	m_AliveValue {}

ImageConstPointer	m_ForbiddenImage {}

NodePairContainerPointer	m_ForbiddenPoints {}

bool	m_IsForbiddenImageBinaryMask { false }

ImageConstPointer	m_TrialImage {}

NodePairContainerPointer	m_TrialPoints {}

OutputPixelType	m_TrialValue {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ ImageConstPointer

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 76 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ ImagePixelType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImagePixelType = typename ImageType::PixelType

Definition at line 77 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ ImagePointer

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImagePointer = typename ImageType::Pointer

Definition at line 75 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ ImageType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageType = TImage

Definition at line 74 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ LabelType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::LabelType = typename Traits::LabelType

Definition at line 71 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ NodePairContainerPointer

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairContainerPointer = typename Traits::NodePairContainerPointer

Definition at line 70 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ NodePairContainerType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairContainerType = typename Traits::NodePairContainerType

Definition at line 69 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ NodePairType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::NodePairType = typename Traits::NodePairType

Definition at line 68 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ OutputPixelType

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::OutputPixelType = typename Traits::OutputPixelType

Definition at line 72 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ Pointer

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ Self

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Self = FastMarchingImageToNodePairContainerAdaptor

Definition at line 55 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ Superclass

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Superclass = Object

Definition at line 56 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ Traits

template<typename TInput, typename TOutput, typename TImage>

using itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Traits = FastMarchingTraits<TInput, TOutput>

Definition at line 67 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

Constructor & Destructor Documentation

◆ FastMarchingImageToNodePairContainerAdaptor()

template<typename TInput, typename TOutput, typename TImage>

itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::FastMarchingImageToNodePairContainerAdaptor ( )

protected

Constructor.

Referenced by GetNameOfClass().

◆ ~FastMarchingImageToNodePairContainerAdaptor()

template<typename TInput, typename TOutput, typename TImage>

itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::~FastMarchingImageToNodePairContainerAdaptor ( )

overrideprotecteddefault

Destructor.

Member Function Documentation

◆ CreateAnother()

template<typename TInput, typename TOutput, typename TImage>

virtual::itk::LightObject::Pointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::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.

◆ GenerateData()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GenerateData ( )

protectedvirtual

◆ GetAliveImage()

template<typename TInput, typename TOutput, typename TImage>

virtual const ImageType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAliveImage ( ) const

virtual

◆ GetAlivePoints()

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAlivePoints ( )

Get resulting Alive Points container.

◆ GetAliveValue()

template<typename TInput, typename TOutput, typename TImage>

virtual OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetAliveValue ( ) const

virtual

◆ GetForbiddenImage()

template<typename TInput, typename TOutput, typename TImage>

virtual const ImageType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetForbiddenImage ( ) const

virtual

◆ GetForbiddenPoints()

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetForbiddenPoints ( )

Get resulting Forbidden Points container.

◆ GetIsForbiddenImageBinaryMask()

template<typename TInput, typename TOutput, typename TImage>

virtual bool itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetIsForbiddenImageBinaryMask ( ) const

virtual

◆ GetNameOfClass()

template<typename TInput, typename TOutput, typename TImage>

const char * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References FastMarchingImageToNodePairContainerAdaptor().

◆ GetTrialImage()

template<typename TInput, typename TOutput, typename TImage>

virtual const ImageType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialImage ( ) const

virtual

◆ GetTrialPoints()

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerType * itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialPoints ( )

Get resulting Trial Points container.

◆ GetTrialValue()

template<typename TInput, typename TOutput, typename TImage>

virtual OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::GetTrialValue ( ) const

virtual

◆ IsForbiddenImageBinaryMaskOff()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::IsForbiddenImageBinaryMaskOff ( )

virtual

◆ IsForbiddenImageBinaryMaskOn()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::IsForbiddenImageBinaryMaskOn ( )

virtual

◆ New()

template<typename TInput, typename TOutput, typename TImage>

static Pointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::New ( )

static

Method for creation through the object factory.

◆ SetAliveImage()

template<typename TInput, typename TOutput, typename TImage>

void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetAliveImage ( const ImageType * iImage )

Set one Alive Image.

Note: Only pixels with non null values are considered as FastMarchingTraitsBase::Alive points.

◆ SetAliveValue()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetAliveValue ( OutputPixelType _arg )

virtual

◆ SetForbiddenImage()

template<typename TInput, typename TOutput, typename TImage>

void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetForbiddenImage ( const ImageType * iImage )

Set one Forbidden Image. There are two possible behaviors here depending on m_IsForbiddenImageBinaryMask:

if m_IsForbiddenImageBinaryMask is true, then the input image is a binary mask; thus null values are considered as FastMarchingTraitsBase::Forbidden points

else (m_IsForbiddenImageBinaryMask is false) non null values represents FastMarchingTraitsBase::Forbidden points

◆ SetIsForbiddenImageBinaryMask()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetIsForbiddenImageBinaryMask ( bool _arg )

virtual

◆ SetPointsFromImage()

template<typename TInput, typename TOutput, typename TImage>

void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetPointsFromImage	(	const ImageType *	image,
		const LabelType &	iLabel,
		const OutputPixelType &	iValue )

protected

◆ SetTrialImage()

template<typename TInput, typename TOutput, typename TImage>

void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetTrialImage ( const ImageType * iImage )

Set one Trial Image.

Note: Only pixels with non null values are considered as FastMarchingTraitsBase::TrialPoints.

◆ SetTrialValue()

template<typename TInput, typename TOutput, typename TImage>

virtual void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::SetTrialValue ( OutputPixelType _arg )

virtual

◆ Update()

template<typename TInput, typename TOutput, typename TImage>

void itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::Update ( )

Perform the conversion.

Member Data Documentation

◆ ImageDimension

template<typename TInput, typename TOutput, typename TImage>

unsigned int itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::ImageDimension = Traits::ImageDimension

staticconstexpr

Definition at line 79 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_AliveImage

template<typename TInput, typename TOutput, typename TImage>

ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AliveImage {}

protected

Definition at line 142 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_AlivePoints

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AlivePoints {}

protected

Definition at line 146 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_AliveValue

template<typename TInput, typename TOutput, typename TImage>

OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_AliveValue {}

protected

Definition at line 150 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_ForbiddenImage

template<typename TInput, typename TOutput, typename TImage>

ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_ForbiddenImage {}

protected

Definition at line 144 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_ForbiddenPoints

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_ForbiddenPoints {}

protected

Definition at line 148 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_IsForbiddenImageBinaryMask

template<typename TInput, typename TOutput, typename TImage>

bool itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_IsForbiddenImageBinaryMask { false }

protected

Definition at line 153 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_TrialImage

template<typename TInput, typename TOutput, typename TImage>

ImageConstPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialImage {}

protected

Definition at line 143 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_TrialPoints

template<typename TInput, typename TOutput, typename TImage>

NodePairContainerPointer itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialPoints {}

protected

Definition at line 147 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

◆ m_TrialValue

template<typename TInput, typename TOutput, typename TImage>

OutputPixelType itk::FastMarchingImageToNodePairContainerAdaptor< TInput, TOutput, TImage >::m_TrialValue {}

protected

Definition at line 151 of file itkFastMarchingImageToNodePairContainerAdaptor.h.

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

itkFastMarchingImageToNodePairContainerAdaptor.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ ImageConstPointer

◆ ImagePixelType

◆ ImagePointer

◆ ImageType

◆ LabelType

◆ NodePairContainerPointer

◆ NodePairContainerType

◆ NodePairType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

◆ Traits

Constructor & Destructor Documentation

◆ FastMarchingImageToNodePairContainerAdaptor()

◆ ~FastMarchingImageToNodePairContainerAdaptor()

Member Function Documentation

◆ CreateAnother()

◆ GenerateData()

◆ GetAliveImage()

◆ GetAlivePoints()

◆ GetAliveValue()

◆ GetForbiddenImage()

◆ GetForbiddenPoints()

◆ GetIsForbiddenImageBinaryMask()

◆ GetNameOfClass()

◆ GetTrialImage()

◆ GetTrialPoints()

◆ GetTrialValue()

◆ IsForbiddenImageBinaryMaskOff()

◆ IsForbiddenImageBinaryMaskOn()

◆ New()

◆ SetAliveImage()

◆ SetAliveValue()

◆ SetForbiddenImage()

◆ SetIsForbiddenImageBinaryMask()

◆ SetPointsFromImage()

◆ SetTrialImage()

◆ SetTrialValue()

◆ Update()

Member Data Documentation

◆ ImageDimension

◆ m_AliveImage

◆ m_AlivePoints

◆ m_AliveValue

◆ m_ForbiddenImage

◆ m_ForbiddenPoints

◆ m_IsForbiddenImageBinaryMask

◆ m_TrialImage

◆ m_TrialPoints

◆ m_TrialValue