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

Spatial function implementation of a conic shell. More...

#include <itkConicShellInteriorExteriorSpatialFunction.h>

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

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

[legend]List of all members.

Public Types
typedef ConicShellInteriorExteriorSpatialFunction	Self
typedef InteriorExteriorSpatialFunction< VDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef CovariantVector< double, VDimension >	GradientType
Public Member Functions
virtual const char *	GetClassName () const
OutputType	Evaluate (const InputType &position) const
virtual InputType	GetOrigin ()
virtual void	SetOrigin (InputType _arg)
GradientType	GetOriginGradient ()
void	SetOriginGradient (GradientType grad)
virtual double	GetDistanceMin ()
virtual void	SetDistanceMin (double _arg)
virtual double	GetDistanceMax ()
virtual void	SetDistanceMax (double _arg)
virtual double	GetEpsilon ()
virtual void	SetEpsilon (double _arg)
virtual bool	GetPolarity ()
virtual void	SetPolarity (bool _arg)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ConicShellInteriorExteriorSpatialFunction ()
virtual	~ConicShellInteriorExteriorSpatialFunction ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

Detailed Description

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

Polarity, i.e. which direction along the gradient of BoundaryPoint1 you want to look.

Definition at line 57 of file itkConicShellInteriorExteriorSpatialFunction.h.

---

Member Typedef Documentation

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

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 66 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

The type of vector used to store the gradient info. Definition at line 81 of file itkConicShellInteriorExteriorSpatialFunction.h. Referenced by itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient().

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

Input type for the function. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 75 of file itkConicShellInteriorExteriorSpatialFunction.h. Referenced by itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient().

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

Output type for the function. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 78 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 65 of file itkConicShellInteriorExteriorSpatialFunction.h.

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

Standard class typedefs. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 63 of file itkConicShellInteriorExteriorSpatialFunction.h. Referenced by itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient().

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

Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >. Definition at line 64 of file itkConicShellInteriorExteriorSpatialFunction.h.

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

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

Evaluates the function at a given position Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

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

Run time information. Reimplemented from itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

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

Set/Get the maximum search distance.

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

Set/Get the minimum search distance.

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

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

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

Set/Get the origin of the function.

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

Set/Get the gradient at the origin of the function. Definition at line 92 of file itkConicShellInteriorExteriorSpatialFunction.h. References itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GradientType, itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::InputType, and itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::Self.

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

Set/Get direction along the gradient to search.

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

Method for creation through the object factory. Reimplemented from itk::Object.

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

template<unsigned int VDimension = 3, typename TInput = Point<double,3>> 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,3>> 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,3>> 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,3>> 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,3>> 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,3>> virtual void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::SetPolarity (  bool  _arg  )  [virtual]

Set/Get direction along the gradient to search.

---

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

• itkConicShellInteriorExteriorSpatialFunction.h

---