#include <itkLevelSetVelocityNeighborhoodExtractor.h>

Detailed Description

template<typename TLevelSet, typename TAuxValue, unsigned int VAuxDimension = 1>
class itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >

Locate pixels of a particular level set.

LevelSetVelocityNeighborhoodExtractor extends the functionality of LevelSetNeighborhoodExtractor by also extracting the values of velocity variables at the specified level set. Specifically, it populates two containers: one containing the value of velocity variables immediately inside the contour defined by the level set and the other containing values for velocity variables immediately outside.

The containers AuxInsideValues() and AuxOutsideValues() can be used in conjunction with Superclass::InsidePoints() and Superclass::OutsidePoints() in FastMarchingExtensionImageFilter to produce images which extends the velocity variables smoothly from the specified level set.

This class is templated over the image type representing the level set, the type of the auxiliary/velocity variables and the number of auxiliary/velocity variables.

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

Definition at line 54 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Inheritance diagram for itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >:

Collaboration diagram for itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >:

Public Types
using	AuxImageConstPointer = typename AuxVarType::AuxImageConstPointer

using	AuxImagePointer = typename AuxVarType::AuxImagePointer

using	AuxImageType = typename AuxVarType::AuxImageType

using	AuxValueContainer = typename AuxVarType::AuxValueContainer

using	AuxValueType = typename AuxVarType::AuxValueType

using	AuxValueVectorType = typename AuxVarType::AuxValueVectorType

using	AuxVarType = AuxVarTypeDefault< TAuxValue, VAuxDimension, Self::SetDimension >

using	ConstPointer = SmartPointer< const Self >

using	Index = itk::Index< Self::SetDimension >

using	LevelSetType = LevelSetTypeDefault< TLevelSet >

using	Pointer = SmartPointer< Self >

using	Self = LevelSetVelocityNeighborhoodExtractor

using	Superclass = LevelSetNeighborhoodExtractor< TLevelSet >

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

using	IndexType = Index< Self::SetDimension >

using	LevelSetConstPointer = typename LevelSetType::LevelSetConstPointer

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	NodeType = typename LevelSetType::NodeType

using	PixelType = typename LevelSetType::PixelType

using	Pointer = SmartPointer< Self >

using	Self = LevelSetNeighborhoodExtractor

using	Superclass = LightProcessObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

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 AuxValueContainer *	GetModifiableAuxInsideValues ()

virtual AuxValueContainer *	GetModifiableAuxOutsideValues ()

const char *	GetNameOfClass () const override


void	SetAuxImage (const AuxImageType *ptr, unsigned int idx=0)


AuxImageConstPointer	GetAuxImage (unsigned int idx=0)

Public Member Functions inherited from itk::LevelSetNeighborhoodExtractor< TLevelSet >
NodeContainerPointer	GetInsidePoints ()

virtual double	GetLevelSetValue () const

const char *	GetNameOfClass () const override

virtual double	GetNarrowBandwidth () const

NodeContainerPointer	GetOutsidePoints ()

void	Locate ()

virtual void	SetLevelSetValue (double _arg)

virtual void	SetNarrowBanding (bool _arg)

virtual void	SetNarrowBandwidth (double _arg)

virtual void	SetInputLevelSet (const LevelSetImageType *_arg)

virtual const LevelSetImageType *	GetInputLevelSet () const

virtual bool	GetNarrowBanding () const

virtual void	NarrowBandingOn ()

void	SetInputNarrowBand (NodeContainer *ptr)

virtual NodeContainer *	GetModifiableInputNarrowBand ()

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

const char *	GetNameOfClass () const override

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () 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

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

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

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

Static Public Member Functions inherited from itk::LightProcessObject
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	SetDimension = LevelSetType::SetDimension

Static Public Attributes inherited from itk::LevelSetNeighborhoodExtractor< TLevelSet >
static constexpr unsigned int	SetDimension = LevelSetType::SetDimension

Protected Member Functions
double	CalculateDistance (Index &index) override

void	Initialize () override

	LevelSetVelocityNeighborhoodExtractor ()

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

	~LevelSetVelocityNeighborhoodExtractor () override=default

Protected Member Functions inherited from itk::LevelSetNeighborhoodExtractor< TLevelSet >
virtual double	CalculateDistance (IndexType &index)

void	GenerateData () override

LevelSetImageType::PixelType	GetLargeValue () const

bool	GetLastPointIsInside () const

const NodeType &	GetNodeUsedInCalculation (unsigned int idx) const

