ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType > Class Template Reference

#include <itkLevelSetFunctionWithRefitTerm.h>

+ Inheritance diagram for itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >:
+ Collaboration diagram for itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >:

Detailed Description

template<typename TImageType, typename TSparseImageType>
class itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >

This class extends the LevelSetFunction class by adding a grow term based on a target curvature stored in a sparse image.

We extend the LevelSetFunction class to add a refitting term. This refitting term forces the curvature of the level set interface to match a prescribed curvature. The prescribed curvature is provided in a sparse image format. The NodeType for the sparse image should contain the member variables m_Curvature and m_CurvatureFlag. The refitting term is defined as part of the propagation term of the original LevelSetFunction. To this purpose we defined the PropagationSpeed method which computes the refitting term and also adds to this term the value returned by the new virtual OtherPropagationSpeed. Therefore, classes derived from this class MUST NOT overwrite the PropagationSpeed method. Instead classes wishing to define a prapagtion term must define OtherPropagationSpeed.
IMPORTANT
Subclasses MUST NOT overwrite the PropagationSpeed method. Define OtherPropagationSpeed instead.

Definition at line 52 of file itkLevelSetFunctionWithRefitTerm.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef
Superclass::GlobalDataStruct 
GlobalDataStruct
 
typedef Superclass::ImageType ImageType
 
typedef ImageType::IndexType IndexType
 
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef
NeighborhoodType::SizeValueType 
NeighborhoodSizeValueType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef SparseImageType::NodeType NodeType
 
typedef NodeType::NodeDataType NormalVectorType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::ScalarValueType ScalarValueType
 
typedef
LevelSetFunctionWithRefitTerm 
Self
 
typedef TSparseImageType SparseImageType
 
typedef LevelSetFunction
< TImageType > 
Superclass
 
typedef Superclass::TimeStepType TimeStepType
 
- Public Types inherited from itk::LevelSetFunction< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef Superclass::ImageType ImageType
 
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef Superclass::PixelRealType PixelRealType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef PixelType ScalarValueType
 
typedef LevelSetFunction Self
 
typedef
FiniteDifferenceFunction
< TImageType > 
Superclass
 
typedef double TimeStepType
 
typedef FixedArray
< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) > 
VectorType
 
- Public Types inherited from itk::FiniteDifferenceFunction< TImageType >
typedef SmartPointer< const SelfConstPointer
 
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
 
typedef Vector< float,
itkGetStaticConstMacro(ImageDimension) > 
FloatOffsetType
 
typedef TImageType ImageType
 
typedef Vector< PixelRealType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodScalesType
 
typedef
ConstNeighborhoodIterator
< TImageType,
DefaultBoundaryConditionType
NeighborhoodType
 
typedef double PixelRealType
 
typedef ImageType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
ConstNeighborhoodIterator
< TImageType >::RadiusType 
RadiusType
 
typedef FiniteDifferenceFunction Self
 
typedef LightObject Superclass
 
typedef double TimeStepType
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
SparseImageTypeGetSparseTargetImage () const
 
void SetOtherPropagationWeight (const ScalarValueType w)
 
void SetRefitWeight (const ScalarValueType w)
 
void SetSparseTargetImage (SparseImageType *im)
 
- Public Member Functions inherited from itk::LevelSetFunction< TImageType >
virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
 
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0)) override
 
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void * GetGlobalDataPointer () const override
 
bool GetUseMinimalCurvature () const
 
virtual void Initialize (const RadiusType &r)
 
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
virtual void ReleaseGlobalDataPointer (void *GlobalData) const override
 
void SetUseMinimalCurvature (bool b)
 
void UseMinimalCurvatureOff ()
 
void UseMinimalCurvatureOn ()
 
virtual void SetAdvectionWeight (const ScalarValueType a)
 
ScalarValueType GetAdvectionWeight () const
 
virtual void SetPropagationWeight (const ScalarValueType p)
 
ScalarValueType GetPropagationWeight () const
 
virtual void SetCurvatureWeight (const ScalarValueType c)
 
ScalarValueType GetCurvatureWeight () const
 
void SetLaplacianSmoothingWeight (const ScalarValueType c)
 
