Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder > Class Template Reference
[Transforms]

#include <itkBSplineDeformableTransform.h>

Inheritance diagram for itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >:

[legend]Collaboration diagram for itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >:

[legend]List of all members.

Detailed Description

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>
class itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >

Deformable transform using a BSpline representation.

This class encapsulates a deformable transform of points from one N-dimensional one space to another N-dimensional space. The deformation field is modeled using B-splines. A deformation is defined on a sparse regular grid of control points $\vec{\lambda}_j$ and is varied by defining a deformation $\vec{g}(\vec{\lambda}_j)$ of each control point. The deformation $D(\vec{x})$ at any point $\vec{x}$ is obtained by using a B-spline interpolation kernel.

The deformation field grid is defined by a user specified GridRegion, GridSpacing and GridOrigin. Each grid/control point has associated with it N deformation coefficients $\vec{\delta}_j$ , representing the N directional components of the deformation. Deformation outside the grid plus support region for the BSpline interpolation is assumed to be zero.

Additionally, the user can specified an addition bulk transform $ B $ such that the transformed point is given by:

$\vec{y} = B(\vec{x}) + D(\vec{x})$

The parameters for this transform is N x N-D grid of spline coefficients. The user specifies the parameters as one flat array: each N-D grid is represented by an array in the same way an N-D image is represented in the buffer; the N arrays are then concatentated together on form a single array.

For efficiency, this transform does not make a copy of the parameters. It only keeps a pointer to the input parameters and assumes that the memory is managed by the caller.

The following illustrates the typical usage of this class:

 * typedef BSplineDeformableTransform<double,2,3> TransformType;
 * TransformType::Pointer transform = TransformType::New();
 *
 * transform->SetGridRegion( region );
 * transform->SetGridSpacing( spacing );
 * transform->SetGridOrigin( origin );
 *
 * // NB: the region must be set first before setting the parameters
 *
 * TransformType::ParametersType parameters( 
 *                                       transform->GetNumberOfParameters() );
 *
 * // Fill the parameters with values
 *
 * transform->SetParameters( parameters )
 *
 * outputPoint = transform->TransformPoint( inputPoint );
 *
 *

An alternative way to set the B-spline coefficients is via array of images. The grid region, spacing and origin information is taken directly from the first image. It is assumed that the subsequent images are the same buffered region. The following illustrates the API:

 *
 * TransformType::ImageConstPointer images[2];
 *
 * // Fill the images up with values
 *
 * transform->SetCoefficientImages( images ); 
 * outputPoint = transform->TransformPoint( inputPoint );
 *
 *

Warning: use either the SetParameters() or SetCoefficientImage() API. Mixing the two modes may results in unexpected results.

The class is templated coordinate representation type (float or double), the space dimension and the spline order.

Definition at line 111 of file itkBSplineDeformableTransform.h.

Public Types

typedef SmartPointer< const
Self > ConstPointer

typedef ImageType::DirectionType DirectionType

typedef ImageType::Pointer ImagePointer

typedef Image< PixelType,
itkGetStaticConstMacro(SpaceDimension)> ImageType

typedef RegionType::IndexType IndexType

typedef Superclass::JacobianType JacobianType

typedef ImageType::PointType OriginType

typedef Array< unsigned long > ParameterIndexArrayType

typedef Superclass::ParametersType ParametersType

typedef ParametersType::ValueType PixelType

typedef SmartPointer< Self > Pointer

typedef ImageRegion< itkGetStaticConstMacro(SpaceDimension)> RegionType

typedef Superclass::ScalarType ScalarType

typedef BSplineDeformableTransform Self

typedef RegionType::SizeType SizeType

typedef ImageType::SpacingType SpacingType

typedef Transform< TScalarType,
NDimensions, NDimensions > Superclass

typedef BulkTransformType::ConstPointer BulkTransformPointer

typedef Transform< ScalarType,
itkGetStaticConstMacro(SpaceDimension),
itkGetStaticConstMacro(SpaceDimension)> BulkTransformType

typedef WeightsFunctionType::ContinuousIndexType ContinuousIndexType

typedef BSplineInterpolationWeightFunction<
ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder)> WeightsFunctionType

