Transform points and vector from an input space to an output space. More...

#include <itkTransform.h>

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

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

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef double	CoordRepType
typedef CovariantVector < TScalarType, NInputDimensions >	InputCovariantVectorType
typedef Point< CoordRepType, NInputDimensions >	InputPointType
typedef Vector< TScalarType, NInputDimensions >	InputVectorType
typedef vnl_vector_fixed < TScalarType, NInputDimensions >	InputVnlVectorType
typedef InverseTransformBaseType::Pointer	InverseTransformBasePointer
typedef TransformBase	InverseTransformBaseType
typedef Array2D< double >	JacobianType
typedef CovariantVector < TScalarType, NOutputDimensions >	OutputCovariantVectorType
typedef Point< CoordRepType, NOutputDimensions >	OutputPointType
typedef Vector< TScalarType, NOutputDimensions >	OutputVectorType
typedef vnl_vector_fixed < TScalarType, NOutputDimensions >	OutputVnlVectorType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::ParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef TScalarType	ScalarType
typedef Transform	Self
typedef TransformBase	Superclass

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) 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 *) const
virtual InverseTransformBasePointer	GetInverseTransform () const
virtual const JacobianType &	GetJacobian (const InputPointType &) const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfParameters (void) const
unsigned int	GetOutputSpaceDimension (void) const
virtual const ParametersType &	GetParameters (void) const
virtual int	GetReferenceCount () const
virtual std::string	GetTransformTypeAsString () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual bool	IsLinear () const
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
virtual void	SetFixedParameters (const ParametersType &)=0
virtual void	SetFixedParameters (const ParametersType &)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetParameters (const ParametersType &)=0
virtual void	SetParameters (const ParametersType &)
virtual void	SetParametersByValue (const ParametersType &p)=0
virtual void	SetParametersByValue (const ParametersType &p)
virtual void	SetReferenceCount (int)
virtual OutputCovariantVectorType	TransformCovariantVector (const InputCovariantVectorType &) const
virtual OutputPointType	TransformPoint (const InputPointType &) const
virtual OutputVectorType	TransformVector (const InputVectorType &) const
virtual OutputVnlVectorType	TransformVector (const InputVnlVectorType &) const
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	InputSpaceDimension = NInputDimensions
static const unsigned int	OutputSpaceDimension = NOutputDimensions

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	Transform ()
	Transform (unsigned int Dimension, unsigned int NumberOfParameters)
virtual	~Transform ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
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

Protected Attributes
ParametersType	m_FixedParameters
JacobianType	m_Jacobian
ParametersType	m_Parameters
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	Transform (const Self &)
void	operator= (const Self &)

Detailed Description

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

Transform points and vector from an input space to an output space.

This abstract class define the generic interface for a geometrical transformation from one space to another. The class provides methods for mapping points, vectors and covariant vectors from the input space to the output space.

Given that transformation are not necesarily invertible, this basic class does not provide the methods for back transfromation. Back transform methods are implemented in derived classes where appropriate.

Registration Framework Support: Typically a Transform class has several methods for setting its parameters. For use in the registration framework, the parameters must also be represented by an array of doubles to allow communication with generic optimizers. The Array of transformation parameters is set using the SetParameters() method.

Another requirement of the registration framework is the computation of the transform Jacobian. In general, a ImageToImageMetric requires the knowledge of the Jacobian in order to compute the metric derivatives. The Jacobian is a matrix whose element are the partial derivatives of the output point with respect to the array of parameters that defines the transform.

Definition at line 66 of file itkTransform.h.

Member Typedef Documentation

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

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

Reimplemented from itk::TransformBase.

Definition at line 73 of file itkTransform.h.

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

typedef double itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::CoordRepType

Definition at line 94 of file itkTransform.h.

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

typedef CovariantVector<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputCovariantVectorType

Standard covariant vector type for this class

Definition at line 108 of file itkTransform.h.

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

typedef Point<CoordRepType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputPointType

Standard coordinate point type for this class

