IGSTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
igstk::AffineTransform Class Reference

A class representing a 3D affine transform. More...

#include <igstkAffineTransform.h>

Inheritance diagram for igstk::AffineTransform:
Inheritance graph
[legend]
Collaboration diagram for igstk::AffineTransform:
Collaboration graph
[legend]

Public Types

typedef ::itk::AffineTransform
< double, 3 >::MatrixType 
MatrixType
typedef ::itk::AffineTransform
< double, 3 >
::OutputVectorType 
OffsetType
- Public Types inherited from igstk::TransformBase
typedef double ErrorType
typedef TimeStamp::TimePeriodType TimePeriodType

Public Member Functions

 AffineTransform ()
 Default constructor, results in identity transform with a time stamp that is never valid (start==end==0).
 AffineTransform (const AffineTransform &t)
virtual ~AffineTransform ()
const AffineTransformoperator= (const AffineTransform &inputTransform)
 Assign the values of one transform to another.
void SetMatrixAndOffset (const MatrixType &matrix, const OffsetType &offset, ErrorType errorValue, TimeStamp::TimePeriodType millisecondsToExpiration)
 Set affine transformation.
void ExportTransform (vtkMatrix4x4 &matrix) const
 Export the content of the transformation in the format of a vtkMatrix4x4.
void Print (std::ostream &os, itk::Indent indent) const
 Method for printing the member variables of this class to an ostream.
- Public Member Functions inherited from igstk::TransformBase
 TransformBase ()
 Constructor and destructor.
 TransformBase (const TransformBase &t)
virtual ~TransformBase ()
virtual ErrorType GetError ()
 Returns the estimation error associated with this transform.
TimePeriodType GetStartTime () const
 Returns the time at which the validity of this transformation starts.
TimePeriodType GetExpirationTime () const
 Returns the time at which the validity of this transformation expires.
bool IsValidAtTime (TimePeriodType timeToTestInMilliseconds) const
 Returns the validity status of the transform at the time passed as argument.
bool IsValidNow () const
 Returns the validity status of the transform when it is called.

Static Public Member Functions

static AffineTransform TransformCompose (AffineTransform &leftTransform, AffineTransform &rightTransform)
 Transform composition method.

Protected Member Functions

void PrintHeader (std::ostream &os, itk::Indent indent) const
void PrintTrailer (std::ostream &itkNotUsed(os), itk::Indent itkNotUsed(indent)) const
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.

Additional Inherited Members

- Protected Attributes inherited from igstk::TransformBase
TimeStamp m_TimeStamp
ErrorType m_Error

Detailed Description

A class representing a 3D affine transform.

This class represents an affine transform of points in 3D space.

All the set methods require an argument that defines the number of milliseconds for which the stored information is considered to be valid. The validity period will be counted from the moment the Set method was invoked.

See Also
TransformBase

Definition at line 43 of file igstkAffineTransform.h.

Member Typedef Documentation

typedef ::itk::AffineTransform<double, 3>::MatrixType igstk::AffineTransform::MatrixType

Definition at line 48 of file igstkAffineTransform.h.

typedef ::itk::AffineTransform<double, 3>::OutputVectorType igstk::AffineTransform::OffsetType

Definition at line 49 of file igstkAffineTransform.h.

Constructor & Destructor Documentation

igstk::AffineTransform::AffineTransform ( )

Default constructor, results in identity transform with a time stamp that is never valid (start==end==0).

igstk::AffineTransform::AffineTransform ( const AffineTransform t)
virtual igstk::AffineTransform::~AffineTransform ( )
virtual

Member Function Documentation

static AffineTransform igstk::AffineTransform::TransformCompose ( AffineTransform leftTransform,
AffineTransform rightTransform 
)
static

Transform composition method.

const AffineTransform& igstk::AffineTransform::operator= ( const AffineTransform inputTransform)

Assign the values of one transform to another.

void igstk::AffineTransform::SetMatrixAndOffset ( const MatrixType matrix,
const OffsetType offset,
ErrorType  errorValue,
TimeStamp::TimePeriodType  millisecondsToExpiration 
)

Set affine transformation.

This transformation will override any previously set values. The information will be considered valid from the time of invocation of the method until that time plus the millisecondsToExpiration value.

void igstk::AffineTransform::ExportTransform ( vtkMatrix4x4 &  matrix) const

Export the content of the transformation in the format of a vtkMatrix4x4.

Users must allocate the matrix first and then pass it by reference to this method. The current method will simply fill in the transform using the current information of translation and rotation.

void igstk::AffineTransform::Print ( std::ostream &  os,
itk::Indent  indent 
) const
virtual

Method for printing the member variables of this class to an ostream.

Implements igstk::TransformBase.

void igstk::AffineTransform::PrintHeader ( std::ostream &  os,
itk::Indent  indent 
) const
protected
void igstk::AffineTransform::PrintTrailer ( std::ostream &  itkNotUsedos,
itk::Indent   itkNotUsedindent 
) const
protected
virtual void igstk::AffineTransform::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.


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