ScalarValueType GetLaplacianSmoothingWeight () const
 
void SetEpsilonMagnitude (const ScalarValueType e)
 
ScalarValueType GetEpsilonMagnitude () const
 
- Public Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
const RadiusTypeGetRadius () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
virtual void InitializeIteration ()
 
void SetRadius (const RadiusType &r)
 
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
 
- 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
 
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::LevelSetFunction< TImageType >
static double GetMaximumCurvatureTimeStep ()
 
static double GetMaximumPropagationTimeStep ()
 
static Pointer New ()
 
static void SetMaximumCurvatureTimeStep (double n)
 
static void SetMaximumPropagationTimeStep (double n)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

ScalarValueType ComputeCurvature (const NeighborhoodType &) const
 
 LevelSetFunctionWithRefitTerm ()
 
virtual ScalarValueType OtherPropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const override
 
- Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
 LevelSetFunction ()
 
virtual ~LevelSetFunction ()
 
- Protected Member Functions inherited from itk::FiniteDifferenceFunction< TImageType >
 FiniteDifferenceFunction ()
 
 ~FiniteDifferenceFunction ()
 
- 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

ScalarValueType m_OtherPropagationWeight
 
ScalarValueType m_RefitWeight
 
- Protected Attributes inherited from itk::LevelSetFunction< TImageType >
ScalarValueType m_AdvectionWeight
 
OffsetValueType m_Center
 
ScalarValueType m_CurvatureWeight
 
ScalarValueType m_EpsilonMagnitude
 
ScalarValueType m_LaplacianSmoothingWeight
 
ScalarValueType m_PropagationWeight
 
bool m_UseMinimalCurvature
 
OffsetValueType m_xStride [itkGetStaticConstMacro(ImageDimension)]
 
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]
 
- Protected Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
RadiusType m_Radius
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 LevelSetFunctionWithRefitTerm (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

ScalarValueType m_MinVectorNorm
 
SparseImageType::Pointer m_SparseTargetImage
 

Static Private Attributes

static const ScalarValueType m_DimConst
 
static const
NeighborhoodSizeValueType 
m_NumVertex
 

Additional Inherited Members

- Static Public Attributes inherited from itk::LevelSetFunction< TImageType >
static const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::FiniteDifferenceFunction< TImageType >
static const unsigned int ImageDimension = ImageType::ImageDimension
 
- Static Protected Member Functions inherited from itk::LevelSetFunction< TImageType >
static VectorType InitializeZeroVectorConstant ()
 
- Static Protected Attributes inherited from itk::LevelSetFunction< TImageType >
static double m_DT
 
static double m_WaveDT
 
static VectorType m_ZeroVectorConstant
 

Member Typedef Documentation

template<typename TImageType , typename TSparseImageType >
typedef SmartPointer< const Self > itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ConstPointer

Definition at line 61 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::FloatOffsetType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::FloatOffsetType

Definition at line 71 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::GlobalDataStruct itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::GlobalDataStruct

Definition at line 73 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::ImageType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ImageType

Extract some parameters from the superclass.

Definition at line 67 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef ImageType::IndexType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::IndexType

Index type derived from the ImageType.

Definition at line 81 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::NeighborhoodScalesType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::NeighborhoodScalesType

Definition at line 75 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef NeighborhoodType::SizeValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::NeighborhoodSizeValueType

Definition at line 78 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::NeighborhoodType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::NeighborhoodType

Definition at line 74 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef SparseImageType::NodeType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::NodeType

The node type of the sparse image.

Definition at line 87 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef NodeType::NodeDataType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::NormalVectorType

The type for the normal vectors of the level set image.

Definition at line 90 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef SmartPointer< Self > itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::Pointer

Definition at line 60 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ScalarValueType

Definition at line 72 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef LevelSetFunctionWithRefitTerm itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::Self

Standard class typedefs.

Definition at line 58 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef TSparseImageType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SparseImageType

The sparse image type used for the curvature target.

Definition at line 84 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef LevelSetFunction< TImageType > itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::Superclass

Definition at line 59 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
typedef Superclass::TimeStepType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::TimeStepType

Definition at line 76 of file itkLevelSetFunctionWithRefitTerm.h.

Constructor & Destructor Documentation

template<typename TImageType , typename TSparseImageType >
itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::LevelSetFunctionWithRefitTerm ( )
protected
template<typename TImageType , typename TSparseImageType >
itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::LevelSetFunctionWithRefitTerm ( const Self )
private

Member Function Documentation

template<typename TImageType , typename TSparseImageType >
ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ComputeCurvature ( const NeighborhoodType ) const
protected

Computes the curvature of a level set neighbothood in a way that matches the curvature computation from normal vectors.

template<typename TImageType , typename TSparseImageType >
virtual TimeStepType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ComputeGlobalTimeStep ( void *  GlobalData) const
overridevirtual

Computes the time step for an update given a global data structure. This calls the ComputeGlobalTimeStep method defined in LevelSetFunction and then imposes our own restrictions for the refitting term on the returned value.

Reimplemented from itk::LevelSetFunction< TImageType >.

template<typename TImageType , typename TSparseImageType >
virtual::itk::LightObject::Pointer itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::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::LevelSetFunction< TImageType >.

template<typename TImageType , typename TSparseImageType >
virtual const char* itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::LevelSetFunction< TImageType >.

template<typename TImageType , typename TSparseImageType >
SparseImageType* itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::GetSparseTargetImage ( ) const
inline
template<typename TImageType , typename TSparseImageType >
static Pointer itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::New ( )
static

Standard New macro.

template<typename TImageType , typename TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::operator= ( const Self )
private
template<typename TImageType , typename TSparseImageType >
virtual ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::OtherPropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0 
) const
inlineprotectedvirtual