typedef WeightsFunctionType::WeightsType WeightsType

typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> InputCovariantVectorType

typedef CovariantVector< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> OutputCovariantVectorType

typedef Point< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> InputPointType

typedef Point< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> OutputPointType

typedef Vector< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> InputVectorType

typedef Vector< TScalarType,
itkGetStaticConstMacro(SpaceDimension)> OutputVectorType

typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(SpaceDimension)> InputVnlVectorType

typedef vnl_vector_fixed<
TScalarType, itkGetStaticConstMacro(SpaceDimension)> OutputVnlVectorType

Public Member Functions

virtual LightObject::Pointer CreateAnother () const

virtual void DebugOff () const

virtual void DebugOn () const

virtual void Delete ()

Command * GetCommand (unsigned long tag)

bool GetDebug () const

virtual const ParametersType & GetFixedParameters (void) const

unsigned int GetInputSpaceDimension (void) const

bool GetInverse (Self *inverseTransform) const

virtual const JacobianType & GetJacobian (const InputPointType &) const

virtual const JacobianType & GetJacobian (const InputPointType &point) const

virtual void GetJacobian (const InputPointType &inputPoint, WeightsType &weights, ParameterIndexArrayType &indices) const

const MetaDataDictionary & GetMetaDataDictionary (void) const

MetaDataDictionary & GetMetaDataDictionary (void)

virtual unsigned long GetMTime () const

virtual const char * GetNameOfClass () const

unsigned int GetNumberOfAffectedWeights () const

virtual unsigned int GetNumberOfParameters (void) const

unsigned int GetNumberOfParametersPerDimension (void) const

unsigned long GetNumberOfWeights () const

unsigned int GetOutputSpaceDimension (void) const

virtual const ParametersType & GetParameters (void) const

virtual int GetReferenceCount () const

virtual std::string GetTransformTypeAsString () const

virtual const RegionType & GetValidRegion ()

bool HasObserver (const EventObject &event) const

void InvokeEvent (const EventObject &) const

void InvokeEvent (const EventObject &)

virtual bool IsLinear () const

itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)

itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)

itkStaticConstMacro (SplineOrder, unsigned int, VSplineOrder)

itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)

virtual void Modified () const

void Print (std::ostream &os, Indent indent=0) const

virtual void Register () const

void RemoveAllObservers ()

void RemoveObserver (unsigned long tag)

virtual void SetCoefficientImage (ImagePointer images[])

void SetDebug (bool debugFlag) const

virtual void SetFixedParameters (const ParametersType &)

void SetIdentity ()

void SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void SetParameters (const ParametersType &)

void SetParameters (const ParametersType &parameters)

virtual void SetParametersByValue (const ParametersType &p)

void SetParametersByValue (const ParametersType &parameters)

virtual void SetReferenceCount (int)

virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const

virtual OutputPointType TransformPoint (const InputPointType &) const

virtual void TransformPoint (const InputPointType &inputPoint, OutputPointType &outputPoint, WeightsType &weights, ParameterIndexArrayType &indices, bool &inside) const

OutputPointType TransformPoint (const InputPointType &point) const

virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const

virtual OutputVectorType TransformVector (const InputVectorType &) const

virtual void UnRegister () const

unsigned long AddObserver (const EventObject &event, Command *) const

unsigned long AddObserver (const EventObject &event, Command *)

virtual const BulkTransformType * GetBulkTransform ()

virtual void SetBulkTransform (const BulkTransformType *_arg)

virtual const ImagePointer * GetCoefficientImage () const

virtual ImagePointer * GetCoefficientImage ()

virtual DirectionType GetGridDirection () const

virtual DirectionType GetGridDirection ()

virtual void SetGridDirection (const DirectionType &spacing)

virtual OriginType GetGridOrigin () const

virtual OriginType GetGridOrigin ()

virtual void SetGridOrigin (const OriginType &origin)

virtual RegionType GetGridRegion () const

virtual RegionType GetGridRegion ()

virtual void SetGridRegion (const RegionType &region)

virtual SpacingType GetGridSpacing () const

virtual SpacingType GetGridSpacing ()

virtual void SetGridSpacing (const SpacingType &spacing)

void SetFixedParameters (const ParametersType &parameters)

virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const

virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &) const

virtual OutputVectorType TransformVector (const InputVectorType &) const

Static Public Member Functions

static void BreakOnError ()

static Pointer New ()

static bool GetGlobalWarningDisplay ()

static void GlobalWarningDisplayOff ()

static void GlobalWarningDisplayOn ()

static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

BSplineDeformableTransform ()

bool PrintObservers (std::ostream &os, Indent indent) const

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

void TransformPointToContinuousIndex (const InputPointType &point, ContinuousIndexType &index) const

void WrapAsImages ()

virtual ~BSplineDeformableTransform ()

virtual WeightsFunctionType * GetWeightsFunction ()

virtual void SetWeightsFunction (WeightsFunctionType *_arg)

virtual void PrintHeader (std::ostream &os, Indent indent) const

virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

ParametersType m_FixedParameters

JacobianType m_Jacobian

ParametersType m_Parameters

InternalReferenceCountType m_ReferenceCount

SimpleFastMutexLock m_ReferenceCountLock

Member Typedef Documentation

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef BulkTransformType::ConstPointer itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::BulkTransformPointer

Definition at line 307 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Transform<ScalarType,itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::BulkTransformType

Typedef of the bulk transform.

Definition at line 301 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef SmartPointer<const Self> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ConstPointer

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 119 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef WeightsFunctionType::ContinuousIndexType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ContinuousIndexType

Definition at line 326 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ImageType::DirectionType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::DirectionType

Definition at line 277 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ImageType::Pointer itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ImagePointer

Definition at line 248 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Image<PixelType,itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ImageType

Definition at line 247 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef RegionType::IndexType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::IndexType

Definition at line 274 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::InputCovariantVectorType

Standard covariant vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 151 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::InputPointType

Standard coordinate point type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 165 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::InputVectorType

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 144 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::InputVnlVectorType

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 158 of file itkBSplineDeformableTransform.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::JacobianType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::JacobianType

Standard Jacobian container.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 140 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ImageType::PointType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::OriginType

Definition at line 278 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef CovariantVector<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::OutputCovariantVectorType

Standard covariant vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 153 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Point<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::OutputPointType

Standard coordinate point type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 167 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Vector<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::OutputVectorType

Standard vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 146 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef vnl_vector_fixed<TScalarType, itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::OutputVnlVectorType

Standard vnl_vector type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 160 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Array<unsigned long> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ParameterIndexArrayType

Parameter index array type.

Definition at line 330 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ParametersType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ParametersType

Standard parameters container.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 137 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ParametersType::ValueType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::PixelType

Parameters as SpaceDimension number of images.

Definition at line 246 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef SmartPointer<Self> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::Pointer

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 118 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ImageRegion<itkGetStaticConstMacro(SpaceDimension)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::RegionType

Typedefs for specifying the extend to the grid.

Definition at line 272 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Superclass::ScalarType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::ScalarType

Standard scalar type for this class.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 134 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef BSplineDeformableTransform itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::Self

Standard class typedefs.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 116 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef RegionType::SizeType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::SizeType

Definition at line 275 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef ImageType::SpacingType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::SpacingType

Definition at line 276 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef Transform< TScalarType, NDimensions, NDimensions > itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::Superclass

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

Definition at line 117 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef BSplineInterpolationWeightFunction<ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder)> itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::WeightsFunctionType

Interpolation weights function type.

Definition at line 323 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

typedef WeightsFunctionType::WeightsType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::WeightsType

Definition at line 324 of file itkBSplineDeformableTransform.h.