Definition at line 116 of file itkTransform.h.

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

typedef Vector<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputVectorType

Standard vector type for this class.

Definition at line 104 of file itkTransform.h.

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

typedef vnl_vector_fixed<TScalarType, NInputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputVnlVectorType

Standard vnl_vector type for this class.

Definition at line 112 of file itkTransform.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

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

Definition at line 137 of file itkLightObject.h.

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

typedef InverseTransformBaseType::Pointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InverseTransformBasePointer

Definition at line 129 of file itkTransform.h.

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

typedef TransformBase itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InverseTransformBaseType

Base inverse transform type. This type should not be changed to the concrete inverse transform type or inheritance would be lost.

Definition at line 124 of file itkTransform.h.

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

typedef Array2D< double > itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::JacobianType

Type of the Jacobian matrix.

Definition at line 101 of file itkTransform.h.

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

typedef CovariantVector<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputCovariantVectorType

Definition at line 109 of file itkTransform.h.

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

typedef Point<CoordRepType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputPointType

Definition at line 117 of file itkTransform.h.

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

typedef Vector<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputVectorType

Definition at line 105 of file itkTransform.h.

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

typedef vnl_vector_fixed<TScalarType, NOutputDimensions> itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputVnlVectorType

Definition at line 113 of file itkTransform.h.

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

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

Type of the input parameters.

Reimplemented from itk::TransformBase.

Definition at line 97 of file itkTransform.h.

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

typedef Superclass::ParametersValueType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ParametersValueType

Type of the input parameters.

Reimplemented from itk::TransformBase.

Definition at line 98 of file itkTransform.h.

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

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

Reimplemented from itk::TransformBase.

Definition at line 72 of file itkTransform.h.

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

typedef TScalarType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::ScalarType

Type of the scalar representing coordinate and vector elements.

Definition at line 92 of file itkTransform.h.

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

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

Standard class typedefs.

Reimplemented from itk::TransformBase.

Definition at line 70 of file itkTransform.h.

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

typedef TransformBase itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Superclass

Reimplemented from itk::TransformBase.

Definition at line 71 of file itkTransform.h.

Constructor & Destructor Documentation

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

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Transform ( )

protected

Constructor

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 33 of file itkTransform.txx.

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

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Transform	(	unsigned int	dimension,
		unsigned int	numberOfParameters
	)

protected

Constructor

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 48 of file itkTransform.txx.

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

virtual itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::~Transform ( )

inlineprotectedvirtual

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 268 of file itkTransform.h.

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

itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::Transform ( const Self & )

private

Reimplemented in otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

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

virtual::itk::LightObject::Pointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::CreateAnother ( void ) const

virtual

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

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

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

Definition at line 88 of file itkLightObject.cxx.

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.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

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

virtual const ParametersType& itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetFixedParameters ( void ) const

inlinevirtual

Get the Fixed Parameters.

Implements itk::TransformBase.

Definition at line 182 of file itkTransform.h.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

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

unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInputSpaceDimension ( void ) const

inlinevirtual

Get the size of the input space

Implements itk::TransformBase.

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 86 of file itkTransform.h.

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

bool itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInverse ( Self * ) const

inline

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::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::Rigid2DTransform< TScalarType >, itk::Similarity2DTransform< TScalarType >, itk::ScaleTransform< TScalarType, NDimensions >, itk::Rigid3DTransform< TScalarType >, and itk::TranslationTransform< TScalarType, NDimensions >.

Definition at line 237 of file itkTransform.h.

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

virtual InverseTransformBasePointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetInverseTransform ( ) const

inlinevirtual

Return an inverse of this transform. If the inverse has not been implemented, return NULL. The type of the inverse transform does not necessarily need to match the type of the forward transform. This allows one to return a numeric inverse transform instead.

Definition at line 245 of file itkTransform.h.

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

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

inlinevirtual

 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]$

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< TScalarType, Dimension, Dimension >, and itk::KernelTransform< TScalarType, NDimensions >.

Definition at line 217 of file itkTransform.h.