Called by PropagationSpeed and added on to the refitting term. Function classes derived from this class should define this method for their propagation speed, NOT the actual PropagationSpeed method.

Definition at line 145 of file itkLevelSetFunctionWithRefitTerm.h.

References itk::NumericTraits< T >::ZeroValue().

template<typename TImageType , typename TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::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::LevelSetFunction< TImageType >.

template<typename TImageType , typename TSparseImageType >
virtual ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::PropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0 
) const
overrideprotectedvirtual

Defines the virtual function in LevelSetFunction to add the refitting term. This function also calls OtherPropagationSpeed to provide a mechanism for subclasses to define other propagation terms.

template<typename TImageType , typename TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SetOtherPropagationWeight ( const ScalarValueType  w)
inline

This is the weight for propagation terms (other than refitting) that can be defined by subclasses.

Definition at line 100 of file itkLevelSetFunctionWithRefitTerm.h.

References itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_OtherPropagationWeight.

template<typename TImageType , typename TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SetRefitWeight ( const ScalarValueType  w)
inline

Set the relative weight of the refitting term.

Definition at line 93 of file itkLevelSetFunctionWithRefitTerm.h.

References itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_RefitWeight.

template<typename TImageType , typename TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SetSparseTargetImage ( SparseImageType im)
inline

Sets the sparse image which has nodes containing the member variable m_Curvature used in refitting.

Definition at line 107 of file itkLevelSetFunctionWithRefitTerm.h.

References itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_SparseTargetImage.

Member Data Documentation

template<typename TImageType , typename TSparseImageType >
const ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_DimConst
staticprivate

Definition at line 164 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_MinVectorNorm
private

The minimum vector norm parameter.

Definition at line 160 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
const NeighborhoodSizeValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_NumVertex
staticprivate

Constants used in computations.

Definition at line 163 of file itkLevelSetFunctionWithRefitTerm.h.

template<typename TImageType , typename TSparseImageType >
ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_OtherPropagationWeight
protected

The weight for other scalar propagation terms that can be defined by classes derived from this class.

Definition at line 126 of file itkLevelSetFunctionWithRefitTerm.h.

Referenced by itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SetOtherPropagationWeight().

template<typename TImageType , typename TSparseImageType >
ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_RefitWeight
protected

The weight for the refitting term.

Definition at line 122 of file itkLevelSetFunctionWithRefitTerm.h.

Referenced by itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::SetRefitWeight().

template<typename TImageType , typename TSparseImageType >
SparseImageType::Pointer itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_SparseTargetImage
private

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