ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkConicShellInteriorExteriorSpatialFunction.h>

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

Detailed Description

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

Spatial function implementation of a conic shell.

We are creating search areas from BoundaryPoint1 in which to look for candidate BoundaryPoint2's with which to form core atoms. Assume the "worst case" that BoundaryPoint2 is somewhere in that search area pointing directly at BoundaryPoint1.

The search area (ConicShell?) from each BoundaryPoint1 has the following parameters:

DistanceMax and DistanceMin from the location of the BoundaryPoint

AngleMax from the line along the gradient at the boundary point. This is determined in n dimensions by taking the dot product of two vectors, (1) the normalized gradient at BoundaryPoint1 and (2) the normalized vector from BoundaryPoint1 to BoundaryPoint2.

If the absolute value of that dot product is greater than (1 - epsilon) then you are in the ConicShell. This epsilon is the same one determining face-to-faceness in the IEEE TMI paper.

The polarity indicates which direction along the gradient of BoundaryPoint1 the function is to be evaluated.

Definition at line 61 of file itkConicShellInteriorExteriorSpatialFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef CovariantVector
< double, VDimension > 
GradientType
 
typedef Superclass::InputType InputType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef
ConicShellInteriorExteriorSpatialFunction 
Self
 
typedef
InteriorExteriorSpatialFunction
< VDimension, TInput > 
Superclass
 
- Public Types inherited from itk::InteriorExteriorSpatialFunction< VDimension, 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 () const
 
OutputType Evaluate (const InputType &position) const override
 
virtual const char * GetNameOfClass () const
 
virtual InputType GetOrigin () const
 
virtual void SetOrigin (InputType _arg)
 
GradientType GetOriginGradient ()
 
void SetOriginGradient (GradientType grad)
 
virtual double GetDistanceMin () const
 
virtual void SetDistanceMin (double _arg)
 
virtual double GetDistanceMax () const
 
virtual void SetDistanceMax (double _arg)
 
virtual double GetEpsilon () const
 
virtual void SetEpsilon (double _arg)
 
virtual bool GetPolarity () const
 
virtual void SetPolarity (bool _arg)
 
virtual void PolarityOn ()
 
virtual void PolarityOff ()
 
- 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 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
 

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

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

double m_DistanceMax
 
double m_DistanceMin
 
double m_Epsilon
 
InputType m_Origin
 
GradientType m_OriginGradient
 
bool m_Polarity
 

Additional Inherited Members

- 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::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
typedef CovariantVector< double, VDimension > itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GradientType

The type of vector used to store the gradient info.

Definition at line 86 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Input type for the function.

Definition at line 77 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Output type for the function.

Definition at line 83 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Standard class typedefs.

Definition at line 67 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Constructor & Destructor Documentation

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

Member Function Documentation

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

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMax ( ) const
virtual

Set/Get the maximum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMin ( ) const
virtual

Set/Get the minimum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetEpsilon ( ) const
virtual

Set/Get the tolerance of the in/out comparison.

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

Run time information.

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual InputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOrigin ( ) const
virtual

Set/Get the origin of the function.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient ( )
inline

Set/Get the gradient at the origin of the function.

Definition at line 97 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetPolarity ( ) const
virtual

Set/Get direction along the gradient to search. Set to true to use the direction that the gradient is pointing; set to false for the opposite direction. Default is Off.

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

Method for creation through the object factory.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PolarityOff ( )
virtual

Set/Get direction along the gradient to search. Set to true to use the direction that the gradient is pointing; set to false for the opposite direction. Default is Off.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PolarityOn ( )
virtual

Set/Get direction along the gradient to search. Set to true to use the direction that the gradient is pointing; set to false for the opposite direction. Default is Off.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::ConicShellInteriorExteriorSpatialFunction< 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.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetDistanceMax ( double  _arg)
virtual

Set/Get the maximum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetDistanceMin ( double  _arg)
virtual

Set/Get the minimum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetEpsilon ( double  _arg)
virtual

Set/Get the tolerance of the in/out comparison.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrigin ( InputType  _arg)
virtual

Set/Get the origin of the function.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetOriginGradient ( GradientType  grad)

Set/Get the gradient at the origin of the function.

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetPolarity ( bool  _arg)
virtual

Set/Get direction along the gradient to search. Set to true to use the direction that the gradient is pointing; set to false for the opposite direction. Default is Off.

Member Data Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMax
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMin
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Epsilon
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
InputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Origin
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_OriginGradient
private
template<unsigned int VDimension = 3, typename TInput = Point< double, VDimension >>
bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Polarity
private

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