ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Referenceabstract

#include <itkShapeSignedDistanceFunction.h>

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

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.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TCoordRep CoordRepType
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef OptimizerParameters
< double > 
ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef InputType PointType
 
typedef ShapeSignedDistanceFunction Self
 
typedef SpatialFunction
< double, VSpaceDimension,
Point< TCoordRep,
VSpaceDimension > > 
Superclass
 
- Public Types inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef SpatialFunction Self
 
typedef FunctionBase< Point
< TCoordRep, VSpaceDimension >
, double > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
VSpaceDimension > 
InputType
 
typedef double OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual OutputType Evaluate (const PointType &point) const override=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 ParametersTypeGetParameters (void)
 
virtual void Initialize ()
 
virtual void SetParameters (const ParametersType &)=0
 
- Public Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
virtual OutputType Evaluate (const InputType &input) const override=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 Attributes

static const unsigned int SpaceDimension = VSpaceDimension
 
- Static Public Attributes inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
static const unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ShapeSignedDistanceFunction ()
 
 ~ShapeSignedDistanceFunction () override
 
- Protected Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SpatialFunction ()
 
virtual ~SpatialFunction () override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >
 FunctionBase ()
 
 ~FunctionBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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

ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Additional Inherited Members

- 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 ()
 

Member Typedef Documentation

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

Definition at line 62 of file itkShapeSignedDistanceFunction.h.

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

CoordRep typedef support.

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.

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.

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.

Definition at line 83 of file itkShapeSignedDistanceFunction.h.

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

Definition at line 61 of file itkShapeSignedDistanceFunction.h.

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

Point typedef support.

Definition at line 80 of file itkShapeSignedDistanceFunction.h.

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

Standard class typedefs.

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

Definition at line 59 of file itkShapeSignedDistanceFunction.h.

Constructor & Destructor Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::ShapeSignedDistanceFunction ( )
inlineprotected

Definition at line 106 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::~ShapeSignedDistanceFunction ( )
inlineoverrideprotected

Definition at line 108 of file itkShapeSignedDistanceFunction.h.

Member Function Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual OutputType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Evaluate ( const PointType point) const
overridepure 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
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfParameters ( void  ) const
inlinevirtual
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfPoseParameters ( void  ) const
pure virtual
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfShapeParameters ( void  ) const
pure virtual
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual ParametersType& itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetParameters ( void  )
inlinevirtual
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Initialize ( void  )
inlinevirtual

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 >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

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

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

Definition at line 110 of file itkShapeSignedDistanceFunction.h.

References itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >::PrintSelf().

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

Member Data Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
ParametersType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Parameters
protected
template<typename TCoordRep , unsigned int VSpaceDimension>
const unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::SpaceDimension = VSpaceDimension
static

Dimension underlying input image.

Definition at line 74 of file itkShapeSignedDistanceFunction.h.


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