ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::InteriorExteriorSpatialFunction< VDimension, TInput > Class Template Referenceabstract

#include <itkInteriorExteriorSpatialFunction.h>

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

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.

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 >
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 OutputType Evaluate (const InputType &input) const override=0
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
virtual OutputType Evaluate (const InputType &input) const override=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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
 

Protected Member Functions

 InteriorExteriorSpatialFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~InteriorExteriorSpatialFunction ()
 
- Protected Member Functions inherited from itk::SpatialFunction< bool, VDimension, TInput >
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 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 ()
 
- Static Public Attributes inherited from itk::SpatialFunction< bool, VDimension, TInput >
static const unsigned int ImageDimension
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

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

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

Definition at line 66 of file itkInteriorExteriorSpatialFunction.h.

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

Definition at line 56 of file itkInteriorExteriorSpatialFunction.h.

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

Standard class typedefs.

Definition at line 54 of file itkInteriorExteriorSpatialFunction.h.

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

Definition at line 55 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 ( )
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
overridepure 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
overrideprotectedvirtual

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.

Reimplemented in itk::TorusInteriorExteriorSpatialFunction< VDimension, TInput >, and itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >.


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