ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Reference

#include <itkSphereSignedDistanceFunction.h>

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

Detailed Description

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

Compute the signed distance from a N-dimensional sphere.

A instance of sphere is defined by a set parameters. The first parameter is the radius and the next SpaceDimension parameters represent the center. The first parameter forms the set of ShapeParameters and the remaining parameters the set of PoseParameters.

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

See Also
ShapeSignedDistanceFunction

Definition at line 44 of file itkSphereSignedDistanceFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordRepType CoordRepType
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef
SphereSignedDistanceFunction 
Self
 
typedef
ShapeSignedDistanceFunction
< TCoordRep, VSpaceDimension > 
Superclass
 
- Public Types inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
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 ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputType Evaluate (const PointType &point) const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfPoseParameters (void) const
 
virtual unsigned int GetNumberOfShapeParameters (void) const
 
virtual void SetParameters (const ParametersType &)
 
- Public Member Functions inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
virtual unsigned int GetNumberOfParameters (void) const
 
virtual ParametersTypeGetParameters (void)
 
virtual void Initialize () throw ( ExceptionObject )
 
- Public Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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 Member Functions

static Pointer New ()
 
- 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 ()
 

Static Public Attributes

static const unsigned int SpaceDimension = Superclass::SpaceDimension
 
- Static Public Attributes inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
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
 
 SphereSignedDistanceFunction ()
 
 ~SphereSignedDistanceFunction ()
 
- Protected Member Functions inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
 ShapeSignedDistanceFunction ()
 
 ~ShapeSignedDistanceFunction ()
 
- Protected Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
void PrintSelf (std::ostream &os, Indent indent) const
 
 SpatialFunction ()
 
virtual ~SpatialFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Private Types

typedef Vector< CoordRepType,
itkGetStaticConstMacro(SpaceDimension) > 
VectorType
 

Private Member Functions

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

Private Attributes

double m_Radius
 
VectorType m_Translation
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

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

Definition at line 52 of file itkSphereSignedDistanceFunction.h.

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

CoordRep typedef support.

Definition at line 70 of file itkSphereSignedDistanceFunction.h.

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

InputeType typedef support.

Definition at line 64 of file itkSphereSignedDistanceFunction.h.

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

OutputType typedef support.

Definition at line 58 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef Superclass::ParametersType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::ParametersType

Type of the shape parameters.

Definition at line 76 of file itkSphereSignedDistanceFunction.h.

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

Definition at line 51 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef Superclass::PointType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::PointType

Point typedef support.

Definition at line 73 of file itkSphereSignedDistanceFunction.h.

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

Standard class typedefs.

Definition at line 49 of file itkSphereSignedDistanceFunction.h.

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

Definition at line 50 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
typedef Vector< CoordRepType, itkGetStaticConstMacro(SpaceDimension) > itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::VectorType
private

Definition at line 100 of file itkSphereSignedDistanceFunction.h.

Constructor & Destructor Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SphereSignedDistanceFunction ( )
protected
template<typename TCoordRep , unsigned int VSpaceDimension>
itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::~SphereSignedDistanceFunction ( )
inlineprotected

Definition at line 92 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SphereSignedDistanceFunction ( const Self )
private

Member Function Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual::itk::LightObject::Pointer itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::CreateAnother ( void  ) 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::Object.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual OutputType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Evaluate ( const PointType point) const
virtual

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

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

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

Run-time type information (and related methods).

Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfPoseParameters ( void  ) const
inlinevirtual
template<typename TCoordRep , unsigned int VSpaceDimension>
virtual unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfShapeParameters ( void  ) const
inlinevirtual
template<typename TCoordRep , unsigned int VSpaceDimension>
static Pointer itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::New ( )
static

New macro for creation of through the object factory.

template<typename TCoordRep , unsigned int VSpaceDimension>
void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::operator= ( const Self )
private
template<typename TCoordRep , unsigned int VSpaceDimension>
void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

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

A sphere is defined by a set of shape parameters. The first parameter is the radius and the next SpaceDimension parameters represent the center.

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Member Data Documentation

template<typename TCoordRep , unsigned int VSpaceDimension>
double itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Radius
private

Definition at line 103 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
VectorType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Translation
private

Definition at line 102 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep , unsigned int VSpaceDimension>
const unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SpaceDimension = Superclass::SpaceDimension
static

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