ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::FiniteCylinderSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkFiniteCylinderSpatialFunction.h>

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

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Superclass::InputType InputType
typedef Superclass::OutputType OutputType
typedef SmartPointer< SelfPointer
typedef
FiniteCylinderSpatialFunction 
Self
typedef
InteriorExteriorSpatialFunction
< VDimension, TInput > 
Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
OutputType Evaluate (const InputType &position) const
virtual const char * GetNameOfClass () const
 typedef (Concept::SameDimension< VDimension, 3u >) DimensionShouldBe3
 typedef (Concept::SameDimension< InputType::Dimension, 3u >) PointDimensionShouldBe3
virtual InputType GetCenter () const
virtual void SetCenter (InputType _arg)
virtual double GetAxisLength () const
virtual void SetAxisLength (double _arg)
virtual double GetRadius () const
virtual void SetRadius (double _arg)
virtual InputType GetOrientation () const
virtual void SetOrientation (InputType _arg)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 FiniteCylinderSpatialFunction ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~FiniteCylinderSpatialFunction ()

Private Member Functions

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

Private Attributes

double m_AxisLength
InputType m_Center
InputType m_Orientation
double m_Radius

Detailed Description

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

Function implementation of an finite cylinder.

Implements a function that returns 1 for points inside or on the surface of a cylinder and 0 for points outside the cylinder.

This function only works in 3 Dimensions.

Definition at line 40 of file itkFiniteCylinderSpatialFunction.h.


Member Typedef Documentation

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

Input type for the function

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

Definition at line 55 of file itkFiniteCylinderSpatialFunction.h.

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

Output type for the function

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

Definition at line 61 of file itkFiniteCylinderSpatialFunction.h.

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

Standard class typedefs.

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

Definition at line 46 of file itkFiniteCylinderSpatialFunction.h.

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

Constructor & Destructor Documentation

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

End concept checking

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

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual::itk::LightObject::Pointer itk::FiniteCylinderSpatialFunction< 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, VDimension >>
OutputType itk::FiniteCylinderSpatialFunction< 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, VDimension >>
virtual double itk::FiniteCylinderSpatialFunction< VDimension, TInput >::GetAxisLength ( ) const [virtual]

Get and set the medial axis length of the cylinder.

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

Set/Get and set the center of the cylinder.

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

Run-time type information (and related methods).

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

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

Set the orientation vectors (must be orthogonal) of the ellipsoid axes. Must be normalized!!!!!

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

Get and set the radius length of the cylinder.

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::FiniteCylinderSpatialFunction< VDimension, TInput >::operator= ( const Self ) [private]
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::FiniteCylinderSpatialFunction< 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, VDimension >>
virtual void itk::FiniteCylinderSpatialFunction< VDimension, TInput >::SetAxisLength ( double  _arg) [virtual]

Get and set the medial axis length of the cylinder.

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

Set/Get and set the center of the cylinder.

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

Set the orientation vectors (must be orthogonal) of the ellipsoid axes. Must be normalized!!!!!

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

Get and set the radius length of the cylinder.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
itk::FiniteCylinderSpatialFunction< VDimension, TInput >::typedef ( Concept::SameDimension< VDimension, 3u >  )

Begin concept checking This class requires DimensionShouldBe3 in the form of ( Concept::SameDimension< VDimension, 3u > )

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
itk::FiniteCylinderSpatialFunction< VDimension, TInput >::typedef ( Concept::SameDimension< InputType::Dimension, 3u >  )

This class requires PointDimensionShouldBe3 in the form of ( Concept::SameDimension< InputType::Dimension, 3u > )


Member Data Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::FiniteCylinderSpatialFunction< VDimension, TInput >::m_AxisLength [private]

The medial axis length of the cylinder.

Definition at line 113 of file itkFiniteCylinderSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
InputType itk::FiniteCylinderSpatialFunction< VDimension, TInput >::m_Center [private]

The center of the cylinder.

Definition at line 110 of file itkFiniteCylinderSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
InputType itk::FiniteCylinderSpatialFunction< VDimension, TInput >::m_Orientation [private]

The orientation vectors (must be orthogonal) of the ellipsoid axes.

Definition at line 119 of file itkFiniteCylinderSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::FiniteCylinderSpatialFunction< VDimension, TInput >::m_Radius [private]

The radius length of the cylinder.

Definition at line 116 of file itkFiniteCylinderSpatialFunction.h.


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