ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions
itk::InteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkInteriorExteriorSpatialFunction.h>

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

List of all members.

Public Types

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 >
- Public Types inherited from itk::FunctionBase< TInput, bool >
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual OutputType Evaluate (const InputType &input) const =0
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
virtual OutputType Evaluate (const InputType &input) const =0

Protected Member Functions

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

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

Additional Inherited Members

- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static const unsigned int ImageDimension

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 49 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
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef Superclass::InputType itk::InteriorExteriorSpatialFunction< VDimension, TInput >::InputType
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef Superclass::OutputType itk::InteriorExteriorSpatialFunction< VDimension, TInput >::OutputType
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef SmartPointer< Self > itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Pointer
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef InteriorExteriorSpatialFunction itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Self
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef SpatialFunction< bool, VDimension, TInput > itk::InteriorExteriorSpatialFunction< VDimension, TInput >::Superclass

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 ( )
protectedvirtual
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
itk::InteriorExteriorSpatialFunction< VDimension, TInput >::InteriorExteriorSpatialFunction ( const Self )
private

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

Implemented in itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >, itk::FiniteCylinderSpatialFunction< VDimension, TInput >, itk::EllipsoidInteriorExteriorSpatialFunction< VDimension, 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
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::InteriorExteriorSpatialFunction< VDimension, TInput >::operator= ( const Self )
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::InteriorExteriorSpatialFunction< VDimension, TInput >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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