virtual void	Initialize ()

	LevelSetNeighborhoodExtractor ()

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

	~LevelSetNeighborhoodExtractor () override=default

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

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

	~LightProcessObject () override

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	PrintSelf (std::ostream &os, Indent indent) const

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

virtual	~LightObject ()

Private Attributes
AuxImageConstPointer	m_AuxImage [VAuxDimension] {}

AuxValueContainer::Pointer	m_AuxInsideValues {}

AuxValueContainer::Pointer	m_AuxOutsideValues {}

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

Member Typedef Documentation

◆ AuxImageConstPointer

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImageConstPointer = typename AuxVarType::AuxImageConstPointer

Definition at line 87 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxImagePointer

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImagePointer = typename AuxVarType::AuxImagePointer

Definition at line 86 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxImageType

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImageType = typename AuxVarType::AuxImageType

Definition at line 85 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxValueContainer

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueContainer = typename AuxVarType::AuxValueContainer

Definition at line 84 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxValueType

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueType = typename AuxVarType::AuxValueType

Definition at line 82 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxValueVectorType

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueVectorType = typename AuxVarType::AuxValueVectorType

Definition at line 83 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ AuxVarType

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxVarType = AuxVarTypeDefault<TAuxValue, VAuxDimension, Self::SetDimension>

AuxVarType type alias support

Definition at line 81 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ ConstPointer

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ Index

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Index = itk::Index<Self::SetDimension>

Index type alias support

Definition at line 78 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ LevelSetType

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::LevelSetType = LevelSetTypeDefault<TLevelSet>

The type of the level set.

Definition at line 72 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ Pointer

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ Self

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Self = LevelSetVelocityNeighborhoodExtractor

Standard class typedefs.

Definition at line 60 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ Superclass

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

using itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Superclass = LevelSetNeighborhoodExtractor<TLevelSet>

Definition at line 61 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Constructor & Destructor Documentation

◆ LevelSetVelocityNeighborhoodExtractor()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::LevelSetVelocityNeighborhoodExtractor ( )

protected

◆ ~LevelSetVelocityNeighborhoodExtractor()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::~LevelSetVelocityNeighborhoodExtractor ( )

overrideprotecteddefault

Member Function Documentation

◆ CalculateDistance()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

double itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::CalculateDistance ( Index & index )

overrideprotectedvirtual

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ GetAuxImage()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

AuxImageConstPointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetAuxImage ( unsigned int idx = 0 )

inline

Get the auxiliary images.

Definition at line 103 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ GetModifiableAuxInsideValues()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

virtual AuxValueContainer * itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetModifiableAuxInsideValues ( )

virtual

Get the container of auxiliary values associated with the inside points.

◆ GetModifiableAuxOutsideValues()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

virtual AuxValueContainer * itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetModifiableAuxOutsideValues ( )

virtual

Get the container of auxiliary values associate with the outside points.

◆ GetNameOfClass()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

const char * itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ Initialize()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Initialize ( )

overrideprotectedvirtual

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ New()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

static Pointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::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::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ SetAuxImage()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::SetAuxImage	(	const AuxImageType *	ptr,
		unsigned int	idx = `0`
	)

inline

Set the auxiliary images.

Definition at line 91 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Member Data Documentation

◆ m_AuxImage

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

AuxImageConstPointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::m_AuxImage[VAuxDimension] {}

private

Definition at line 139 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ m_AuxInsideValues

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

AuxValueContainer::Pointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::m_AuxInsideValues {}

private

Definition at line 137 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ m_AuxOutsideValues

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

AuxValueContainer::Pointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::m_AuxOutsideValues {}

private

Definition at line 138 of file itkLevelSetVelocityNeighborhoodExtractor.h.

◆ SetDimension

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>

constexpr unsigned int itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::SetDimension = LevelSetType::SetDimension

staticconstexpr

The dimension of the level set.

Definition at line 75 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

itkLevelSetVelocityNeighborhoodExtractor.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AuxImageConstPointer

◆ AuxImagePointer

◆ AuxImageType

◆ AuxValueContainer

◆ AuxValueType

◆ AuxValueVectorType

◆ AuxVarType

◆ ConstPointer

◆ Index

◆ LevelSetType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LevelSetVelocityNeighborhoodExtractor()

◆ ~LevelSetVelocityNeighborhoodExtractor()

Member Function Documentation

◆ CalculateDistance()

◆ GetAuxImage()

◆ GetModifiableAuxInsideValues()

◆ GetModifiableAuxOutsideValues()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ PrintSelf()

◆ SetAuxImage()

Member Data Documentation

◆ m_AuxImage

◆ m_AuxInsideValues

◆ m_AuxOutsideValues

◆ SetDimension