Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType > Class Template Reference

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

#include <itkLevelSetFunctionWithRefitTerm.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
typedef Superclass::FloatOffsetType FloatOffsetType
typedef
Superclass::GlobalDataStruct 
GlobalDataStruct
typedef Superclass::ImageType ImageType
typedef ImageType::IndexType IndexType
typedef
Superclass::NeighborhoodScalesType 
NeighborhoodScalesType
typedef
Superclass::NeighborhoodType 
NeighborhoodType
typedef SparseImageType::NodeType NodeType
typedef NodeType::NodeDataType NormalVectorType
typedef Superclass::PixelRealType PixelRealType
typedef Superclass::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef Superclass::RadiusType RadiusType
typedef Superclass::ScalarValueType ScalarValueType
typedef
LevelSetFunctionWithRefitTerm 
Self
typedef TSparseImageType SparseImageType
typedef LevelSetFunction
< TImageType > 
Superclass
typedef Superclass::TimeStepType TimeStepType
typedef FixedArray
< ScalarValueType,
itkGetStaticConstMacro(ImageDimension)> 
VectorType

Public Member Functions

virtual VectorType AdvectionField (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual ScalarValueType Compute3DMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual TimeStepType ComputeGlobalTimeStep (void *GlobalData) const
virtual ScalarValueType ComputeMinimalCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
const NeighborhoodScalesType ComputeNeighborhoodScales () const
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &=FloatOffsetType(0.0))
virtual Pointer CreateAnother () const
virtual ScalarValueType CurvatureSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void Delete ()
virtual const char * GetNameOfClass () const
const RadiusTypeGetRadius () const
virtual int GetReferenceCount () const
SparseImageTypeGetSparseTargetImage () const
virtual void Initialize (const RadiusType &r)
virtual void InitializeIteration ()
 itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
 itkStaticConstMacro (ImageDimension, unsigned int, Superclass::ImageDimension)
