#include <itkLevelSetVelocityNeighborhoodExtractor.h>

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

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

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.

Implemenation 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 58 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Public Types
typedef AuxVarType::AuxImageConstPointer	AuxImageConstPointer

typedef AuxVarType::AuxImagePointer	AuxImagePointer

typedef AuxVarType::AuxImageType	AuxImageType

typedef AuxVarType::AuxValueContainer	AuxValueContainer

typedef AuxVarType::AuxValueType	AuxValueType

typedef AuxVarType::AuxValueVectorType	AuxValueVectorType

typedef AuxVarTypeDefault < TAuxValue, VAuxDimension, itkGetStaticConstMacro(SetDimension) >	AuxVarType

typedef SmartPointer< const Self >	ConstPointer

typedef LevelSetTypeDefault < TLevelSet >	LevelSetType

typedef SmartPointer< Self >	Pointer

typedef LevelSetVelocityNeighborhoodExtractor	Self

typedef LevelSetNeighborhoodExtractor < TLevelSet >	Superclass

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

typedef Index < itkGetStaticConstMacro(SetDimension) >	IndexType

typedef LevelSetType::LevelSetConstPointer	LevelSetConstPointer

typedef LevelSetType::LevelSetImageType	LevelSetImageType

typedef LevelSetType::LevelSetPointer	LevelSetPointer

typedef LevelSetTypeDefault < TLevelSet >	LevelSetType

typedef LevelSetType::NodeContainer	NodeContainer

typedef LevelSetType::NodeContainerPointer	NodeContainerPointer

typedef LevelSetType::NodeType	NodeType

typedef LevelSetType::PixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef LevelSetNeighborhoodExtractor	Self

typedef LightProcessObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightProcessObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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

virtual const AuxValueContainer *	GetAuxInsideValues () const

virtual const AuxValueContainer *	GetAuxOutsideValues () const

virtual AuxValueContainer *	GetModifiableAuxInsideValues ()

virtual AuxValueContainer *	GetModifiableAuxOutsideValues ()

virtual const char *	GetNameOfClass () const


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

virtual double	GetNarrowBandwidth () const

NodeContainerPointer	GetOutsidePoints (void)

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

virtual void	NarrowBandingOff ()

void	SetInputNarrowBand (NodeContainer *ptr)

virtual NodeContainer *	GetModifiableInputNarrowBand ()

virtual const NodeContainer *	GetInputNarrowBand () const

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

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

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

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

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

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

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

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

static Pointer	New ()

Public Attributes
typedef::itk::Index < itkGetStaticConstMacro(SetDimension) >	Index

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

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

Protected Member Functions
virtual double	CalculateDistance (Index &index)

virtual void	Initialize ()

	LevelSetVelocityNeighborhoodExtractor ()

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

	~LevelSetVelocityNeighborhoodExtractor ()

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

virtual void	GenerateData () ITK_OVERRIDE

LevelSetImageType::PixelType	GetLargeValue () const

bool	GetLastPointIsInside () const

const NodeType &	GetNodeUsedInCalculation (unsigned int idx) const

	LevelSetNeighborhoodExtractor ()

	~LevelSetNeighborhoodExtractor ()

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

	~LightProcessObject ()

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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

Private Member Functions
	LevelSetVelocityNeighborhoodExtractor (const Self &)

void	operator= (const Self &)

Private Attributes
AuxImageConstPointer	m_AuxImage [VAuxDimension]

AuxValueContainer::Pointer	m_AuxInsideValues

AuxValueContainer::Pointer	m_AuxOutsideValues

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

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

typedef AuxVarType::AuxImageConstPointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImageConstPointer

Definition at line 93 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarType::AuxImagePointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImagePointer

Definition at line 92 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarType::AuxImageType itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxImageType

Definition at line 91 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarType::AuxValueContainer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueContainer

Definition at line 90 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarType::AuxValueType itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueType

Definition at line 88 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarType::AuxValueVectorType itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxValueVectorType

Definition at line 89 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef AuxVarTypeDefault< TAuxValue, VAuxDimension, itkGetStaticConstMacro(SetDimension) > itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::AuxVarType

AuxVarType typedef support.

Definition at line 87 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

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

Definition at line 66 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef LevelSetTypeDefault< TLevelSet > itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::LevelSetType

The type of the level set.

Definition at line 73 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

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

Definition at line 65 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef LevelSetVelocityNeighborhoodExtractor itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Self

Standard class typdedefs.

Definition at line 63 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

typedef LevelSetNeighborhoodExtractor< TLevelSet > itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Superclass

Definition at line 64 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Constructor & Destructor Documentation

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

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

protected

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

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

inlineprotected

Definition at line 130 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::LevelSetVelocityNeighborhoodExtractor ( const Self & )

private

Member Function Documentation

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

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

protectedvirtual

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

virtual::itk::LightObject::Pointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::CreateAnother ( void ) 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::LevelSetNeighborhoodExtractor< TLevelSet >.

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 107 of file itkLevelSetVelocityNeighborhoodExtractor.h.

References itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::m_AuxImage.

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

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

virtual

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

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

virtual

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.

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.

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

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

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

protectedvirtual

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

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.

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

void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::operator= ( const Self & )

private

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

void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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

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 96 of file itkLevelSetVelocityNeighborhoodExtractor.h.

References itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::m_AuxImage, and itk::Object::Modified().

Member Data Documentation

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

typedef::itk::Index< itkGetStaticConstMacro(SetDimension) > itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Index

Index typedef support

Definition at line 83 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

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

private

Definition at line 145 of file itkLevelSetVelocityNeighborhoodExtractor.h.

Referenced by itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetAuxImage(), and itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::SetAuxImage().

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

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

private

Definition at line 143 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

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

private

Definition at line 144 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

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

static

The dimension of the level set.

Definition at line 80 of file itkLevelSetVelocityNeighborhoodExtractor.h.

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

itkLevelSetVelocityNeighborhoodExtractor.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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