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::FrustumSpatialFunction< VImageDimension, TInput > Class Template Reference

#include <itkFrustumSpatialFunction.h>

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

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 39 of file itkFrustumSpatialFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
enum  FrustumRotationPlaneType {
  RotateInXZPlane = 1,
  RotateInYZPlane
}
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FrustumSpatialFunction
< VImageDimension, TInput > 
Self
 
typedef
InteriorExteriorSpatialFunction
< VImageDimension, TInput > 
Superclass
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< VImageDimension, 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 void SetRotationPlane (FrustumRotationPlaneType _arg)
 
virtual InputType GetApex () const
 
virtual void SetApex (InputType _arg)
 
virtual double GetAngleZ () const
 
virtual void SetAngleZ (double _arg)
 
virtual double GetApertureAngleX () const
 
virtual void SetApertureAngleX (double _arg)
 
virtual double GetApertureAngleY () const
 
virtual void SetApertureAngleY (double _arg)
 
virtual double GetTopPlane () const
 
virtual void SetTopPlane (double _arg)
 
virtual double GetBottomPlane () const
 
virtual void SetBottomPlane (double _arg)
 
- Public Member Functions inherited from itk::InteriorExteriorSpatialFunction< VImageDimension, 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

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

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

Private Attributes

double m_AngleZ
 
double m_ApertureAngleX
 
double m_ApertureAngleY
 
InputType m_Apex
 
double m_BottomPlane
 
FrustumRotationPlaneType m_RotationPlane
 
double m_TopPlane
 

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 VImageDimension = 3, typename TInput = Point< double, 3 >>
typedef SmartPointer< const Self > itk::FrustumSpatialFunction< VImageDimension, TInput >::ConstPointer

Definition at line 48 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

Definition at line 54 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

Definition at line 60 of file itkFrustumSpatialFunction.h.

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

Definition at line 47 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.

Definition at line 45 of file itkFrustumSpatialFunction.h.

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

Definition at line 46 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

Enumerator
RotateInXZPlane 
RotateInYZPlane 

Definition at line 63 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 ( )
protectedvirtual
template<unsigned int VImageDimension = 3, typename TInput = Point< double, 3 >>
itk::FrustumSpatialFunction< VImageDimension, TInput >::FrustumSpatialFunction ( const Self )
private

Member Function Documentation

template<unsigned int VImageDimension = 3, typename TInput = Point< double, 3 >>
virtual::itk::LightObject::Pointer itk::FrustumSpatialFunction< VImageDimension, 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 VImageDimension = 3, typename TInput = Point< double, 3 >>
OutputType itk::FrustumSpatialFunction< VImageDimension, TInput >::Evaluate ( const InputType position) const

Evaluates the function at a given position

template<unsigned int VImageDimension = 3, typename TInput = Point< double, 3 >>
virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetAngleZ ( ) const
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 ( ) const
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 ( ) const
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 ( ) const
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 ( ) const
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 ( ) const
virtual

Get and set the top plane distance to the Apex

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

Method for creation through the object factory.

template<unsigned int VImageDimension = 3, typename TInput = Point< double, 3 >>
void itk::FrustumSpatialFunction< VImageDimension, TInput >::operator= ( const Self )
private
template<unsigned int VImageDimension = 3, typename TInput = Point< double, 3 >>
void itk::FrustumSpatialFunction< VImageDimension, 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::Object.

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

Member Data Documentation

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

Angle between the pyramid axis and the Z axis

Definition at line 118 of file itkFrustumSpatialFunction.h.

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

Aperture Angle in X direction

Definition at line 121 of file itkFrustumSpatialFunction.h.

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

Aperture Angle in Y direction

Definition at line 124 of file itkFrustumSpatialFunction.h.

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

The apex of the pyramid (of the same type as Input)

Definition at line 115 of file itkFrustumSpatialFunction.h.

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

Distance from Apex to bottom plane

Definition at line 130 of file itkFrustumSpatialFunction.h.

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

Plane in which to the frustum is being rotated

Definition at line 133 of file itkFrustumSpatialFunction.h.

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

Distance from Apex to top plane

Definition at line 127 of file itkFrustumSpatialFunction.h.


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