itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions > Class Template Reference

#include <itkStackTransform.h>

Inheritance diagram for itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >:

Collaboration diagram for itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputPointType	InputPointType
typedef Superclass::JacobianType	JacobianType
typedef Superclass::NonZeroJacobianIndicesType	NonZeroJacobianIndicesType
typedef Superclass::OutputPointType	OutputPointType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef Superclass::ScalarType	ScalarType
typedef StackTransform	Self
typedef std::vector < SubTransformPointer >	SubTransformContainerType
typedef SubTransformType::InputPointType	SubTransformInputPointType
typedef SubTransformType::JacobianType	SubTransformJacobianType
typedef SubTransformType::OutputPointType	SubTransformOutputPointType
typedef SubTransformType::Pointer	SubTransformPointer
typedef AdvancedTransform < TScalarType, itkGetStaticConstMacro(ReducedInputSpaceDimension), itkGetStaticConstMacro(ReducedOutputSpaceDimension) >	SubTransformType
typedef AdvancedTransform < TScalarType, NInputDimensions, NOutputDimensions >	Superclass
Public Member Functions
virtual const char *	GetClassName () const
virtual void	GetJacobian (const InputPointType &ipp, JacobianType &jac, NonZeroJacobianIndicesType &nzji) const
virtual const JacobianType &	GetJacobian (const InputPointType &ipp) const
virtual unsigned long	GetNumberOfNonZeroJacobianIndices (void) const
virtual unsigned int	GetNumberOfParameters (void) const
virtual unsigned int	GetNumberOfSubTransforms ()
virtual const ParametersType &	GetParameters (void) const
virtual TScalarType	GetStackOrigin () const
virtual TScalarType	GetStackSpacing () const
virtual SubTransformPointer	GetSubTransform (unsigned int i)
	itkStaticConstMacro (InputSpaceDimension, unsigned int, NInputDimensions)
	itkStaticConstMacro (OutputSpaceDimension, unsigned int, NOutputDimensions)
	itkStaticConstMacro (ReducedInputSpaceDimension, unsigned int, NInputDimensions-1)
	itkStaticConstMacro (ReducedOutputSpaceDimension, unsigned int, NOutputDimensions-1)
virtual void	SetAllSubTransforms (SubTransformType *transform)
virtual void	SetNumberOfSubTransforms (const unsigned int num)
virtual void	SetParameters (const ParametersType &param)
virtual void	SetStackOrigin (TScalarType _arg)
virtual void	SetStackSpacing (TScalarType _arg)
virtual void	SetSubTransform (unsigned int i, SubTransformType *transform)
virtual OutputPointType	TransformPoint (const InputPointType &ipp) const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	StackTransform ()
virtual	~StackTransform ()
Private Member Functions
void	operator= (const Self &)
	StackTransform (const Self &)
Private Attributes
unsigned int	m_NumberOfSubTransforms
TScalarType	m_StackOrigin
TScalarType	m_StackSpacing
SubTransformContainerType	m_SubTransformContainer

---

Detailed Description

template<class TScalarType, unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>
class itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >

Implements stack of transforms: one for every last dimension index.

A list of transforms with dimension of Dimension - 1 is maintained: one for every last dimension index. This transform selects the right transform based on the last dimension index of the input point.

Definition at line 37 of file itkStackTransform.h.

---

Member Typedef Documentation

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SmartPointer< const Self > itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::ConstPointer

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 47 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::InputPointType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::InputPointType

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 65 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::JacobianType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::JacobianType

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 64 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::NonZeroJacobianIndicesType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::NonZeroJacobianIndicesType

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 68 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::OutputPointType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::OutputPointType

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 66 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::ParametersType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::ParametersType

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 63 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SmartPointer< Self > itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::Pointer

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 46 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef Superclass::ScalarType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::ScalarType

Typedefs from the Superclass.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 62 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef StackTransform itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::Self

Standard class typedefs.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 42 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef std::vector< SubTransformPointer > itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformContainerType

Definition at line 75 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SubTransformType::InputPointType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformInputPointType

Dimension - 1 point types.

Definition at line 79 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SubTransformType::JacobianType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformJacobianType

Definition at line 76 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SubTransformType::OutputPointType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformOutputPointType

Definition at line 80 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef SubTransformType::Pointer itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformPointer

