itk::NonUniformBSpline< TDimension > Class Template Reference

#include <itkNonUniformBSpline.h>

Inheritance diagram for itk::NonUniformBSpline< TDimension >:

[legend]Collaboration diagram for itk::NonUniformBSpline< TDimension >:

[legend]List of all members.

---

Detailed Description

template<unsigned int TDimension = 3>
class itk::NonUniformBSpline< TDimension >

BSpline with nonuniform knot spacing.

This class is a bspline with nonuniform knot spacing. The use can specify a set of points and a set of knots and the spline will attempt to find the control points which will cause the spline to interpolate the points.

CAUTION: THIS CLASS IS STILL UNDER DEVELOPMENT.

Definition at line 48 of file itkNonUniformBSpline.h.

Public Types
typedef std::vector< double >	ChordLengthListType
typedef SmartPointer< const Self >	ConstPointer
typedef ControlPointListType *	ControlPointListPointer
typedef std::vector< ControlPointType >	ControlPointListType
typedef itk::Point< double, TDimension >	ControlPointType
typedef std::vector< double >	CoordinateListType
typedef std::vector< double >	KnotListType
typedef SmartPointer< Self >	Pointer
typedef PointListType *	PointListPointer
typedef std::vector< PointType >	PointListType
typedef itk::Point< ScalarType, TDimension >	PointType
typedef double	ScalarType
typedef NonUniformBSpline	Self
typedef Object	Superclass
Public Member Functions
void	ComputeChordLengths ()
void	ComputeControlPoints ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
PointType	EvaluateSpline (double t) const
Methods for evaluating the spline The parameterization is always between and *PointType	EvaluateSpline (const Array< double > &p) const
Command *	GetCommand (unsigned long tag)
ControlPointListType &	GetControlPoints ()
bool	GetDebug () const
KnotListType &	GetKnots ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
PointListType &	GetPoints ()
virtual int	GetReferenceCount () const
unsigned int	GetSplineOrder ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
double	NonUniformBSplineFunctionRecursive (unsigned int order, unsigned int i, double t) const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetControlPoints (ControlPointListType &ctrlpts)
void	SetDebug (bool debugFlag) const
void	SetKnots (KnotListType &newKnots)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetPoints (PointListType &newPoints)
virtual void	SetReferenceCount (int)
Set the order of the spline *void	SetSplineOrder (unsigned int order)
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
	NonUniformBSpline ()
