ITK  4.3.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::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h>

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

Detailed Description

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

Function implementation of an ellipsoid.

Similar to EllipsoidInteriorExteriorSpatialFunction in that it implements a function that returns 1 for points inside or on the surface of a ellipsoid and 0 for points outside the ellipsoid. However, this ellipsoid is defined by a single orientation vector and deals only with symmetric ellipsoids. An n-dimensional symmetric ellipsoid is one which has m axes of equal length and (n - m) unique axes lengths. Specifically, this class deals with the case where (n - m) = 1 and the ellipsoid's major axis is oriented along a singles orientation vector.

Definition at line 40 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef
SymmetricEllipsoidInteriorExteriorSpatialFunction 
Self
 
typedef
InteriorExteriorSpatialFunction
< VDimension > 
Superclass
 
typedef Vector< double,
VDimension > 
VectorType
 
- 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
 
void SetOrientation (VectorType orientation, double uniqueAxis, double symmetricAxes)
 
virtual InputType GetCenter () const
 
virtual void SetCenter (InputType _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const
 
 SymmetricEllipsoidInteriorExteriorSpatialFunction ()
 
virtual ~SymmetricEllipsoidInteriorExteriorSpatialFunction ()
 
- 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 &)
 
 SymmetricEllipsoidInteriorExteriorSpatialFunction (const Self &)
 

Private Attributes

InputType m_Center
 
Vector< double, VDimension > m_Orientation
 
double m_SymmetricAxes
 
double m_UniqueAxis
 
double m_VectorRatio
 

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, VDimension >>
typedef SmartPointer< const Self > itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef Superclass::InputType itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::InputType

Input type for the function.

Definition at line 55 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

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

Output type for the function.

Definition at line 61 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

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

Standard class typedefs.

Definition at line 45 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

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

Constructor & Destructor Documentation

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

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual::itk::LightObject::Pointer itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< 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::SymmetricEllipsoidInteriorExteriorSpatialFunction< 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 InputType itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::GetCenter ( ) const
virtual

Get and set the center of the ellipsoid.

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

Run-time information.

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

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

Method for creation through the object factory.

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

Get and set the center of the ellipsoid.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrientation ( VectorType  orientation,
double  uniqueAxis,
double  symmetricAxes 
)

Set the orientation vector of the ellipsoid's unique axis and axes lengths. Must be normalized!!!!!

Member Data Documentation

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

The center of the ellipsoid.

Definition at line 90 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
Vector< double, VDimension > itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Orientation
private

The orientation vector of the ellipsoid's unique axis.

Definition at line 99 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_SymmetricAxes
private

The symmetric axes lengths of the ellipsoid.

Definition at line 96 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_UniqueAxis
private

The unique axis length of the ellipsoid.

Definition at line 93 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_VectorRatio
private

The vector ratio.

Definition at line 102 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.


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