Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::FrustumSpatialFunction< VImageDimension, TInput > Class Template Reference
[Spatial Functions]

Spatial function implementation of a truncated pyramid. More...

#include <itkFrustumSpatialFunction.h>

Inheritance diagram for itk::FrustumSpatialFunction< VImageDimension, TInput >:

Inheritance graph
[legend]
Collaboration diagram for itk::FrustumSpatialFunction< VImageDimension, TInput >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef FrustumSpatialFunction<
VImageDimension, TInput > 
Self
typedef InteriorExteriorSpatialFunction<
VImageDimension, TInput > 
Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef Superclass::InputType InputType
typedef Superclass::OutputType OutputType
enum  FrustumRotationPlaneType { RotateInXZPlane = 1, RotateInYZPlane }

Public Member Functions

virtual const char * GetNameOfClass () const
OutputType Evaluate (const InputType &position) const
virtual void SetRotationPlane (FrustumRotationPlaneType _arg)
virtual InputType GetApex ()
virtual void SetApex (InputType _arg)
virtual double GetAngleZ ()
virtual void SetAngleZ (double _arg)
virtual double GetApertureAngleX ()
virtual void SetApertureAngleX (double _arg)
virtual double GetApertureAngleY ()
virtual void SetApertureAngleY (double _arg)
virtual double GetTopPlane ()
virtual void SetTopPlane (double _arg)
virtual double GetBottomPlane ()
virtual void SetBottomPlane (double _arg)

Static Public Member Functions

Pointer New ()

Protected Member Functions

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

Detailed Description

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
class itk::FrustumSpatialFunction< VImageDimension, TInput >

Spatial function implementation of a truncated pyramid.

Implements a function that returns 0 for points inside or on the surface of a truncated pyrami, 1 for points outside the truncated pyramid

Definition at line 37 of file itkFrustumSpatialFunction.h.


Member Typedef Documentation

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

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

Definition at line 46 of file itkFrustumSpatialFunction.h.

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

Input type for the function

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

Definition at line 55 of file itkFrustumSpatialFunction.h.

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

Output type for the function

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

Definition at line 58 of file itkFrustumSpatialFunction.h.

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

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

Definition at line 45 of file itkFrustumSpatialFunction.h.

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

Standard class typedefs.

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

Definition at line 43 of file itkFrustumSpatialFunction.h.

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

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

Definition at line 44 of file itkFrustumSpatialFunction.h.


Member Enumeration Documentation

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
enum itk::FrustumSpatialFunction::FrustumRotationPlaneType
 

Rotate the frustum in the XZ or the YZ plane

Enumeration values:
RotateInXZPlane 
RotateInYZPlane 

Definition at line 61 of file itkFrustumSpatialFunction.h.


Constructor & Destructor Documentation

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
itk::FrustumSpatialFunction< VImageDimension, TInput >::FrustumSpatialFunction  )  [protected]
 

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


Member Function Documentation

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
OutputType itk::FrustumSpatialFunction< VImageDimension, TInput >::Evaluate const InputType position  )  const [virtual]
 

Evaluates the function at a given position

Implements itk::InteriorExteriorSpatialFunction< VImageDimension, TInput >.

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetAngleZ  )  [virtual]
 

Get and set the angle of the pyramid axis with respect to the Z axis

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApertureAngleX  )  [virtual]
 

Get and set the aperture angle in X

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApertureAngleY  )  [virtual]
 

Get and set the aperture angle in Y

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual InputType itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApex  )  [virtual]
 

Get and set the center of the sphere

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetBottomPlane  )  [virtual]
 

Get and set the bottom plane distance to the Apex

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

Run-time type information (and related methods).

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

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetTopPlane  )  [virtual]
 

Get and set the top plane distance to the Apex

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

Method for creation through the object factory.

Reimplemented from itk::Object.

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

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetAngleZ double  _arg  )  [virtual]
 

Get and set the angle of the pyramid axis with respect to the Z axis

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetApertureAngleX double  _arg  )  [virtual]
 

Get and set the aperture angle in X

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetApertureAngleY double  _arg  )  [virtual]
 

Get and set the aperture angle in Y

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetApex InputType  _arg  )  [virtual]
 

Get and set the center of the sphere

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetBottomPlane double  _arg  )  [virtual]
 

Get and set the bottom plane distance to the Apex

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetRotationPlane FrustumRotationPlaneType  _arg  )  [virtual]
 

Set macro to set the plane in which the frustum should rotate

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>>
virtual void itk::FrustumSpatialFunction< VImageDimension, TInput >::SetTopPlane double  _arg  )  [virtual]
 

Get and set the top plane distance to the Apex


The documentation for this class was generated from the following file:
Generated at Thu May 25 00:59:22 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000