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

#include <itkFrustumSpatialFunction.h>

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

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

[legend]List of all members.

---

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.

Public Types
typedef SmartPointer< const Self >	ConstPointer
enum	FrustumRotationPlaneType {   RotateInXZPlane = 1,   RotateInYZPlane }
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef FrustumSpatialFunction< VImageDimension, TInput >	Self
typedef InteriorExteriorSpatialFunction< VImageDimension, TInput >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
OutputType	Evaluate (const InputType &position) const
Get and set the angle of the pyramid axis *with respect to the Z axis *virtual double	GetAngleZ ()
Get and set the aperture angle in X *virtual double	GetApertureAngleX ()
Get and set the aperture angle in Y *virtual double	GetApertureAngleY ()
Get and set the center of the sphere *virtual InputType	GetApex ()
Get and set the bottom plane distance to the Apex *virtual double	GetBottomPlane ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
Get and set the top plane distance to the Apex *virtual double	GetTopPlane ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAngleZ (double _arg)
virtual void	SetApertureAngleX (double _arg)
virtual void	SetApertureAngleY (double _arg)
virtual void	SetApex (InputType _arg)
virtual void	SetBottomPlane (double _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	SetRotationPlane (FrustumRotationPlaneType _arg)
virtual void	SetTopPlane (double _arg)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	FrustumSpatialFunction ()
	FunctionBase ()
	InteriorExteriorSpatialFunction ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SpatialFunction ()
virtual	~FrustumSpatialFunction ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

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 52 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

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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 >.

itk::FunctionBase< TInput , bool >::FunctionBase (   )  [inline, protected, inherited]

Definition at line 66 of file itkFunctionBase.h.

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the angle of the pyramid axis* with respect to the Z axis* virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetAngleZ (   )  [virtual]

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the aperture angle in X* virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApertureAngleX (   )  [virtual]

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the aperture angle in Y* virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApertureAngleY (   )  [virtual]

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the center of the sphere* virtual InputType itk::FrustumSpatialFunction< VImageDimension, TInput >::GetApex (   )  [virtual]

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the bottom plane distance to the Apex* virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetBottomPlane (   )  [virtual]

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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 >.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<unsigned int VImageDimension = 3, typename TInput = Point<double,3>> Get and set the top plane distance to the Apex* virtual double itk::FrustumSpatialFunction< VImageDimension, TInput >::GetTopPlane (   )  [virtual]

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

itk::InteriorExteriorSpatialFunction< VDimension, TInput >::InteriorExteriorSpatialFunction (   )  [protected, inherited]

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

itk::SpatialFunction< bool , VImageDimension, TInput >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )  [inherited]

Spatial dimension.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

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 >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

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

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

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

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

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

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

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]

itk::SpatialFunction< bool , VImageDimension, TInput >::SpatialFunction (   )  [protected, inherited]

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkFrustumSpatialFunction.h

---