itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension > Class Template Reference
[Image Functions]

#include <itkSphereSignedDistanceFunction.h>

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

[legend]Collaboration diagram for itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >:

[legend]List of all members.

---

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 42 of file itkSphereSignedDistanceFunction.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::CoordRepType	CoordRepType
typedef Superclass::InputType	InputType
typedef Superclass::OutputType	OutputType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef SphereSignedDistanceFunction	Self
typedef ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual OutputType	Evaluate (const InputType &input) const =0
virtual OutputType	Evaluate (const PointType &point) const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters (void) const
virtual unsigned int	GetNumberOfPoseParameters (void) const
virtual unsigned int	GetNumberOfShapeParameters (void) const
virtual ParametersType &	GetParameters (void)
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
virtual void	Initialize () throw ( ExceptionObject )
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, VImageDimension)
	itkStaticConstMacro (SpaceDimension, unsigned int, VSpaceDimension)
	itkStaticConstMacro (SpaceDimension, unsigned int, Superclass::SpaceDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
A sphere is defined by a set of shape parameters The first parameter *is the radius and the next SpaceDimension parameters represent the center *virtual void	SetParameters (const ParametersType &)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	FunctionBase ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SpatialFunction ()
	SphereSignedDistanceFunction ()
	~SphereSignedDistanceFunction ()
Protected Attributes
ParametersType	m_Parameters
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<typename TCoordRep, unsigned int VSpaceDimension> typedef SmartPointer<const Self> itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::ConstPointer

Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 50 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef Superclass::CoordRepType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::CoordRepType

CoordRep typedef support. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 68 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef Superclass::InputType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::InputType

InputeType typedef support. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 62 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef Superclass::OutputType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::OutputType

OutputType typedef support. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 56 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef Superclass::ParametersType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::ParametersType

Type of the shape parameters. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 74 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef SmartPointer<Self> itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Pointer

Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 49 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef Superclass::PointType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::PointType

Point typedef support. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 71 of file itkSphereSignedDistanceFunction.h.

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

Standard class typedefs. Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 47 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> typedef ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension > itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Superclass

Reimplemented from itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 48 of file itkSphereSignedDistanceFunction.h.

---

Constructor & Destructor Documentation

template<typename TCoordRep, unsigned int VSpaceDimension> itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SphereSignedDistanceFunction (   )  [protected]

template<typename TCoordRep, unsigned int VSpaceDimension> itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::~SphereSignedDistanceFunction (   )  [inline, protected]

Definition at line 90 of file itkSphereSignedDistanceFunction.h.

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual OutputType itk::SpatialFunction< double , VImageDimension, Point< TCoordRep, VSpaceDimension > >::Evaluate (  const InputType &  input  )  const [pure virtual, inherited]

Evaluate the function at a given position. Remember, position is represented by an n-d itk::Point object with data type double. Implements itk::FunctionBase< Point< TCoordRep, VSpaceDimension >, double >.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual OutputType itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::Evaluate (  const PointType &  point  )  const [virtual]

Evaluate the signed distance from a shape at a given position. Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

itk::FunctionBase< Point< TCoordRep, VSpaceDimension > , double >::FunctionBase (   )  [inline, protected, inherited]

Definition at line 66 of file itkFunctionBase.h.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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 >.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual unsigned int itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfParameters (  void   )  const [inline, virtual, inherited]

Definition at line 88 of file itkShapeSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfPoseParameters (  void   )  const [inline, virtual]

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 81 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual unsigned int itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetNumberOfShapeParameters (  void   )  const [inline, virtual]

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >. Definition at line 79 of file itkSphereSignedDistanceFunction.h.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual ParametersType& itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::GetParameters (  void   )  [inline, virtual, inherited]

Definition at line 84 of file itkShapeSignedDistanceFunction.h.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

template<typename TCoordRep, unsigned int VSpaceDimension> virtual void itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::Initialize (  void   )  throw ( ExceptionObject ) [inline, virtual, inherited]

Initialize must be called before the first call of SetParameters() or Evaluate() to allow the class to validate any inputs. Reimplemented in itk::PCAShapeSignedDistanceFunction< TCoordRep, VSpaceDimension, TImage >. Definition at line 97 of file itkShapeSignedDistanceFunction.h.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

itk::SpatialFunction< double , VImageDimension, Point< TCoordRep, VSpaceDimension > >::itkStaticConstMacro (  ImageDimension  , unsigned  int, VImageDimension  )  [inherited]

Spatial dimension.

template<typename TCoordRep, unsigned int VSpaceDimension> itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::itkStaticConstMacro (  SpaceDimension  , unsigned  int, VSpaceDimension  )  [inherited]

Dimension underlying input image.

template<typename TCoordRep, unsigned int VSpaceDimension> itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::itkStaticConstMacro (  SpaceDimension  , unsigned  int, Superclass::SpaceDimension  )

Dimension underlying input image.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<typename TCoordRep, unsigned int VSpaceDimension> static Pointer itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::New (   )  [static]

New macro for creation of through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<typename TCoordRep, unsigned int VSpaceDimension> void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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 >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<typename TCoordRep, unsigned int VSpaceDimension> A sphere is defined by a set of shape parameters The first parameter* is the radius and the next SpaceDimension parameters represent the center* virtual void itk::SphereSignedDistanceFunction< TCoordRep, VSpaceDimension >::SetParameters (  const ParametersType &   )  [virtual]

Implements itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >.

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

itk::SpatialFunction< double , VImageDimension, Point< TCoordRep, VSpaceDimension > >::SpatialFunction (   )  [protected, inherited]

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<typename TCoordRep, unsigned int VSpaceDimension> ParametersType itk::ShapeSignedDistanceFunction< TCoordRep, VSpaceDimension >::m_Parameters [protected, inherited]

Definition at line 111 of file itkShapeSignedDistanceFunction.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkSphereSignedDistanceFunction.h

---