ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Reference
Image Functions | Module ITKSignedDistanceFunction

Base class for functions which evaluates the signed distance from a shape. More...

#include <itkShapeSignedDistanceFunction.h>

Inheritance diagram for itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >:
Collaboration diagram for itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TCoordRep CoordRepType
typedef Superclass::InputType InputType
typedef Superclass::OutputType OutputType
typedef OptimizerParameters
< double > 		ParametersType
typedef SmartPointer< Self > Pointer
typedef InputType PointType
typedef ShapeSignedDistanceFunction Self
typedef SpatialFunction
< double, VSpaceDimension,
Point< TCoordRep,
VSpaceDimension > > 		Superclass

Public Member Functions

virtual OutputType Evaluate (const PointType &point) const =0
virtual const char * GetNameOfClass () const
virtual unsigned int GetNumberOfParameters (void) const
virtual unsigned int GetNumberOfPoseParameters (void) const =0
virtual unsigned int GetNumberOfShapeParameters (void) const =0
virtual ParametersType & GetParameters (void)
virtual void Initialize () throw ( ExceptionObject )
virtual void SetParameters (const ParametersType &)=0

Static Public Attributes

static const unsigned int SpaceDimension = VSpaceDimension

Protected Member Functions

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

Protected Attributes

ParametersType m_Parameters

Private Member Functions

void operator= (const Self &)
 ShapeSignedDistanceFunction (const Self &)

Detailed Description

template<typename TCoordRep, unsigned int VSpaceDimension>
class itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >

Base class for functions which evaluates the signed distance from a shape.

ShapeSignedDistanceFunction is the base class for functions which returns the signed distance from a shape at an arbitrary point. A shape assumed to be defined by a set of shape and pose parameters.

Note that Initialize() must be called before use. This allows the class an opportunity to validate any inputs.

This class is templated over the coordinate representation type (e.g. float or double) and the space dimension.

ShapeSignedDistanceFunction is used to encapsulate the shape prior in ShapePriorSegmentationLevelSetFunctions.

See also:
SpatialFunction
ShapePriorSegmentationLevelSetFunction

Definition at line 52 of file itkShapeSignedDistanceFunction.h.

Member Typedef Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef SmartPointer< const Self > itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ConstPointer

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 62 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef TCoordRep itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::CoordRepType

CoordRep typedef support.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 77 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef Superclass::InputType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::InputType

InputType typedef support.

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 71 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef Superclass::OutputType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::OutputType

OutputType typedef support.

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 65 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef OptimizerParameters< double > itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ParametersType

Type of the shape parameters.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 83 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef SmartPointer< Self > itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Pointer

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 61 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef InputType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::PointType

Point typedef support.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 80 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef ShapeSignedDistanceFunction itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Self

Standard class typedefs.

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 57 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > > itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Superclass

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 59 of file itkShapeSignedDistanceFunction.h.

Constructor & Destructor Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ShapeSignedDistanceFunction ( ) [inline, protected]

Definition at line 106 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::~ShapeSignedDistanceFunction ( ) [inline, protected]

Definition at line 108 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ShapeSignedDistanceFunction ( const Self &  ) [private]

Member Function Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual OutputType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Evaluate ( const PointType &  point) const [pure virtual]

Evaluate the signed distance from a shape at a given position.

Implemented in itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual const char* itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfParameters ( void  ) const [inline, virtual]

Definition at line 94 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfPoseParameters ( void  ) const [pure virtual]

Implemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfShapeParameters ( void  ) const [pure virtual]

Implemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual ParametersType& itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetParameters ( void  ) [inline, virtual]

Definition at line 88 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Initialize ( void  ) throw ( ExceptionObject ) [inline, virtual]

Initialize must be called before the first call of SetParameters() or Evaluate() to allow the class to validate any inputs.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >.

Definition at line 102 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::operator= ( const Self &  ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [inline, 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::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 110 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::SetParameters ( const ParametersType &  ) [pure virtual]

A shape is defined by a set of shape parameters.

Implemented in itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Member Data Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
ParametersType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Parameters [protected]

Definition at line 116 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
const unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::SpaceDimension = VSpaceDimension [static]

Dimension underlying input image.

Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 74 of file itkShapeSignedDistanceFunction.h.

The documentation for this class was generated from the following file:
Generated on Mon Dec 19 2011 01:23:33 for ITK by doxygen 1.7.4