virtual ScalarValueType LaplacianSmoothingSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
void Print (std::ostream &os, Indent indent=0) const
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void Register () const
virtual void ReleaseGlobalDataPointer (void *GlobalData) const
void SetOtherPropagationWeight (const ScalarValueType w)
void SetRadius (const RadiusType &r)
virtual void SetReferenceCount (int)
void SetRefitWeight (const ScalarValueType w)
void SetSparseTargetImage (SparseImageType *im)
virtual void UnRegister () const
virtual ScalarValueType ComputeCurvatureTerm (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
virtual ScalarValueType ComputeMeanCurvature (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *gd=0)
ScalarValueType GetAdvectionWeight () const
virtual void SetAdvectionWeight (const ScalarValueType a)
ScalarValueType GetCurvatureWeight () const
virtual void SetCurvatureWeight (const ScalarValueType c)
ScalarValueType GetEpsilonMagnitude () const
void SetEpsilonMagnitude (const ScalarValueType e)
virtual void * GetGlobalDataPointer () const
ScalarValueType GetLaplacianSmoothingWeight () const
void SetLaplacianSmoothingWeight (const ScalarValueType c)
ScalarValueType GetPropagationWeight () const
virtual void SetPropagationWeight (const ScalarValueType p)
bool GetUseMinimalCurvature () const
void SetUseMinimalCurvature (bool b)
void UseMinimalCurvatureOff ()
void UseMinimalCurvatureOn ()
void SetScaleCoefficients (PixelRealType vals[ImageDimension])

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static double GetMaximumCurvatureTimeStep ()
static void SetMaximumCurvatureTimeStep (double n)
static double GetMaximumPropagationTimeStep ()
static void SetMaximumPropagationTimeStep (double n)

Protected Types

typedef int InternalReferenceCountType

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
virtual ScalarValueType PropagationSpeed (const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct *=0) const
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Static Protected Member Functions

static VectorType InitializeZeroVectorConstant ()

Protected Attributes

ScalarValueType m_AdvectionWeight
::vcl_size_t m_Center
ScalarValueType m_CurvatureWeight
ScalarValueType m_EpsilonMagnitude
ScalarValueType m_LaplacianSmoothingWeight
ScalarValueType m_OtherPropagationWeight
ScalarValueType m_PropagationWeight
RadiusType m_Radius
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
ScalarValueType m_RefitWeight
PixelRealType m_ScaleCoefficients [ImageDimension]
bool m_UseMinimalCurvature
::vcl_size_t m_xStride [itkGetStaticConstMacro(ImageDimension)]
std::slice x_slice [itkGetStaticConstMacro(ImageDimension)]

Static Protected Attributes

static double m_DT
static double m_WaveDT
static VectorType m_ZeroVectorConstant


Detailed Description

template<class TImageType, class 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 50 of file itkLevelSetFunctionWithRefitTerm.h.


Member Typedef Documentation

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

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 59 of file itkLevelSetFunctionWithRefitTerm.h.

The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.

Definition at line 92 of file itkFiniteDifferenceFunction.h.

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

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 69 of file itkLevelSetFunctionWithRefitTerm.h.

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

Definition at line 71 of file itkLevelSetFunctionWithRefitTerm.h.

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

Extract some parameters from the superclass.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 65 of file itkLevelSetFunctionWithRefitTerm.h.

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

Index type derived from the ImageType.

Definition at line 77 of file itkLevelSetFunctionWithRefitTerm.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

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

The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 73 of file itkLevelSetFunctionWithRefitTerm.h.

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

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 72 of file itkLevelSetFunctionWithRefitTerm.h.

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

The node type of the sparse image.

Definition at line 83 of file itkLevelSetFunctionWithRefitTerm.h.

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

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

Definition at line 86 of file itkLevelSetFunctionWithRefitTerm.h.

typedef Superclass::PixelType itk::LevelSetFunction< TImageType >::PixelType [inherited]

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

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 58 of file itkLevelSetFunctionWithRefitTerm.h.

typedef Superclass::RadiusType itk::LevelSetFunction< TImageType >::RadiusType [inherited]

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

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 70 of file itkLevelSetFunctionWithRefitTerm.h.

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

Standard class typedefs.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 56 of file itkLevelSetFunctionWithRefitTerm.h.

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

The sparse image type used for the curvature target.

Definition at line 80 of file itkLevelSetFunctionWithRefitTerm.h.

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

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 57 of file itkLevelSetFunctionWithRefitTerm.h.

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

Convenient typedefs.

Reimplemented from itk::LevelSetFunction< TImageType >.

Definition at line 74 of file itkLevelSetFunctionWithRefitTerm.h.

typedef FixedArray<ScalarValueType, itkGetStaticConstMacro(ImageDimension)> itk::LevelSetFunction< TImageType >::VectorType [inherited]

The vector type that will be used in the calculations.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 96 of file itkLevelSetFunction.h.


Constructor & Destructor Documentation

template<class TImageType , class TSparseImageType >
itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::LevelSetFunctionWithRefitTerm (  )  [protected]


Member Function Documentation

virtual VectorType itk::LevelSetFunction< TImageType >::AdvectionField ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  = 0 
) const [inline, virtual, inherited]

Advection field. Default implementation returns a vector of zeros.

Definition at line 124 of file itkLevelSetFunction.h.

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual ScalarValueType itk::LevelSetFunction< TImageType >::Compute3DMinimalCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  gd = 0 
) [virtual, inherited]

template<class TImageType , class 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.

virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeCurvatureTerm ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  gd = 0 
) [virtual, inherited]

template<class TImageType , class TSparseImageType >
virtual TimeStepType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ComputeGlobalTimeStep ( void *  GlobalData  )  const [virtual]

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

virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMeanCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  gd = 0 
) [virtual, inherited]

virtual ScalarValueType itk::LevelSetFunction< TImageType >::ComputeMinimalCurvature ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  gd = 0 
) [virtual, inherited]

const NeighborhoodScalesType itk::FiniteDifferenceFunction< TImageType >::ComputeNeighborhoodScales (  )  const [inherited]

Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius

virtual PixelType itk::LevelSetFunction< TImageType >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType = FloatOffsetType(0.0) 
) [virtual, inherited]

virtual Pointer itk::LightObject::CreateAnother (  )  const [virtual, inherited]

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 in itk::Object.

virtual ScalarValueType itk::LevelSetFunction< TImageType >::CurvatureSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  = 0 
) const [inline, virtual, inherited]

Curvature speed. Can be used to spatially modify the effects of curvature . The default implementation returns one.

Definition at line 137 of file itkLevelSetFunction.h.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

ScalarValueType itk::LevelSetFunction< TImageType >::GetAdvectionWeight (  )  const [inline, inherited]

Alpha. Scales all advection term values.

Definition at line 152 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::GetCurvatureWeight (  )  const [inline, inherited]

Gamma. Scales all curvature weight values

Definition at line 166 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::GetEpsilonMagnitude (  )  const [inline, inherited]

Epsilon.

Definition at line 180 of file itkLevelSetFunction.h.

virtual void* itk::LevelSetFunction< TImageType >::GetGlobalDataPointer (  )  const [inline, virtual, inherited]

Returns a pointer to a global data structure that is passed to this object from the solver at each calculation. The idea is that the solver holds the state of any global values needed to calculate the time step, while the equation object performs the actual calculations. The global data should also be initialized in this method. Global data can be used for caching any values used or reused by the FunctionObject. Each thread should receive its own global data struct.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 204 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::GetLaplacianSmoothingWeight (  )  const [inline, inherited]

Weight of the laplacian smoothing term

Definition at line 173 of file itkLevelSetFunction.h.

static double itk::LevelSetFunction< TImageType >::GetMaximumCurvatureTimeStep (  )  [inline, static, inherited]

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 274 of file itkLevelSetFunction.h.

static double itk::LevelSetFunction< TImageType >::GetMaximumPropagationTimeStep (  )  [inline, static, inherited]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 288 of file itkLevelSetFunction.h.

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

Run-time type information (and related methods)

Reimplemented from itk::LevelSetFunction< TImageType >.

ScalarValueType itk::LevelSetFunction< TImageType >::GetPropagationWeight (  )  const [inline, inherited]

Beta. Scales all propagation term values.

Definition at line 159 of file itkLevelSetFunction.h.

const RadiusType& itk::FiniteDifferenceFunction< TImageType >::GetRadius ( void   )  const [inline, inherited]

Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

Definition at line 146 of file itkFiniteDifferenceFunction.h.

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TImageType , class TSparseImageType >
SparseImageType* itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::GetSparseTargetImage (  )  const [inline]

Returns the sparse image.

Definition at line 107 of file itkLevelSetFunctionWithRefitTerm.h.

bool itk::LevelSetFunction< TImageType >::GetUseMinimalCurvature (  )  const [inline, inherited]

Definition at line 252 of file itkLevelSetFunction.h.

virtual void itk::LevelSetFunction< TImageType >::Initialize ( const RadiusType &  r  )  [virtual, inherited]

This method creates the appropriate member variable operators for the level-set calculations. The argument to this function is a the radius necessary for performing the level-set calculations.

Reimplemented in itk::SegmentationLevelSetFunction< TImageType, TFeatureImageType >.

virtual void itk::FiniteDifferenceFunction< TImageType >::InitializeIteration (  )  [inline, virtual, inherited]

This method allows the function to set its state before each iteration of the finite difference solver (image filter) that uses it. This is a thread-safe time to manipulate the object's state.

An example of how this can be used: the Anisotropic diffusion class of FiniteDifferenceFunctions use this method to pre-calculate an average gradient magnitude across the entire image region. This value is set in the function object and used by the ComputeUpdate methods that are called at each pixel as a constant.

Definition at line 118 of file itkFiniteDifferenceFunction.h.

static VectorType itk::LevelSetFunction< TImageType >::InitializeZeroVectorConstant (  )  [static, protected, inherited]

This method's only purpose is to initialize the zero vector constant.