Definition at line 74 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef AdvancedTransform< TScalarType, itkGetStaticConstMacro( ReducedInputSpaceDimension ), itkGetStaticConstMacro( ReducedOutputSpaceDimension ) > itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SubTransformType

Sub transform types, having a reduced dimension.

Definition at line 73 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

typedef AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions > itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::Superclass

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

Definition at line 45 of file itkStackTransform.h.

---

Constructor & Destructor Documentation

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::StackTransform

(

)

[protected]

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::~StackTransform

(

)

[inline, protected, virtual]

Definition at line 169 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::StackTransform

(

const Self &

)

[private]

---

Member Function Documentation

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const char* itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetClassName

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetJacobian	(	const InputPointType &	ipp,
		JacobianType &	jac,
		NonZeroJacobianIndicesType &	nzji
	)		const [virtual]

This returns a sparse version of the Jacobian of the transformation. In this class however, the Jacobian is not sparse. However, it is a useful function, since the Jacobian is passed by reference, which makes it threadsafe, unlike the normal GetJacobian function.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const JacobianType& itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetJacobian

(

const InputPointType &

ipp

)

const [virtual]

The GetJacobian from the superclass.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual unsigned long itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetNumberOfNonZeroJacobianIndices

(

void

)

const [virtual]

Get number of nonzero Jacobian indices.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual unsigned int itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetNumberOfParameters

(

void

)

const [inline, virtual]

Return the number of sub transforms that have been set.

Definition at line 107 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual unsigned int itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetNumberOfSubTransforms

(

)

[virtual]

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual const ParametersType& itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetParameters

(

void

)

const [virtual]

Get the parameters. Concatenates the parameters of the sub transforms.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual TScalarType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetStackOrigin

(

)

const [virtual]

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual TScalarType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetStackSpacing

(

)

const [virtual]

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual SubTransformPointer itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::GetSubTransform

(

unsigned int

i

)

[inline, virtual]

Get a sub transform.

Definition at line 159 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::itkStaticConstMacro	(	InputSpaceDimension	,
		unsigned	int,
		NInputDimensions
	)

(Reduced) dimension of the domain space.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::itkStaticConstMacro	(	OutputSpaceDimension	,
		unsigned	int,
		NOutputDimensions
	)

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::itkStaticConstMacro	(	ReducedInputSpaceDimension	,
		unsigned	int,
		NInputDimensions-	1
	)

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::itkStaticConstMacro	(	ReducedOutputSpaceDimension	,
		unsigned	int,
		NOutputDimensions-	1
	)

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

static Pointer itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::New

(

)

[static]

New method for creating an object using a factory.

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::operator=

(

const Self &

)

[private]

Reimplemented from itk::AdvancedTransform< TScalarType, NInputDimensions, NOutputDimensions >.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetAllSubTransforms

(

SubTransformType *

transform

)

[inline, virtual]

Set all sub transforms to transform.

Definition at line 146 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetNumberOfSubTransforms

(

const unsigned int

num

)

[inline, virtual]

Set/get number of transforms needed.

Definition at line 120 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetParameters

(

const ParametersType &

param

)

[virtual]

Set the parameters. Checks if the number of parameters is correct and sets parameters of sub transforms.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetStackOrigin

(

TScalarType

_arg

)

[virtual]

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetStackSpacing

(

TScalarType

_arg

)

[virtual]

Set/get stack transform parameters.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual void itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::SetSubTransform	(	unsigned int	i,
		SubTransformType *	transform
	)		[inline, virtual]

Set the initial transform for sub transform i.

Definition at line 139 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

virtual OutputPointType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::TransformPoint

(

const InputPointType &

ipp

)

const [virtual]

Method to transform a point.

---

Field Documentation

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

unsigned int itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::m_NumberOfSubTransforms [private]

Definition at line 177 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

TScalarType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::m_StackOrigin [private]

Definition at line 181 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

TScalarType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::m_StackSpacing [private]

Definition at line 181 of file itkStackTransform.h.

template<class TScalarType , unsigned int NInputDimensions = 3, unsigned int NOutputDimensions = 3>

SubTransformContainerType itk::StackTransform< TScalarType, NInputDimensions, NOutputDimensions >::m_SubTransformContainer [private]

Definition at line 178 of file itkStackTransform.h.