itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkTorusInteriorExteriorSpatialFunction.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef TorusInteriorExteriorSpatialFunction	Self
typedef InteriorExteriorSpatialFunction < VDimension >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
OutputType	Evaluate (const InputType &position) const
virtual const char *	GetNameOfClass () const
virtual InputType	GetOrigin () const
virtual void	SetOrigin (InputType _arg)
virtual double	GetMajorRadius () const
virtual void	SetMajorRadius (double _arg)
Static Public Member Functions
static Pointer	New ()
Private Member Functions
void	operator= (const Self &)
	TorusInteriorExteriorSpatialFunction (const Self &)
Private Attributes
double	m_MajorRadius
double	m_MinorRadius
InputType	m_Origin
virtual double	GetMinorRadius () const
virtual void	SetMinorRadius (double _arg)
	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 40 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 49 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 55 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 61 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 48 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 46 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 47 of file itkTorusInteriorExteriorSpatialFunction.h.

---

Constructor & Destructor Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::TorusInteriorExteriorSpatialFunction

(

)

[protected]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::~TorusInteriorExteriorSpatialFunction

(

)

[protected, virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::TorusInteriorExteriorSpatialFunction

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual::itk::LightObject::Pointer itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::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<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 double itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetMajorRadius

(

)

const [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

(

)

const [virtual]

Set/Get the major radius of the torus.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual const char* itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetNameOfClass

(

)

const [virtual]

Run time information.

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual InputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::GetOrigin

(

)

const [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 >>

static 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 >::operator=

(

const Self &

)

[private]

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Set/Get the major radius of the torus.

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

---

Member Data Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

double itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::m_MajorRadius [private]

The distance from the origin of the torus to the center of the "tube"

Definition at line 97 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

double itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::m_MinorRadius [private]

The diameter of the "tube"

Definition at line 100 of file itkTorusInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

InputType itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::m_Origin [private]

The origin of the torus (the point from which the major radius is measured)

Definition at line 94 of file itkTorusInteriorExteriorSpatialFunction.h.

---

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

• itkTorusInteriorExteriorSpatialFunction.h