itk::FiniteDifferenceFunction< TImageType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
ImageType::ImageDimension   
) [inherited]

Save image dimension.

itk::LevelSetFunction< TImageType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
Superclass::ImageDimension   
) [inherited]

virtual ScalarValueType itk::LevelSetFunction< TImageType >::LaplacianSmoothingSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  = 0 
) const [inline, virtual, inherited]

Laplacian smoothing speed. Can be used to spatially modify the effects of laplacian smoothing of the level set function

Definition at line 144 of file itkLevelSetFunction.h.

template<class TImageType , class TSparseImageType >
static Pointer itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::New (  )  [static]

Standard New macro.

Reimplemented from itk::LevelSetFunction< TImageType >.

template<class TImageType , class TSparseImageType >
virtual ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::OtherPropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0 
) const [inline, protected, virtual]

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 141 of file itkLevelSetFunctionWithRefitTerm.h.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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.

template<class TImageType , class TSparseImageType >
void itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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.

virtual ScalarValueType itk::LevelSetFunction< TImageType >::PropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct *  = 0 
) const [inline, virtual, inherited]

Propagation speed. This term controls surface expansion/contraction. Default implementation returns zero.

Definition at line 130 of file itkLevelSetFunction.h.

template<class TImageType , class TSparseImageType >
virtual ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::PropagationSpeed ( const NeighborhoodType ,
const FloatOffsetType ,
GlobalDataStruct = 0 
) const [protected, virtual]

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.

virtual void itk::LightObject::Register (  )  const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented in itk::Object.

virtual void itk::LevelSetFunction< TImageType >::ReleaseGlobalDataPointer ( void *  GlobalData  )  const [inline, virtual, inherited]

When the finite difference solver filter has finished using a global data pointer, it passes it to this method, which frees the memory. The solver cannot free the memory because it does not know the type to which the pointer points.

Implements itk::FiniteDifferenceFunction< TImageType >.

Reimplemented in itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >, and itk::ShapePriorSegmentationLevelSetFunction< TImageType, TFeatureImageType >.

Definition at line 223 of file itkLevelSetFunction.h.

virtual void itk::LevelSetFunction< TImageType >::SetAdvectionWeight ( const ScalarValueType  a  )  [inline, virtual, inherited]

Alpha. Scales all advection term values.

Definition at line 150 of file itkLevelSetFunction.h.

virtual void itk::LevelSetFunction< TImageType >::SetCurvatureWeight ( const ScalarValueType  c  )  [inline, virtual, inherited]

Gamma. Scales all curvature weight values

Definition at line 164 of file itkLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::SetEpsilonMagnitude ( const ScalarValueType  e  )  [inline, inherited]

Epsilon.

Definition at line 178 of file itkLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::SetLaplacianSmoothingWeight ( const ScalarValueType  c  )  [inline, inherited]

Weight of the laplacian smoothing term

Definition at line 171 of file itkLevelSetFunction.h.

static void itk::LevelSetFunction< TImageType >::SetMaximumCurvatureTimeStep ( double  n  )  [inline, static, inherited]

Set/Get the maximum constraint for the curvature term factor in the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 270 of file itkLevelSetFunction.h.

static void itk::LevelSetFunction< TImageType >::SetMaximumPropagationTimeStep ( double  n  )  [inline, static, inherited]

Set/Get the maximum constraint for the scalar/vector term factor of the time step calculation. Changing this value from the default is not recommended or necessary, but can be used to speed up the surface evolution at the risk of creating an unstable solution.

Definition at line 284 of file itkLevelSetFunction.h.

template<class TImageType , class 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 96 of file itkLevelSetFunctionWithRefitTerm.h.

virtual void itk::LevelSetFunction< TImageType >::SetPropagationWeight ( const ScalarValueType  p  )  [inline, virtual, inherited]

Beta. Scales all propagation term values.

Definition at line 157 of file itkLevelSetFunction.h.

void itk::FiniteDifferenceFunction< TImageType >::SetRadius ( const RadiusType &  r  )  [inline, inherited]

Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

Definition at line 141 of file itkFiniteDifferenceFunction.h.

virtual void itk::LightObject::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count on this object. This is a dangerous method, use it with care.

Reimplemented in itk::Object.

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

Set the relative weight of the refitting term.

Definition at line 89 of file itkLevelSetFunctionWithRefitTerm.h.

void itk::FiniteDifferenceFunction< TImageType >::SetScaleCoefficients ( PixelRealType  vals[ImageDimension]  )  [inline, inherited]

Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.

Definition at line 152 of file itkFiniteDifferenceFunction.h.

template<class TImageType , class 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 103 of file itkLevelSetFunctionWithRefitTerm.h.

void itk::LevelSetFunction< TImageType >::SetUseMinimalCurvature ( bool  b  )  [inline, inherited]

Definition at line 248 of file itkLevelSetFunction.h.

virtual void itk::LightObject::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented in itk::Object.

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOff (  )  [inline, inherited]

Definition at line 260 of file itkLevelSetFunction.h.

void itk::LevelSetFunction< TImageType >::UseMinimalCurvatureOn (  )  [inline, inherited]

Definition at line 256 of file itkLevelSetFunction.h.


Member Data Documentation

ScalarValueType itk::LevelSetFunction< TImageType >::m_AdvectionWeight [protected, inherited]

Alpha.

Definition at line 332 of file itkLevelSetFunction.h.

:: vcl_size_t itk::LevelSetFunction< TImageType >::m_Center [protected, inherited]

The offset of the center pixel in the neighborhood.

Definition at line 314 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_CurvatureWeight [protected, inherited]

Gamma.

Definition at line 338 of file itkLevelSetFunction.h.

double itk::LevelSetFunction< TImageType >::m_DT [static, protected, inherited]

Definition at line 308 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_EpsilonMagnitude [protected, inherited]

Epsilon magnitude controls the lower limit for gradient magnitude.

Definition at line 329 of file itkLevelSetFunction.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_LaplacianSmoothingWeight [protected, inherited]

Laplacean smoothing term

Definition at line 341 of file itkLevelSetFunction.h.

template<class TImageType , class 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 122 of file itkLevelSetFunctionWithRefitTerm.h.

ScalarValueType itk::LevelSetFunction< TImageType >::m_PropagationWeight [protected, inherited]

Beta.

Definition at line 335 of file itkLevelSetFunction.h.

RadiusType itk::FiniteDifferenceFunction< TImageType >::m_Radius [protected, inherited]

Definition at line 203 of file itkFiniteDifferenceFunction.h.

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<class TImageType , class TSparseImageType >
ScalarValueType itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::m_RefitWeight [protected]

The weight for the refitting term.

Definition at line 118 of file itkLevelSetFunctionWithRefitTerm.h.

PixelRealType itk::FiniteDifferenceFunction< TImageType >::m_ScaleCoefficients[ImageDimension] [protected, inherited]

Definition at line 204 of file itkFiniteDifferenceFunction.h.

bool itk::LevelSetFunction< TImageType >::m_UseMinimalCurvature [protected, inherited]

Definition at line 319 of file itkLevelSetFunction.h.

double itk::LevelSetFunction< TImageType >::m_WaveDT [static, protected, inherited]

Constants used in the time step calculation.

Definition at line 307 of file itkLevelSetFunction.h.

:: vcl_size_t itk::LevelSetFunction< TImageType >::m_xStride[itkGetStaticConstMacro(ImageDimension)] [protected, inherited]

Stride length along the y-dimension.

Definition at line 317 of file itkLevelSetFunction.h.

VectorType itk::LevelSetFunction< TImageType >::m_ZeroVectorConstant [static, protected, inherited]

Zero vector constant.

Definition at line 326 of file itkLevelSetFunction.h.

std::slice itk::LevelSetFunction< TImageType >::x_slice[itkGetStaticConstMacro(ImageDimension)] [protected, inherited]

Slices for the ND neighborhood.

Definition at line 311 of file itkLevelSetFunction.h.


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

Generated at Tue Sep 15 10:15:35 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000