itk::InteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference
[Spatial Functions]

Returns whether or not a location is "inside" or "outside" a function. More...

#include <itkInteriorExteriorSpatialFunction.h>

Inheritance diagram for itk::InteriorExteriorSpatialFunction< VDimension, TInput >:

[legend]Collaboration diagram for itk::InteriorExteriorSpatialFunction< VDimension, TInput >:

[legend]List of all members.

Public Types
typedef InteriorExteriorSpatialFunction	Self
typedef SpatialFunction< bool, VDimension, TInput >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual OutputType	Evaluate (const InputType &input) const=0
Protected Member Functions
	InteriorExteriorSpatialFunction ()
virtual	~InteriorExteriorSpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

Returns whether or not a location is "inside" or "outside" a function.

InteriorExteriorSpatialFunction is a specialized version of SpatialFunction where the output type is a boolean. In particular, the return type is understood to mean the following:

A return of 1 means inside or on the surface of the function, 0 means outside the function

There is no implied meaning in the terms "inside" or "outside"; although the standard assumption is that "inside" means "bounded by a closed surface", alternative definitions are also fine. For example, inside might be one side of a plane, outside the other side.

A typical use for an InteriorExteriorSpatialFunction is to generate test primitives of arbitrary dimensionality, in conjunction with itk::SpatialFunctionImageEvaluatorFilter or itk::FloodFilledSpatialFunctionConditionalIterator

Definition at line 48 of file itkInteriorExteriorSpatialFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 56 of file itkInteriorExteriorSpatialFunction.h.

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

Input type for the function Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 62 of file itkInteriorExteriorSpatialFunction.h.

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

Output type for the function Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 65 of file itkInteriorExteriorSpatialFunction.h.

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

Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 55 of file itkInteriorExteriorSpatialFunction.h.

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

Standard class typedefs. Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 53 of file itkInteriorExteriorSpatialFunction.h.

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

Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 54 of file itkInteriorExteriorSpatialFunction.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point<double,VDimension>> virtual OutputType itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Evaluate (  const InputType &  input  )  const [pure virtual]

Evaluate the function at a given position. A return of 1 means inside or on the surface of the function, 0 means outside the function The actual definition of inside/outside is left up to the subclass Implements itk::SpatialFunction< bool, VDimension, TInput >. Implemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >.

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

Run-time type information (and related methods). Reimplemented from itk::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point<double,VDimension>> void itk::InteriorExteriorSpatialFunction< 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::SpatialFunction< bool, VDimension, TInput >. Reimplemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::FrustumSpatialFunction< VImageDimension, TInput >, itk::SphereSpatialFunction< VImageDimension, TInput >, itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >.

---

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

• itkInteriorExteriorSpatialFunction.h

---