Referenced by itk::MattesMutualInformationImageToImageMetric< TFixedImage, TMovingImage >::ComputePDFDerivatives(), and itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadProcessSample().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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

virtual const char* itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::TransformBase.

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

virtual unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetNumberOfParameters ( void ) const

inlinevirtual

Return the number of parameters that completely define the Transfom

Implements itk::TransformBase.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< TScalarType, Dimension, Dimension >, itk::TranslationTransform< TScalarType, NDimensions >, and otb::RationalTransform< TScalarType, Dimension >.

Definition at line 227 of file itkTransform.h.

Referenced by itk::HistogramImageToImageMetric< TFixedImage, TMovingImage >::SetTransform().

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

unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetOutputSpaceDimension ( void ) const

inlinevirtual

Get the size of the output space

Implements itk::TransformBase.

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 89 of file itkTransform.h.

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

virtual const ParametersType& itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetParameters ( void ) const

inlinevirtual

Get the Transformation Parameters.

Implements itk::TransformBase.

Definition at line 169 of file itkTransform.h.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

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

std::string itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::GetTransformTypeAsString ( ) const

virtual

Generate a platform independant name

GenerateName

Implements itk::TransformBase.

Definition at line 63 of file itkTransform.txx.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

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.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

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

Definition at line 457 of file itkObject.cxx.

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

virtual bool itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::IsLinear ( ) const

inlinevirtual

Indicates if this transform is linear. A transform is defined to be linear if the transform of a linear combination of points is equal to the linear combination (with the same coefficients) of the individual transforms of each point. The transform T will be linear if given two points P and Q, and scalar coefficients a and b, then

      T( a*P + b*Q ) = a * T(P) + b * T(Q)

By default, we assume this to NOT be the case for most transforms. However, transforms for which this is true will overload and reimplement this method accordingly.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::IdentityTransform< TScalarType, NDimensions >, itk::ScaleTransform< TScalarType, NDimensions >, itk::KernelTransform< TScalarType, NDimensions >, and itk::TranslationTransform< TScalarType, NDimensions >.

Definition at line 263 of file itkTransform.h.

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

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

static Pointer itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::New ( )

static

New method for creating an object using a factory.

Reimplemented from itk::Object.

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

void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::operator= ( const Self & )

private

Reimplemented from itk::TransformBase.

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::Rigid2DTransform< TScalarType >, itk::Similarity2DTransform< TScalarType >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< TScalarType, Dimension, Dimension >, itk::Rigid3DTransform< TScalarType >, itk::ScaleTransform< TScalarType, NDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, itk::Rigid3DPerspectiveTransform< TScalarType >, itk::VersorTransform< TScalarType >, itk::ScaleSkewVersor3DTransform< TScalarType >, itk::QuaternionRigidTransform< TScalarType >, itk::ScaleVersor3DTransform< TScalarType >, itk::Similarity3DTransform< TScalarType >, itk::VersorRigid3DTransform< TScalarType >, and itk::ScaleLogarithmicTransform< TScalarType, NDimensions >.

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

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

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

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

protectedinherited

Definition at line 478 of file itkObject.cxx.

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

protectedvirtualinherited

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::LightObject.

Definition at line 517 of file itkObject.cxx.

References itk::Indent::GetNextIndent().

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

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

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

Definition at line 275 of file itkObject.cxx.

virtual void itk::TransformBase::SetFixedParameters ( const ParametersType & )

pure virtualinherited

Set the fixed parameters.

Implemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, 2, 2 >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< double, NInputDimensions, NOutputDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, and otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >.

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

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetFixedParameters ( const ParametersType & )

inlinevirtual

Set the fixed parameters and update internal transformation.

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::TranslationTransform< TScalarType, NDimensions >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 178 of file itkTransform.h.

Referenced by itk::ImageToImageMetric< TFixedImage, TMovingImage >::MultiThreadingInitialize().

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

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

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

virtual void itk::TransformBase::SetParameters ( const ParametersType & )

pure virtualinherited

Set the transformation parameters and update internal transformation.

Implemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, 2, 2 >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< double, NInputDimensions, NOutputDimensions >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and itk::TranslationTransform< TScalarType, NDimensions >.

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

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetParameters ( const ParametersType & )

inlinevirtual

Set the transformation parameters and update internal transformation. SetParameters gives the transform the option to set it's parameters by keeping a reference to the parameters, or by copying. To force the transform to copy it's parameters call SetParametersByValue.

See also:: SetParametersByValue

Reimplemented in itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, Dimension, Dimension >, and itk::TranslationTransform< TScalarType, NDimensions >.

Definition at line 155 of file itkTransform.h.

Referenced by itk::ImageToImageMetric< TFixedImage, TMovingImage >::MultiThreadingInitialize().

virtual void itk::TransformBase::SetParametersByValue ( const ParametersType & p )

pure virtualinherited

Set the transformation by copying parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See also:: SetParameters

Implemented in itk::Transform< TScalarType, NDimensions, NDimensions >, itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >, itk::Transform< TScalarType, 2, 2 >, itk::Transform< TScalarType, 3, 2 >, itk::Transform< double, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >.

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

virtual void itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::SetParametersByValue ( const ParametersType & p )

inlinevirtual

Set the transformation parameters and update internal transformation. This method forces the transform to copy the parameters. The default implementation is to call SetParameters. This call must be overridden if the transform normally implements SetParameters by keeping a reference to the parameters.

See also:: SetParameters

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 165 of file itkTransform.h.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

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

virtual OutputCovariantVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformCovariantVector ( const InputCovariantVectorType & ) const

inlinevirtual

Method to transform a CovariantVector.

Reimplemented in itk::BSplineDeformableTransform< TScalarType, NDimensions, VSplineOrder >, itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >, itk::MatrixOffsetTransformBase< TScalarType, NDimensions, NDimensions >, itk::MatrixOffsetTransformBase< TScalarType, 2, 2 >, itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >, itk::ScaleTransform< TScalarType, NDimensions >, itk::IdentityTransform< TScalarType, NDimensions >, itk::TranslationTransform< TScalarType, NDimensions >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 144 of file itkTransform.h.

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

virtual OutputPointType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformPoint ( const InputPointType & ) const

inlinevirtual

Method to transform a point.

Definition at line 132 of file itkTransform.h.

Referenced by itk::MeanReciprocalSquareDifferenceImageToImageMetric< TFixedImage, TMovingImage >::GetValue(), itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPoint(), and itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPointWithDerivatives().

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

virtual OutputVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformVector ( const InputVectorType & ) const

inlinevirtual

Method to transform a vector.

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< TScalarType, Dimension, Dimension >, otb::LogPolarTransform< TScalarType >, and otb::InverseLogPolarTransform< TScalarType >.

Definition at line 136 of file itkTransform.h.

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

virtual OutputVnlVectorType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::TransformVector ( const InputVnlVectorType & ) const

inlinevirtual

Method to transform a vnl_vector.

Reimplemented in otb::LogPolarTransform< TScalarType >, otb::InverseLogPolarTransform< TScalarType >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 140 of file itkTransform.h.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

Member Data Documentation

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

const unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::InputSpaceDimension = NInputDimensions

static

Dimension of the domain space.

Definition at line 82 of file itkTransform.h.

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

ParametersType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_FixedParameters

mutableprotected

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 272 of file itkTransform.h.

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

JacobianType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_Jacobian

mutableprotected

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 273 of file itkTransform.h.

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

ParametersType itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::m_Parameters

mutableprotected

Reimplemented in otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, otb::Transform< double, 2, 2 >, otb::Transform< TScalarType, NInputDimensions, NOutputDimensions >, and otb::Transform< TScalarType, Dimension, Dimension >.

Definition at line 271 of file itkTransform.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

const unsigned int itk::Transform< TScalarType, NInputDimensions, NOutputDimensions >::OutputSpaceDimension = NOutputDimensions

static

Definition at line 83 of file itkTransform.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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