ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension > Class Template Reference

#include <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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::LevelSetNeighborhoodExtractor< TLevelSet >
virtual void SetInputLevelSet (const LevelSetImageType *_arg)
 
virtual const LevelSetImageTypeGetInputLevelSet () const
 
virtual void SetLevelSetValue (double _arg)
 
virtual double GetLevelSetValue () const
 
virtual void SetNarrowBandwidth (double _arg)
 
virtual double GetNarrowBandwidth () const
 
virtual void SetNarrowBanding (bool _arg)
 
virtual bool GetNarrowBanding () const
 
virtual void NarrowBandingOn ()
 
virtual void NarrowBandingOff ()
 
void SetInputNarrowBand (NodeContainer *ptr)
 
virtual NodeContainerGetModifiableInputNarrowBand ()
 
virtual const NodeContainerGetInputNarrowBand () const
 
NodeContainerPointer GetInsidePoints ()
 
NodeContainerPointer GetOutsidePoints ()
 
void Locate ()
 
- 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 SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float amount)
 
virtual void UpdateOutputData ()
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
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 ()
 

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
 
AuxValueContainer::Pointer m_AuxInsideValues
 
AuxValueContainer::Pointer m_AuxOutsideValues
 
AuxImageConstPointer m_AuxImage [VAuxDimension]
 
void SetAuxImage (const AuxImageType *ptr, unsigned int idx=0)
 
AuxImageConstPointer GetAuxImage (unsigned int idx=0)
 
virtual AuxValueContainerGetModifiableAuxInsideValues ()
 
virtual const AuxValueContainerGetAuxInsideValues () const
 
virtual AuxValueContainerGetModifiableAuxOutsideValues ()
 
virtual const AuxValueContainerGetAuxOutsideValues () const
 
 LevelSetVelocityNeighborhoodExtractor ()
 
 ~LevelSetVelocityNeighborhoodExtractor () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void Initialize () override
 
double CalculateDistance (Index &index) override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::LevelSetNeighborhoodExtractor< TLevelSet >
 LevelSetNeighborhoodExtractor ()
 
 ~LevelSetNeighborhoodExtractor () override=default
 
LevelSetImageType::PixelType GetLargeValue () const
 
const NodeTypeGetNodeUsedInCalculation (unsigned int idx) const
 
void GenerateData () override
 
bool GetLastPointIsInside () const
 
- Protected Member Functions inherited from itk::LightProcessObject
 LightProcessObject ()
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

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

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

Set the auxiliary images.

◆ ~LevelSetVelocityNeighborhoodExtractor()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::~LevelSetVelocityNeighborhoodExtractor ( )
overrideprotecteddefault

Set the auxiliary images.

Member Function Documentation

◆ CalculateDistance()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
double itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::CalculateDistance ( Index index)
overrideprotectedvirtual

Set the auxiliary images.

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ CreateAnother()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
virtual::itk::LightObject::Pointer itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::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::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.

◆ GetAuxInsideValues()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
virtual const AuxValueContainer* itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetAuxInsideValues ( ) const
virtual

Set the auxiliary images.

◆ GetAuxOutsideValues()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
virtual const AuxValueContainer* itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetAuxOutsideValues ( ) const
virtual

Set the auxiliary images.

◆ 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>
virtual const char* itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LevelSetNeighborhoodExtractor< TLevelSet >.

◆ Initialize()

template<typename TLevelSet , typename TAuxValue , unsigned int VAuxDimension = 1>
void itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::Initialize ( )
overrideprotectedvirtual

Set the auxiliary images.

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

Set the auxiliary images.

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

Set the auxiliary images.

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

Set the auxiliary images.

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

Set the auxiliary images.

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: