#include <itkSphereSignedDistanceFunction.h>

Detailed Description

template<typename TCoordRep, unsigned int VSpaceDimension>
class itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >

Compute the signed distance from a N-dimensional sphere.

A instance of sphere is defined by a set parameters. The first parameter is the radius and the next SpaceDimension parameters represent the center. The first parameter forms the set of ShapeParameters and the remaining parameters the set of PoseParameters.

This class is templated over the coordinate representation type (e.g. float or double) and the space dimension.

See also: ShapeSignedDistanceFunction

Definition at line 45 of file itkSphereSignedDistanceFunction.h.

Inheritance diagram for itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >:

Collaboration diagram for itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = SphereSignedDistanceFunction

using	Superclass = ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >

Public Types inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
using	ConstPointer = SmartPointer< const Self >

using	CoordRepType = TCoordRep

using	ParametersType = OptimizerParameters< double >

using	Pointer = SmartPointer< Self >

using	PointType = InputType

using	Self = ShapeSignedDistanceFunction

using	Superclass = SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >

Public Types inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = SpatialFunction

using	Superclass = FunctionBase< Point< TCoordRep, VSpaceDimension >, double >

Public Types inherited from itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< TCoordRep, VSpaceDimension >

using	OutputType = double

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
OutputType	Evaluate (const PointType &point) const override

const char *	GetNameOfClass () const override

unsigned int	GetNumberOfPoseParameters () const override

unsigned int	GetNumberOfShapeParameters () const override

void	SetParameters (const ParametersType &) override

Public Member Functions inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
OutputType	Evaluate (const PointType &point) const override=0

const char *	GetNameOfClass () const override

virtual unsigned int	GetNumberOfParameters () const

virtual unsigned int	GetNumberOfPoseParameters () const =0

virtual unsigned int	GetNumberOfShapeParameters () const =0

virtual ParametersType &	GetParameters ()

virtual void	Initialize ()

virtual void	SetParameters (const ParametersType &)=0

Public Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
OutputType	Evaluate (const InputType &input) const override=0

const char *	GetNameOfClass () const override

virtual OutputType	Evaluate (const InputType &input) const=0

const char *	GetNameOfClass () const override

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

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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

Static Public Attributes
static constexpr unsigned int	SpaceDimension = Superclass::SpaceDimension

Static Public Attributes inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
static constexpr unsigned int	SpaceDimension = VSpaceDimension

Static Public Attributes inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
static constexpr unsigned int	ImageDimension

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

	SphereSignedDistanceFunction ()

	~SphereSignedDistanceFunction () override=default

Protected Member Functions inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
void	PrintSelf (std::ostream &os, Indent indent) const override

	ShapeSignedDistanceFunction ()=default

	~ShapeSignedDistanceFunction () override=default

Protected Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
void	PrintSelf (std::ostream &os, Indent indent) const override

	SpatialFunction ()=default

	~SpatialFunction () override=default

Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >
	FunctionBase ()=default

	~FunctionBase () override=default

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

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

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

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	PrintSelf (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Types
using	VectorType = Vector< CoordRepType, Self::SpaceDimension >

Private Attributes
double	m_Radius {}

VectorType	m_Translation {}

Additional Inherited Members
Protected Attributes inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
ParametersType	m_Parameters {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkSphereSignedDistanceFunction.h.

◆ Pointer

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkSphereSignedDistanceFunction.h.

◆ Self

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Self = SphereSignedDistanceFunction

Standard class type aliases.

Definition at line 51 of file itkSphereSignedDistanceFunction.h.

◆ Superclass

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Superclass = ShapeSignedDistanceFunction<TCoordRep, VSpaceDimension>

Definition at line 52 of file itkSphereSignedDistanceFunction.h.

◆ VectorType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::VectorType = Vector<CoordRepType, Self::SpaceDimension>

private

Definition at line 108 of file itkSphereSignedDistanceFunction.h.

Constructor & Destructor Documentation

◆ SphereSignedDistanceFunction()

template<typename TCoordRep , unsigned int VSpaceDimension>

itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SphereSignedDistanceFunction ( )

protected

◆ ~SphereSignedDistanceFunction()

template<typename TCoordRep , unsigned int VSpaceDimension>

itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::~SphereSignedDistanceFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TCoordRep , unsigned int VSpaceDimension>

OutputType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Evaluate ( const PointType & point ) const

overridevirtual

Evaluate the signed distance from a shape at a given position.

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

◆ GetNameOfClass()

template<typename TCoordRep , unsigned int VSpaceDimension>

const char * itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

◆ GetNumberOfPoseParameters()

template<typename TCoordRep , unsigned int VSpaceDimension>

unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfPoseParameters ( ) const

inlineoverridevirtual

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 91 of file itkSphereSignedDistanceFunction.h.

◆ GetNumberOfShapeParameters()

template<typename TCoordRep , unsigned int VSpaceDimension>

unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfShapeParameters ( ) const

inlineoverridevirtual

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Definition at line 86 of file itkSphereSignedDistanceFunction.h.

◆ New()

template<typename TCoordRep , unsigned int VSpaceDimension>

static Pointer itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::New ( )

static

New macro for creation of through the object factory.

◆ PrintSelf()

template<typename TCoordRep , unsigned int VSpaceDimension>

void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::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::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

◆ SetParameters()

template<typename TCoordRep , unsigned int VSpaceDimension>

void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SetParameters ( const ParametersType & )

overridevirtual

A sphere is defined by a set of shape parameters. The first parameter is the radius and the next SpaceDimension parameters represent the center.

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

Member Data Documentation

◆ m_Radius

template<typename TCoordRep , unsigned int VSpaceDimension>

double itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Radius {}

private

Definition at line 111 of file itkSphereSignedDistanceFunction.h.

◆ m_Translation

template<typename TCoordRep , unsigned int VSpaceDimension>

VectorType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Translation {}

private

Definition at line 110 of file itkSphereSignedDistanceFunction.h.

◆ SpaceDimension

template<typename TCoordRep , unsigned int VSpaceDimension>

constexpr unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SpaceDimension = Superclass::SpaceDimension

staticconstexpr

Dimension underlying input image.

Definition at line 69 of file itkSphereSignedDistanceFunction.h.

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

itkSphereSignedDistanceFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ SphereSignedDistanceFunction()

◆ ~SphereSignedDistanceFunction()

Member Function Documentation

◆ Evaluate()

◆ GetNameOfClass()

◆ GetNumberOfPoseParameters()

◆ GetNumberOfShapeParameters()

◆ New()

◆ PrintSelf()

◆ SetParameters()

Member Data Documentation

◆ m_Radius

◆ m_Translation

◆ SpaceDimension