itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference
[Spatial Functions]

Spatial function implementation of torus symmetric about the z-axis in 3D. More...

#include <itkTorusInteriorExteriorSpatialFunction.h>

Inheritance diagram for itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >:

[legend]Collaboration diagram for itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >:

[legend]List of all members.

Public Types
typedef TorusInteriorExteriorSpatialFunction	Self
typedef InteriorExteriorSpatialFunction< VDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
Public Member Functions
virtual const char *	GetClassName () const
OutputType	Evaluate (const InputType &position) const
virtual InputType	GetOrigin ()
virtual void	SetOrigin (InputType _arg)
virtual double	GetMajorRadius ()
virtual void	SetMajorRadius (double _arg)
virtual double	GetMinorRadius ()
virtual void	SetMinorRadius (double _arg)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	TorusInteriorExteriorSpatialFunction ()
virtual	~TorusInteriorExteriorSpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

template<unsigned int VDimension = 3, typename TInput = Point<double,3>>
class itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >

Spatial function implementation of torus symmetric about the z-axis in 3D.

Handle with care! May behave in strange ways when used with dimensions other than 3

Definition at line 39 of file itkTorusInteriorExteriorSpatialFunction.h.

---

Member Typedef Documentation

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef SmartPointer<const Self> itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 48 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef Superclass::InputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::InputType

Input type for the function. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 57 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef Superclass::OutputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::OutputType

Output type for the function. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 60 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef SmartPointer<Self> itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::Pointer

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 47 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef TorusInteriorExteriorSpatialFunction itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::Self

Standard class typedefs. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 45 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> typedef InteriorExteriorSpatialFunction<VDimension> itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::Superclass

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 46 of file itkTorusInteriorExteriorSpatialFunction.h.

---

Constructor & Destructor Documentation

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::TorusInteriorExteriorSpatialFunction (   )  [protected]

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::~TorusInteriorExteriorSpatialFunction (   )  [protected, virtual]

---

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> OutputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::Evaluate (  const InputType &  position  )  const [virtual]

Evaluates the function at a given position Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual const char* itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetClassName (   )  const [virtual]

Run time information. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual double itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetMajorRadius (   )  [virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual double itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetMinorRadius (   )  [virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual InputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetOrigin (   )  [virtual]

Set/Get the origin of the torus (the point from which the major radius is measured).

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> Pointer itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::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::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::SetMajorRadius (  double  _arg  )  [virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::SetMinorRadius (  double  _arg  )  [virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> virtual void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrigin (  InputType  _arg  )  [virtual]

Set/Get the origin of the torus (the point from which the major radius is measured).

---

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

• itkTorusInteriorExteriorSpatialFunction.h

---