#include <itkSphereSignedDistanceFunction.h>

Detailed Description

template<typename TCoordinate, unsigned int VSpaceDimension>
class itk::SphereSignedDistanceFunction< TCoordinate, 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< TCoordinate, VSpaceDimension >:

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	CoordinateType

typedef Point< TCoordinate, VSpaceDimension >	InputType

typedef double	OutputType

using	ParametersType

using	Pointer = SmartPointer<Self>

using	PointType

using	Self = SphereSignedDistanceFunction

using	Superclass = ShapeSignedDistanceFunction<TCoordinate, VSpaceDimension>

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

using	CoordinateType = TCoordinate

typedef Point< TCoordinate, VSpaceDimension >	InputType

typedef double	OutputType

using	ParametersType = OptimizerParameters<double>

using	Pointer = SmartPointer<Self>

using	PointType = InputType

using	Self = ShapeSignedDistanceFunction

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

Public Types inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordinate, VSpaceDimension > >
using	ConstPointer

typedef Point< TCoordinate, VSpaceDimension >	InputType

using	InputType

typedef double	OutputType

using	OutputType

using	Pointer

using	Self

using	Superclass

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 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< TCoordinate, VSpaceDimension >
virtual unsigned int	GetNumberOfParameters () const

virtual ParametersType &	GetParameters ()

virtual void	Initialize ()

Public Member Functions inherited from itk::FunctionBase< TInput, TOutput >
virtual OutputType	Evaluate (const InputType &input) const =0

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

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

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

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

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< TCoordinate, VSpaceDimension >
	ShapeSignedDistanceFunction ()=default

	~ShapeSignedDistanceFunction () override=default

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

	SpatialFunction ()=default

	~SpatialFunction () override=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 Types
using	VectorType = Vector<CoordinateType, Self::SpaceDimension>

Private Attributes
double	m_Radius {}

VectorType	m_Translation {}

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

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

Member Typedef Documentation

◆ ConstPointer

template<typename TCoordinate, unsigned int VSpaceDimension>

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

Definition at line 55 of file itkSphereSignedDistanceFunction.h.

◆ CoordinateType

template<typename TCoordinate, unsigned int VSpaceDimension>

using itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >::CoordinateType

CoordRep type alias support

Definition at line 79 of file itkShapeSignedDistanceFunction.h.

◆ InputType

template<typename TCoordinate, unsigned int VSpaceDimension>

Input type

◆ OutputType

template<typename TCoordinate, unsigned int VSpaceDimension>

Output type

◆ ParametersType

template<typename TCoordinate, unsigned int VSpaceDimension>

using itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >::ParametersType

Type of the shape parameters.

Definition at line 89 of file itkShapeSignedDistanceFunction.h.

◆ Pointer

template<typename TCoordinate, unsigned int VSpaceDimension>

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

Definition at line 54 of file itkSphereSignedDistanceFunction.h.

◆ PointType

template<typename TCoordinate, unsigned int VSpaceDimension>

using itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >::PointType

Point type alias support

Definition at line 86 of file itkShapeSignedDistanceFunction.h.

◆ Self

template<typename TCoordinate, unsigned int VSpaceDimension>

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

Standard class type aliases.

Definition at line 52 of file itkSphereSignedDistanceFunction.h.

◆ Superclass

template<typename TCoordinate, unsigned int VSpaceDimension>

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

Definition at line 53 of file itkSphereSignedDistanceFunction.h.

◆ VectorType

template<typename TCoordinate, unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordinate, VSpaceDimension >::VectorType = Vector<CoordinateType, Self::SpaceDimension>

private

Definition at line 109 of file itkSphereSignedDistanceFunction.h.

Constructor & Destructor Documentation

◆ SphereSignedDistanceFunction()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

protected

Referenced by GetNameOfClass().

◆ ~SphereSignedDistanceFunction()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TCoordinate, unsigned int VSpaceDimension>

virtual::itk::LightObject::Pointer itk::SphereSignedDistanceFunction< TCoordinate, VSpaceDimension >::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<typename TCoordinate, unsigned int VSpaceDimension>

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

overridevirtual

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

Implements itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >.

References itk::point().

◆ GetNameOfClass()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

References SphereSignedDistanceFunction().

◆ GetNumberOfPoseParameters()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

inlineoverridevirtual

Implements itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >.

Definition at line 92 of file itkSphereSignedDistanceFunction.h.

References SpaceDimension.

◆ GetNumberOfShapeParameters()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

inlineoverridevirtual

Implements itk::ShapeSignedDistanceFunction< TCoordinate, VSpaceDimension >.

Definition at line 87 of file itkSphereSignedDistanceFunction.h.

◆ New()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

static

New macro for creation of through the object factory.

◆ PrintSelf()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

◆ SetParameters()

template<typename TCoordinate, unsigned int VSpaceDimension>

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

Member Data Documentation

◆ m_Radius

template<typename TCoordinate, unsigned int VSpaceDimension>

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

private

Definition at line 112 of file itkSphereSignedDistanceFunction.h.

◆ m_Translation

template<typename TCoordinate, unsigned int VSpaceDimension>

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

private

Definition at line 111 of file itkSphereSignedDistanceFunction.h.

◆ SpaceDimension

template<typename TCoordinate, unsigned int VSpaceDimension>

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

staticconstexpr

Dimension underlying input image.

Definition at line 70 of file itkSphereSignedDistanceFunction.h.

Referenced by GetNumberOfPoseParameters().

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

◆ CoordinateType

◆ InputType

◆ OutputType

◆ ParametersType

◆ Pointer

◆ PointType

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ SphereSignedDistanceFunction()

◆ ~SphereSignedDistanceFunction()

Member Function Documentation

◆ CreateAnother()

◆ Evaluate()

◆ GetNameOfClass()

◆ GetNumberOfPoseParameters()

◆ GetNumberOfShapeParameters()

◆ New()

◆ PrintSelf()

◆ SetParameters()

Member Data Documentation

◆ m_Radius

◆ m_Translation

◆ SpaceDimension