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

#include <itkTorusInteriorExteriorSpatialFunction.h>

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

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.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef
TorusInteriorExteriorSpatialFunction 
Self
 
typedef
InteriorExteriorSpatialFunction
< VDimension > 
Superclass
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef
InteriorExteriorSpatialFunction 
Self
 
typedef SpatialFunction< bool,
VDimension, TInput > 
Superclass
 
- Public Types inherited from itk::SpatialFunction< bool, VDimension, TInput >
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef SpatialFunction Self
 
typedef FunctionBase< TInput,
bool > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TInput, bool >
typedef SmartPointer< const SelfConstPointer
 
typedef TInput InputType
 
typedef bool 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
 
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)
 
virtual double GetMinorRadius () const
 
virtual void SetMinorRadius (double _arg)
 
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
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 ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 
 TorusInteriorExteriorSpatialFunction ()
 
virtual ~TorusInteriorExteriorSpatialFunction ()
 
- Protected Member Functions inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
 InteriorExteriorSpatialFunction ()
 
virtual ~InteriorExteriorSpatialFunction ()
 
- Protected Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
void PrintSelf (std::ostream &os, Indent indent) const
 
 SpatialFunction ()
 
virtual ~SpatialFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< TInput, bool >
 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 Member Functions

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

Private Attributes

double m_MajorRadius
 
double m_MinorRadius
 
InputType m_Origin
 

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static const unsigned int ImageDimension
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

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

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.

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.

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

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.

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

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
template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>
virtual itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::~TorusInteriorExteriorSpatialFunction ( )
protectedvirtual
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.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>
void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::operator= ( const Self )
private
template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>
void itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >::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::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 98 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 101 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 95 of file itkTorusInteriorExteriorSpatialFunction.h.


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