Constructor & Destructor Documentation

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::BSplineDeformableTransform ( ) [protected]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::~BSplineDeformableTransform ( ) [protected, virtual]

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

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::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

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.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual const BulkTransformType* itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetBulkTransform ( ) [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual const ImagePointer* itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetCoefficientImage ( ) const [inline, virtual]

Definition at line 253 of file itkBSplineDeformableTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual ImagePointer* itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetCoefficientImage ( ) [inline, virtual]

Get the array of coefficient images.

Definition at line 251 of file itkBSplineDeformableTransform.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.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual const ParametersType& itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetFixedParameters ( void ) const [virtual]

Get the Transformation Fixed Parameters.

Reimplemented from itk::Transform< TScalarType, NDimensions, NDimensions >.

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

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual DirectionType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridDirection ( ) const [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual DirectionType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridDirection ( ) [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual OriginType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridOrigin ( ) const [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual OriginType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridOrigin ( ) [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual RegionType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridRegion ( ) const [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual RegionType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridRegion ( ) [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual SpacingType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridSpacing ( ) const [virtual]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual SpacingType itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetGridSpacing ( ) [virtual]

unsigned int itk::Transform< TScalarType , NInputDimensions, NOutputDimensions >::GetInputSpaceDimension ( void ) const [inline, virtual, inherited]

Get the size of the input space

Implements itk::TransformBase.

Definition at line 87 of file itkTransform.h.

bool itk::Transform< TScalarType , NInputDimensions, NOutputDimensions >::GetInverse ( Self * inverseTransform ) const [inline, inherited]

Returns a boolean indicating whether it is possible or not to compute the inverse of this current Transform. If it is possible, then the inverse of the transform is returned in the inverseTransform variable passed by the user. The inverse is recomputed if this current transform has been modified. This method is intended to be overriden by derived classes.

Reimplemented in itk::ScaleTransform< TScalarType, NDimensions >, and itk::TranslationTransform< TScalarType, NDimensions >.

Definition at line 226 of file itkTransform.h.

virtual const JacobianType& itk::Transform< TScalarType , NInputDimensions, NOutputDimensions >::GetJacobian ( const InputPointType & ) const [inline, virtual, inherited]

Compute the Jacobian of the transformation

This method computes the Jacobian matrix of the transformation at a given input point. The rank of the Jacobian will also indicate if the transform is invertible at this point.

The Jacobian is be expressed as a matrix of partial derivatives of the output point components with respect to the parameters that defined the transform:

$J=\left[ \begin{array}{cccc} \frac{\partial x_{1}}{\partial p_{1}} & \frac{\partial x_{1}}{\partial p_{2}} & \cdots & \frac{\partial x_{1}}{\partial p_{m}}\\ \frac{\partial x_{2}}{\partial p_{1}} & \frac{\partial x_{2}}{\partial p_{2}} & \cdots & \frac{\partial x_{2}}{\partial p_{m}}\\ \vdots & \vdots & \ddots & \vdots \\ \frac{\partial x_{n}}{\partial p_{1}} & \frac{\partial x_{n}}{\partial p_{2}} & \cdots & \frac{\partial x_{n}}{\partial p_{m}} \end{array}\right]$

Definition at line 205 of file itkTransform.h.

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual const JacobianType& itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetJacobian ( const InputPointType & point ) const [virtual]

Compute the Jacobian Matrix of the transformation at one point

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>

virtual void itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >::GetJacobian	(	const InputPointType &	inputPoint,
		WeightsType &	weights,
		ParameterIndexArrayType &	indices
	)			const `[virtual]`

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.


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ImageType::DirectionType	DirectionType
typedef ImageType::Pointer	ImagePointer
typedef Image< PixelType, itkGetStaticConstMacro(SpaceDimension)>	ImageType
typedef RegionType::IndexType	IndexType
typedef Superclass::JacobianType	JacobianType
typedef ImageType::PointType	OriginType
typedef Array< unsigned long >	ParameterIndexArrayType
typedef Superclass::ParametersType	ParametersType
typedef ParametersType::ValueType	PixelType
typedef SmartPointer< Self >	Pointer
typedef ImageRegion< itkGetStaticConstMacro(SpaceDimension)>	RegionType
typedef Superclass::ScalarType	ScalarType
typedef BSplineDeformableTransform	Self
typedef RegionType::SizeType	SizeType
typedef ImageType::SpacingType	SpacingType
typedef Transform< TScalarType, NDimensions, NDimensions >	Superclass

typedef BulkTransformType::ConstPointer	BulkTransformPointer
typedef Transform< ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SpaceDimension)>	BulkTransformType

typedef WeightsFunctionType::ContinuousIndexType	ContinuousIndexType
typedef BSplineInterpolationWeightFunction< ScalarType, itkGetStaticConstMacro(SpaceDimension), itkGetStaticConstMacro(SplineOrder)>	WeightsFunctionType
typedef WeightsFunctionType::WeightsType	WeightsType

typedef CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	InputCovariantVectorType
typedef CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	OutputCovariantVectorType

typedef Point< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	InputPointType
typedef Point< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	OutputPointType

typedef Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	InputVectorType
typedef Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	OutputVectorType

typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	InputVnlVectorType
typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension)>	OutputVnlVectorType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const ParametersType &	GetFixedParameters (void) const
unsigned int	GetInputSpaceDimension (void) const
bool	GetInverse (Self *inverseTransform) const
virtual const JacobianType &	GetJacobian (const InputPointType &) const
virtual const JacobianType &	GetJacobian (const InputPointType &point) const
virtual void	GetJacobian (const InputPointType &inputPoint, WeightsType &weights, ParameterIndexArrayType &indices) const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfAffectedWeights () const
virtual unsigned int	GetNumberOfParameters (void) const
unsigned int	GetNumberOfParametersPerDimension (void) const
unsigned long	GetNumberOfWeights () const
unsigned int	GetOutputSpaceDimension (void) const
virtual const ParametersType &	GetParameters (void) const
virtual int	GetReferenceCount () const
virtual std::string	GetTransformTypeAsString () const
virtual const RegionType &	GetValidRegion ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual bool	IsLinear () const
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)
	itkStaticConstMacro (SplineOrder, unsigned int, VSplineOrder)
	itkStaticConstMacro (SpaceDimension, unsigned int, NDimensions)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetCoefficientImage (ImagePointer images[])
void	SetDebug (bool debugFlag) const
virtual void	SetFixedParameters (const ParametersType &)
void	SetIdentity ()
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetParameters (const ParametersType &)
void	SetParameters (const ParametersType &parameters)
virtual void	SetParametersByValue (const ParametersType &p)
void	SetParametersByValue (const ParametersType &parameters)
virtual void	SetReferenceCount (int)
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
virtual OutputPointType	TransformPoint (const InputPointType &) const
virtual void	TransformPoint (const InputPointType &inputPoint, OutputPointType &outputPoint, WeightsType &weights, ParameterIndexArrayType &indices, bool &inside) const
OutputPointType	TransformPoint (const InputPointType &point) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const
virtual OutputVectorType	TransformVector (const InputVectorType &) const
virtual void	UnRegister () const

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual const BulkTransformType *	GetBulkTransform ()
virtual void	SetBulkTransform (const BulkTransformType *_arg)

virtual const ImagePointer *	GetCoefficientImage () const
virtual ImagePointer *	GetCoefficientImage ()

virtual DirectionType	GetGridDirection () const
virtual DirectionType	GetGridDirection ()
virtual void	SetGridDirection (const DirectionType &spacing)

virtual OriginType	GetGridOrigin () const
virtual OriginType	GetGridOrigin ()
virtual void	SetGridOrigin (const OriginType &origin)

virtual RegionType	GetGridRegion () const
virtual RegionType	GetGridRegion ()
virtual void	SetGridRegion (const RegionType &region)

virtual SpacingType	GetGridSpacing () const
virtual SpacingType	GetGridSpacing ()
virtual void	SetGridSpacing (const SpacingType &spacing)

void	SetFixedParameters (const ParametersType &parameters)

virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const

virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const

virtual OutputVectorType	TransformVector (const InputVectorType &) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
	BSplineDeformableTransform ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
void	TransformPointToContinuousIndex (const InputPointType &point, ContinuousIndexType &index) const
void	WrapAsImages ()
virtual	~BSplineDeformableTransform ()

virtual WeightsFunctionType *	GetWeightsFunction ()
virtual void	SetWeightsFunction (WeightsFunctionType *_arg)

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
ParametersType	m_FixedParameters
JacobianType	m_Jacobian
ParametersType	m_Parameters
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder > Class Template Reference [Transforms]

Detailed Description

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3> class itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder > Class Template Reference
[Transforms]

template<class TScalarType = double, unsigned int NDimensions = 3, unsigned int VSplineOrder = 3>
class itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >