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

itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Reference
[Image Functions]

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

#include <itkShapeSignedDistanceFunction.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName () const
 itkStaticConstMacro (SpaceDimension, unsigned int, VSpaceDimension)
virtual OutputType Evaluate (const PointType &point) const =0
virtual void Initialize () throw ( ExceptionObject )
virtual void SetParameters (const ParametersType &)=0
virtual const ParametersTypeGetParameters (void) const =0
virtual unsigned int GetNumberOfShapeParameters (void) const =0
virtual unsigned int GetNumberOfPoseParameters (void) const =0
virtual unsigned int GetNumberOfParameters (void) const

Protected Member Functions

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

Protected Attributes

ParametersType m_Parameters

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 50 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 59 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 74 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 68 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 Array<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 80 of file itkShapeSignedDistanceFunction.h.

Referenced by itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ShapeSignedDistanceFunction().

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 58 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 77 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 55 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 57 of file itkShapeSignedDistanceFunction.h.


Constructor & Destructor Documentation

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

Definition at line 100 of file itkShapeSignedDistanceFunction.h.

References itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ParametersType.

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

Definition at line 107 of file itkShapeSignedDistanceFunction.h.


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::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep, unsigned int VSpaceDimension>
virtual const char* itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetClassName  )  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]
 

A shape is defined by a set of shape parameters. Definition at line 87 of file itkShapeSignedDistanceFunction.h.

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

A shape is defined by a set of shape parameters.

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]
 

A shape is defined by a set of shape parameters.

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

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

A shape is defined by a set of shape parameters.

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

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

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

Dimension underlying input image.

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 109 of file itkShapeSignedDistanceFunction.h.

References HardConnectedComponentImageFilter::PrintSelf().

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::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >, and itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >.


Member Data Documentation

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

Definition at line 115 of file itkShapeSignedDistanceFunction.h.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:59:49 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000