bool	PrintObservers (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	~NonUniformBSpline ()
Protected Attributes
ChordLengthListType	m_ChordLength
ControlPointListType	m_ControlPoints
ChordLengthListType	m_CumulativeChordLength
KnotListType	m_Knots
PointListType	m_Points
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
unsigned int	m_SpatialDimension
unsigned int	m_SplineOrder
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<unsigned int TDimension = 3> typedef std::vector<double> itk::NonUniformBSpline< TDimension >::ChordLengthListType

Definition at line 68 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef SmartPointer< const Self > itk::NonUniformBSpline< TDimension >::ConstPointer

Reimplemented from itk::Object. Definition at line 58 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef ControlPointListType* itk::NonUniformBSpline< TDimension >::ControlPointListPointer

Definition at line 67 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef std::vector< ControlPointType > itk::NonUniformBSpline< TDimension >::ControlPointListType

Definition at line 66 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef itk::Point<double, TDimension > itk::NonUniformBSpline< TDimension >::ControlPointType

Definition at line 65 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef std::vector<double> itk::NonUniformBSpline< TDimension >::CoordinateListType

Definition at line 64 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef std::vector< double > itk::NonUniformBSpline< TDimension >::KnotListType

Definition at line 63 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef SmartPointer< Self > itk::NonUniformBSpline< TDimension >::Pointer

Reimplemented from itk::Object. Definition at line 57 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef PointListType* itk::NonUniformBSpline< TDimension >::PointListPointer

Definition at line 62 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef std::vector< PointType > itk::NonUniformBSpline< TDimension >::PointListType

Definition at line 61 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef itk::Point< ScalarType, TDimension > itk::NonUniformBSpline< TDimension >::PointType

Definition at line 60 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef double itk::NonUniformBSpline< TDimension >::ScalarType

Definition at line 59 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef NonUniformBSpline itk::NonUniformBSpline< TDimension >::Self

Typedefs Reimplemented from itk::Object. Definition at line 55 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> typedef Object itk::NonUniformBSpline< TDimension >::Superclass

Reimplemented from itk::Object. Definition at line 56 of file itkNonUniformBSpline.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3> itk::NonUniformBSpline< TDimension >::NonUniformBSpline (   )  [protected]

Constructor

template<unsigned int TDimension = 3> virtual itk::NonUniformBSpline< TDimension >::~NonUniformBSpline (   )  [protected, virtual]

Virtual destructor

---

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.

template<unsigned int TDimension = 3> void itk::NonUniformBSpline< TDimension >::ComputeChordLengths (   )

Computes the chord lengths based on the points.

template<unsigned int TDimension = 3> void itk::NonUniformBSpline< TDimension >::ComputeControlPoints (   )

Compute the control points.

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.

template<unsigned int TDimension = 3> PointType itk::NonUniformBSpline< TDimension >::EvaluateSpline (  double  t  )  const

template<unsigned int TDimension = 3> Methods for evaluating the spline The parameterization is always between and* PointType itk::NonUniformBSpline< TDimension >::EvaluateSpline (  const Array< double > &  p  )  const

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.

template<unsigned int TDimension = 3> ControlPointListType& itk::NonUniformBSpline< TDimension >::GetControlPoints (   )  [inline]

Get the control points for the spline Definition at line 126 of file itkNonUniformBSpline.h. References itk::NonUniformBSpline< TDimension >::m_ControlPoints.

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

Get the value of the debug flag.

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

template<unsigned int TDimension = 3> KnotListType& itk::NonUniformBSpline< TDimension >::GetKnots (   )

Get the knot vector.

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<unsigned int TDimension = 3> virtual const char* itk::NonUniformBSpline< TDimension >::GetNameOfClass (   )  const [virtual]

Method for creation through the object factory. Reimplemented from itk::Object.

template<unsigned int TDimension = 3> PointListType& itk::NonUniformBSpline< TDimension >::GetPoints (  void   )  [inline]

Get the points the spline is trying to interpolate. Definition at line 84 of file itkNonUniformBSpline.h. References itk::NonUniformBSpline< TDimension >::m_Points.

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

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

template<unsigned int TDimension = 3> unsigned int itk::NonUniformBSpline< TDimension >::GetSplineOrder (   )  [inline]

Get the order of the spline. Definition at line 152 of file itkNonUniformBSpline.h. References itk::NonUniformBSpline< TDimension >::m_SplineOrder.

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.

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.

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<unsigned int TDimension = 3> static Pointer itk::NonUniformBSpline< TDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<unsigned int TDimension = 3> double itk::NonUniformBSpline< TDimension >::NonUniformBSplineFunctionRecursive (  unsigned int  order, unsigned int  i, double  t )  const

Evaluate the basis functions directly. order - order of the basis function, i.e. 3 = cubic. i - basis function number, zero based. t - parameter of the spline.

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<unsigned int TDimension = 3> virtual void itk::NonUniformBSpline< TDimension >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Method to print the object. Reimplemented from itk::Object.

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.

template<unsigned int TDimension = 3> void itk::NonUniformBSpline< TDimension >::SetControlPoints (  ControlPointListType &  ctrlpts  )

Set the control points for the spline.

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

template<unsigned int TDimension = 3> void itk::NonUniformBSpline< TDimension >::SetKnots (  KnotListType &  newKnots  )

Set the knot vector. Knots may be nonuniformly spaced. Knots will be rescaled to be between 0 and 1.

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

Returns: Set the MetaDataDictionary

template<unsigned int TDimension = 3> void itk::NonUniformBSpline< TDimension >::SetPoints (  PointListType &  newPoints  )

Set points which the spline will attempt to interpolate.

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

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

template<unsigned int TDimension = 3> Set the order of the spline* void itk::NonUniformBSpline< TDimension >::SetSplineOrder (  unsigned int  order  )  [inline]

Definition at line 142 of file itkNonUniformBSpline.h. References itk::NonUniformBSpline< TDimension >::m_SplineOrder, and itk::Object::Modified().

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<unsigned int TDimension = 3> ChordLengthListType itk::NonUniformBSpline< TDimension >::m_ChordLength [protected]

The chord length computed from m_Points. Definition at line 192 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> ControlPointListType itk::NonUniformBSpline< TDimension >::m_ControlPoints [protected]

The control points of the spline. Definition at line 187 of file itkNonUniformBSpline.h. Referenced by itk::NonUniformBSpline< TDimension >::GetControlPoints().

template<unsigned int TDimension = 3> ChordLengthListType itk::NonUniformBSpline< TDimension >::m_CumulativeChordLength [protected]

The cumulative chord length computed from m_Points Definition at line 197 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> KnotListType itk::NonUniformBSpline< TDimension >::m_Knots [protected]

The knots of spline. Definition at line 182 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> PointListType itk::NonUniformBSpline< TDimension >::m_Points [protected]

Points that the spline attempts to intepolate. Definition at line 177 of file itkNonUniformBSpline.h. Referenced by itk::NonUniformBSpline< TDimension >::GetPoints().

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.

template<unsigned int TDimension = 3> unsigned int itk::NonUniformBSpline< TDimension >::m_SpatialDimension [protected]

The spatial dimension. Saved from the template parameter. Definition at line 207 of file itkNonUniformBSpline.h.

template<unsigned int TDimension = 3> unsigned int itk::NonUniformBSpline< TDimension >::m_SplineOrder [protected]

The order of the spline. Definition at line 202 of file itkNonUniformBSpline.h. Referenced by itk::NonUniformBSpline< TDimension >::GetSplineOrder(), and itk::NonUniformBSpline< TDimension >::SetSplineOrder().

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:

• itkNonUniformBSpline.h

---