itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Reference

#include <itkSphereSignedDistanceFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >
using	CoordRepType = typename Superclass::CoordRepType
using	InputType = typename Superclass::InputType
using	OutputType = typename Superclass::OutputType
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	PointType = typename Superclass::PointType
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	InputType = typename Superclass::InputType
using	OutputType = typename Superclass::OutputType
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	InputType = typename Superclass::InputType
using	OutputType = typename Superclass::OutputType
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
virtual ::itk::LightObject::Pointer	CreateAnother () const
OutputType	Evaluate (const PointType &point) const override
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfPoseParameters () const override
unsigned int	GetNumberOfShapeParameters () const override
void	SetParameters (const ParametersType &) override
Public Member Functions inherited from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >
virtual unsigned int	GetNumberOfParameters () const
virtual ParametersType &	GetParameters ()
virtual void	Initialize ()
Public Member Functions inherited from itk::SpatialFunction< double, VSpaceDimension, Point< TCoordRep, VSpaceDimension > >
OutputType	Evaluate (const InputType &input) const override=0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) 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)
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< 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 >
	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 ()
	~Object () override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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< 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

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.

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.

CoordRepType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::CoordRepType = typename Superclass::CoordRepType

CoordRep type alias support

Definition at line 72 of file itkSphereSignedDistanceFunction.h.

InputType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::InputType = typename Superclass::InputType

InputeType type alias support

Definition at line 66 of file itkSphereSignedDistanceFunction.h.

OutputType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::OutputType = typename Superclass::OutputType

OutputType type alias support

Definition at line 63 of file itkSphereSignedDistanceFunction.h.

ParametersType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::ParametersType = typename Superclass::ParametersType

Type of the shape parameters.

Definition at line 78 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.

PointType

template<typename TCoordRep , unsigned int VSpaceDimension>

using itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 75 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

CreateAnother()

template<typename TCoordRep , unsigned int VSpaceDimension>

virtual::itk::LightObject::Pointer itk::SphereSignedDistanceFunction< TCoordRep, 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 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>

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

virtual

Run-time type information (and related methods).

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