#include <itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h>

Detailed Description

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

Function implementation of an ellipsoid.

Similar to EllipsoidInteriorExteriorSpatialFunction in that it implements a function that returns 1 for points inside or on the surface of a ellipsoid and 0 for points outside the ellipsoid. However, this ellipsoid is defined by a single orientation vector and deals only with symmetric ellipsoids. An n-dimensional symmetric ellipsoid is one which has m axes of equal length and (n - m) unique axes lengths. Specifically, this class deals with the case where (n - m) = 1 and the ellipsoid's major axis is oriented along a singles orientation vector.

Definition at line 39 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = SymmetricEllipsoidInteriorExteriorSpatialFunction

using	Superclass = InteriorExteriorSpatialFunction<VDimension>

using	VectorType = Vector<double, VDimension>

Public Types inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = InteriorExteriorSpatialFunction

using	Superclass = SpatialFunction<bool, VDimension, TInput>

Public Types inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
using	ConstPointer = SmartPointer<const Self>

using	InputType

using	OutputType

using	Pointer = SmartPointer<Self>

using	Self = SpatialFunction

using	Superclass = FunctionBase<TInput, TOutput>

Public Types inherited from itk::FunctionBase< TInput, TOutput >
using	ConstPointer = SmartPointer<const Self>

using	InputType = TInput

using	OutputType = TOutput

using	Pointer = SmartPointer<Self>

using	Self = FunctionBase

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual::itk::LightObject::Pointer	CreateAnother () const

OutputType	Evaluate (const InputType &position) const override

const char *	GetNameOfClass () const override

void	SetOrientation (VectorType orientation, double uniqueAxis, double symmetricAxes)


virtual InputType	GetCenter () const

virtual void	SetCenter (InputType _arg)

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	SymmetricEllipsoidInteriorExteriorSpatialFunction ()

	~SymmetricEllipsoidInteriorExteriorSpatialFunction () override=default

Protected Member Functions inherited from itk::InteriorExteriorSpatialFunction< VDimension, TInput >
	InteriorExteriorSpatialFunction ()=default

	~InteriorExteriorSpatialFunction () override=default

Protected Member Functions inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
	SpatialFunction ()=default

	~SpatialFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< TInput, TOutput >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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
InputType	m_Center {}

Vector< double, VDimension >	m_Orientation {}

double	m_SymmetricAxes { 5 }

double	m_UniqueAxis { 10 }

double	m_VectorRatio { 0.0 }

Additional Inherited Members
Static Public Attributes inherited from itk::SpatialFunction< TOutput, VImageDimension, TInput >
static constexpr unsigned int	ImageDimension = VImageDimension

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

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

using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ Pointer

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

using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ Self

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

using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::Self = SymmetricEllipsoidInteriorExteriorSpatialFunction

Standard class type aliases.

Definition at line 46 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ Superclass

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

using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::Superclass = InteriorExteriorSpatialFunction<VDimension>

Definition at line 47 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ VectorType

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

using itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::VectorType = Vector<double, VDimension>

Definition at line 50 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

Constructor & Destructor Documentation

◆ SymmetricEllipsoidInteriorExteriorSpatialFunction()

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

itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SymmetricEllipsoidInteriorExteriorSpatialFunction ( )

protected

Referenced by GetNameOfClass().

◆ ~SymmetricEllipsoidInteriorExteriorSpatialFunction()

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

itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::~SymmetricEllipsoidInteriorExteriorSpatialFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< 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.

◆ Evaluate()

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

OutputType itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::Evaluate ( const InputType & position ) const

overridevirtual

Evaluates the function at a given position.

Implements itk::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ GetCenter()

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

virtual InputType itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::GetCenter ( ) const

virtual

Get and set the center of the ellipsoid.

◆ GetNameOfClass()

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

const char * itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

References SymmetricEllipsoidInteriorExteriorSpatialFunction().

◆ New()

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

static Pointer itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

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

void itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< 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::InteriorExteriorSpatialFunction< VDimension, TInput >.

◆ SetCenter()

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

virtual void itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SetCenter ( InputType _arg )

virtual

Get and set the center of the ellipsoid.

◆ SetOrientation()

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

void itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::SetOrientation	(	VectorType	orientation,
		double	uniqueAxis,
		double	symmetricAxes )

Set the orientation vector of the ellipsoid's unique axis and axes lengths. Must be normalized!!!!!

Member Data Documentation

◆ m_Center

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

InputType itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Center {}

private

The center of the ellipsoid.

Definition at line 87 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_Orientation

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

Vector<double, VDimension> itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_Orientation {}

private

The orientation vector of the ellipsoid's unique axis.

Definition at line 96 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_SymmetricAxes

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

double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_SymmetricAxes { 5 }

private

The symmetric axes lengths of the ellipsoid.

Definition at line 93 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_UniqueAxis

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

double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_UniqueAxis { 10 }

private

The unique axis length of the ellipsoid.

Definition at line 90 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

◆ m_VectorRatio

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

double itk::SymmetricEllipsoidInteriorExteriorSpatialFunction< VDimension, TInput >::m_VectorRatio { 0.0 }

private

The vector ratio.

Definition at line 99 of file itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h.

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

itkSymmetricEllipsoidInteriorExteriorSpatialFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ SymmetricEllipsoidInteriorExteriorSpatialFunction()

◆ ~SymmetricEllipsoidInteriorExteriorSpatialFunction()

Member Function Documentation

◆ CreateAnother()

◆ Evaluate()

◆ GetCenter()

◆ GetNameOfClass()

◆ New()

◆ PrintSelf()

◆ SetCenter()

◆ SetOrientation()

Member Data Documentation

◆ m_Center

◆ m_Orientation

◆ m_SymmetricAxes

◆ m_UniqueAxis

◆ m_VectorRatio