itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput > Class Template Reference

#include <itkConicShellInteriorExteriorSpatialFunction.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < double, VDimension >	GradientType
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef SmartPointer< Self >	Pointer
typedef ConicShellInteriorExteriorSpatialFunction	Self
typedef InteriorExteriorSpatialFunction < VDimension >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
OutputType	Evaluate (const InputType &position) const
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)
Static Public Member Functions
static Pointer	New ()
Private Member Functions
	ConicShellInteriorExteriorSpatialFunction (const Self &)
void	operator= (const Self &)
Private Attributes
double	m_DistanceMax
double	m_DistanceMin
double	m_Epsilon
InputType	m_Origin
GradientType	m_OriginGradient
bool	m_Polarity
virtual bool	GetPolarity () const
virtual void	SetPolarity (bool _arg)
	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 60 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 69 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 85 of file itkConicShellInteriorExteriorSpatialFunction.h.

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 76 of file itkConicShellInteriorExteriorSpatialFunction.h.

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 82 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 68 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 66 of file itkConicShellInteriorExteriorSpatialFunction.h.

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 67 of file itkConicShellInteriorExteriorSpatialFunction.h.

---

Constructor & Destructor Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::ConicShellInteriorExteriorSpatialFunction

(

)

[protected]

Set/Get direction along the gradient to search.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::~ConicShellInteriorExteriorSpatialFunction

(

)

[protected, virtual]

Set/Get direction along the gradient to search.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::ConicShellInteriorExteriorSpatialFunction

(

const Self &

)

[private]

---

Member Function Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual::itk::LightObject::Pointer itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::CreateAnother

(

void

)

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, 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 double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMax

(

)

const [virtual]

Set/Get the maximum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetDistanceMin

(

)

const [virtual]

Set/Get the minimum search distance.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

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, 3 >>

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, 3 >>

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, 3 >>

GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetOriginGradient

(

)

[inline]

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

Definition at line 96 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

virtual bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::GetPolarity

(

)

const [virtual]

Set/Get direction along the gradient to search.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

static 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 >::operator=

(

const Self &

)

[private]

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

void itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Set/Get direction along the gradient to search.

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.

---

Member Data Documentation

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMax [private]

Definition at line 137 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_DistanceMin [private]

Definition at line 136 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

double itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Epsilon [private]

Definition at line 138 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

InputType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Origin [private]

The origin of the conic shell

Definition at line 131 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

GradientType itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_OriginGradient [private]

The gradient at the origin

Definition at line 134 of file itkConicShellInteriorExteriorSpatialFunction.h.

template<unsigned int VDimension = 3, typename TInput = Point< double, 3 >>

bool itk::ConicShellInteriorExteriorSpatialFunction< VDimension, TInput >::m_Polarity [private]

Definition at line 139 of file itkConicShellInteriorExteriorSpatialFunction.h.

---

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

• itkConicShellInteriorExteriorSpatialFunction.h