#include <itkPCAShapeSignedDistanceFunction.h>

Detailed Description

template<typename TCoordRep, unsigned int VSpaceDimension, typename TImage = Image<double, VSpaceDimension>>
class itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >

Compute the signed distance from a N-dimensional PCA Shape.

This class computes the signed distance from a N-dimensional shape defined by: (1) a mean signed distance image \( M(x) \), (2) the first \( q \) principal components images \( P_i(x) \) and (3) a transform \( T(x) \) to define the pose (i.e. position or orientation of the shape).

A particular instance of the shape is defined by a set of parameters \( p \). The first \( q \) parameters defines the weights applied to each principal components and the remaining parameters is used to define the transform. The user should refer to the documentation of the particular Transform class being used. The first set of parameters are called the ShapeParameters and the remaining parameters the PoseParameters.

The method Evaluate( point x ) returns the approximate signed to the shape at point x such that:

\[ s = M(T(x)) + \sum_i^{q} p[i] * \sigma[i] * P_i(T(x)) \]

Where \(\sigma[i]\) are the square root of the eigenvalues. These are defined using method SetPrincipalComponentStandardDeviations().

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

See also: ShapeSignedDistanceFunction; Transform

Definition at line 67 of file itkPCAShapeSignedDistanceFunction.h.

Inheritance diagram for itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >:

Collaboration diagram for itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ExtrapolatorPointer = typename ExtrapolatorType::Pointer

using	ExtrapolatorPointerVector = std::vector< ExtrapolatorPointer >

using	ExtrapolatorType = ExtrapolateImageFunction< ImageType, CoordRepType >

using	FunctionPointer = typename FunctionType::Pointer

using	FunctionPointerVector = std::vector< FunctionPointer >

using	FunctionType = ImageFunction< ImageType, double, CoordRepType >

using	ImagePointer = typename ImageType::Pointer

using	ImagePointerVector = std::vector< ImagePointer >

using	ImageType = TImage

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorPointerVector = std::vector< InterpolatorPointer >

using	InterpolatorType = InterpolateImageFunction< ImageType, CoordRepType >

using	Pointer = SmartPointer< Self >

using	Self = PCAShapeSignedDistanceFunction

using	Superclass = ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >

using	TransformType = Transform< CoordRepType, Self::SpaceDimension, Self::SpaceDimension >

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

virtual unsigned int	GetNumberOfPrincipalComponents () const

unsigned int	GetNumberOfShapeParameters () const override

void	Initialize () override

void	SetNumberOfPrincipalComponents (unsigned int n)

void	SetParameters (const ParametersType &) override


virtual void	SetMeanImage (ImageType *_arg)

virtual ImageType *	GetModifiableMeanImage ()


void	SetPrincipalComponentImages (ImagePointerVector v)


virtual void	SetPrincipalComponentStandardDeviations (ParametersType _arg)

virtual ParametersType	GetPrincipalComponentStandardDeviations () const


virtual void	SetTransform (TransformType *_arg)

virtual TransformType *	GetModifiableTransform ()

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

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

	~PCAShapeSignedDistanceFunction () 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 Attributes
ExtrapolatorPointerVector	m_Extrapolators {}

InterpolatorPointerVector	m_Interpolators {}

ImagePointer	m_MeanImage {}

unsigned int	m_NumberOfPrincipalComponents {}

unsigned int	m_NumberOfTransformParameters {}

ImagePointerVector	m_PrincipalComponentImages {}

ParametersType	m_PrincipalComponentStandardDeviations {}

TransformType::Pointer	m_Transform {}

ParametersType	m_TransformParameters {}

ParametersType	m_WeightOfPrincipalComponents {}

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